aws-sdk-batch 1.61.0 → 1.63.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-batch/client.rb +311 -66
- data/lib/aws-sdk-batch/client_api.rb +178 -0
- data/lib/aws-sdk-batch/types.rb +2206 -623
- data/lib/aws-sdk-batch.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-batch/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,19 +645,23 @@ 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
|
-
# instances in the Amazon EC2 console.
|
631
|
-
#
|
632
|
-
#
|
633
|
-
#
|
634
|
-
#
|
651
|
+
# instances in the Amazon EC2 console. Updating these tags requires an
|
652
|
+
# infrastructure update to the compute environment. For more
|
653
|
+
# information, see [Updating compute environments][1] in the *Batch
|
654
|
+
# User Guide*. These tags aren't seen when using the Batch
|
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>
|
661
|
+
#
|
662
|
+
#
|
663
|
+
#
|
664
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html
|
640
665
|
# @return [Hash<String,String>]
|
641
666
|
#
|
642
667
|
# @!attribute [rw] placement_group
|
@@ -650,7 +675,7 @@ module Aws::Batch
|
|
650
675
|
# *Amazon EC2 User Guide for Linux Instances*.
|
651
676
|
#
|
652
677
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
653
|
-
# resources
|
678
|
+
# resources. Don't specify it.
|
654
679
|
#
|
655
680
|
# </note>
|
656
681
|
#
|
@@ -670,7 +695,7 @@ module Aws::Batch
|
|
670
695
|
# On-Demand price.
|
671
696
|
#
|
672
697
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
673
|
-
# resources
|
698
|
+
# resources. Don't specify it.
|
674
699
|
#
|
675
700
|
# </note>
|
676
701
|
# @return [Integer]
|
@@ -683,7 +708,7 @@ module Aws::Batch
|
|
683
708
|
# spot fleet role][1] in the *Batch User Guide*.
|
684
709
|
#
|
685
710
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
686
|
-
# resources
|
711
|
+
# resources. Don't specify it.
|
687
712
|
#
|
688
713
|
# </note>
|
689
714
|
#
|
@@ -710,7 +735,7 @@ module Aws::Batch
|
|
710
735
|
# Guide*.
|
711
736
|
#
|
712
737
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
713
|
-
# resources
|
738
|
+
# resources. Don't specify it.
|
714
739
|
#
|
715
740
|
# </note>
|
716
741
|
#
|
@@ -720,14 +745,14 @@ module Aws::Batch
|
|
720
745
|
# @return [Types::LaunchTemplateSpecification]
|
721
746
|
#
|
722
747
|
# @!attribute [rw] ec2_configuration
|
723
|
-
# Provides information used to select Amazon Machine Images
|
724
|
-
# EC2 instances in the compute environment. If
|
725
|
-
# 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`.
|
726
751
|
#
|
727
752
|
# One or two values can be provided.
|
728
753
|
#
|
729
754
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
730
|
-
# resources
|
755
|
+
# resources. Don't specify it.
|
731
756
|
#
|
732
757
|
# </note>
|
733
758
|
# @return [Array<Types::Ec2Configuration>]
|
@@ -756,7 +781,7 @@ module Aws::Batch
|
|
756
781
|
include Aws::Structure
|
757
782
|
end
|
758
783
|
|
759
|
-
# An object
|
784
|
+
# An object that represents the attributes of a compute environment that
|
760
785
|
# can be updated. For more information, see [Updating compute
|
761
786
|
# environments][1] in the *Batch User Guide*.
|
762
787
|
#
|
@@ -791,6 +816,7 @@ module Aws::Batch
|
|
791
816
|
# {
|
792
817
|
# image_type: "ImageType", # required
|
793
818
|
# image_id_override: "ImageIdOverride",
|
819
|
+
# image_kubernetes_version: "KubernetesVersion",
|
794
820
|
# },
|
795
821
|
# ],
|
796
822
|
# update_to_latest_image_version: false,
|
@@ -803,7 +829,7 @@ module Aws::Batch
|
|
803
829
|
# maintain (even if the compute environment is `DISABLED`).
|
804
830
|
#
|
805
831
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
806
|
-
# resources
|
832
|
+
# resources. Don't specify it.
|
807
833
|
#
|
808
834
|
# </note>
|
809
835
|
# @return [Integer]
|
@@ -813,11 +839,12 @@ module Aws::Batch
|
|
813
839
|
# reach.
|
814
840
|
#
|
815
841
|
# <note markdown="1"> With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
|
816
|
-
# allocation strategies
|
817
|
-
#
|
818
|
-
# `maxvCpus`
|
819
|
-
#
|
820
|
-
#
|
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.
|
821
848
|
#
|
822
849
|
# </note>
|
823
850
|
# @return [Integer]
|
@@ -828,7 +855,7 @@ module Aws::Batch
|
|
828
855
|
# based on job queue demand.
|
829
856
|
#
|
830
857
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
831
|
-
# resources
|
858
|
+
# resources. Don't specify it.
|
832
859
|
#
|
833
860
|
# </note>
|
834
861
|
# @return [Integer]
|
@@ -854,13 +881,13 @@ module Aws::Batch
|
|
854
881
|
# @return [Array<String>]
|
855
882
|
#
|
856
883
|
# @!attribute [rw] security_group_ids
|
857
|
-
# The Amazon EC2 security groups associated with instances
|
858
|
-
# the compute environment. This parameter is required for
|
859
|
-
# compute resources, where it can contain up to 5 security
|
860
|
-
# Fargate compute resources, providing an empty list is
|
861
|
-
# this parameter wasn't specified and no change is
|
862
|
-
# compute resources, providing an empty list removes the
|
863
|
-
# 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.
|
864
891
|
#
|
865
892
|
# When updating a compute environment, changing the EC2 security
|
866
893
|
# groups requires an infrastructure update of the compute environment.
|
@@ -873,11 +900,12 @@ module Aws::Batch
|
|
873
900
|
# @return [Array<String>]
|
874
901
|
#
|
875
902
|
# @!attribute [rw] allocation_strategy
|
876
|
-
# The allocation strategy to use for the compute resource if
|
877
|
-
# enough instances of the best fitting instance type can be
|
878
|
-
# This might be because of availability of the instance
|
879
|
-
# Region or [Amazon EC2 service limits][1]. For more
|
880
|
-
# [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*.
|
881
909
|
#
|
882
910
|
# When updating a compute environment, changing the allocation
|
883
911
|
# strategy requires an infrastructure update of the compute
|
@@ -886,30 +914,31 @@ module Aws::Batch
|
|
886
914
|
# supported when updating a compute environment.
|
887
915
|
#
|
888
916
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
889
|
-
# resources
|
917
|
+
# resources. Don't specify it.
|
890
918
|
#
|
891
919
|
# </note>
|
892
920
|
#
|
893
921
|
# BEST\_FIT\_PROGRESSIVE
|
894
922
|
#
|
895
|
-
# : Batch
|
896
|
-
#
|
897
|
-
#
|
898
|
-
#
|
899
|
-
#
|
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.
|
900
928
|
#
|
901
929
|
# SPOT\_CAPACITY\_OPTIMIZED
|
902
930
|
#
|
903
|
-
# : Batch
|
904
|
-
#
|
905
|
-
#
|
906
|
-
#
|
907
|
-
#
|
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.
|
908
936
|
#
|
909
937
|
# With both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED`
|
910
|
-
# strategies
|
911
|
-
#
|
912
|
-
#
|
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.
|
913
942
|
#
|
914
943
|
#
|
915
944
|
#
|
@@ -932,7 +961,7 @@ module Aws::Batch
|
|
932
961
|
# User Guide*.
|
933
962
|
#
|
934
963
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
935
|
-
# resources
|
964
|
+
# resources. Don't specify it.
|
936
965
|
#
|
937
966
|
# </note>
|
938
967
|
#
|
@@ -945,7 +974,7 @@ module Aws::Batch
|
|
945
974
|
#
|
946
975
|
# <note markdown="1"> Currently, `optimal` uses instance types from the C4, M4, and R4
|
947
976
|
# instance families. In Regions that don't have instance types from
|
948
|
-
# those instance families, instance types from the C5, M5
|
977
|
+
# those instance families, instance types from the C5, M5, and R5
|
949
978
|
# instance families are used.
|
950
979
|
#
|
951
980
|
# </note>
|
@@ -967,7 +996,7 @@ module Aws::Batch
|
|
967
996
|
# *Batch User Guide*.
|
968
997
|
#
|
969
998
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
970
|
-
# resources
|
999
|
+
# resources. Don't specify it.
|
971
1000
|
#
|
972
1001
|
# </note>
|
973
1002
|
#
|
@@ -991,7 +1020,7 @@ module Aws::Batch
|
|
991
1020
|
# User Guide*.
|
992
1021
|
#
|
993
1022
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
994
|
-
# resources
|
1023
|
+
# resources. Don't specify it.
|
995
1024
|
#
|
996
1025
|
# </note>
|
997
1026
|
#
|
@@ -1004,8 +1033,8 @@ module Aws::Batch
|
|
1004
1033
|
# @!attribute [rw] tags
|
1005
1034
|
# Key-value pair tags to be applied to EC2 resources that are launched
|
1006
1035
|
# in the compute environment. For Batch, these take the form of
|
1007
|
-
# "String1": "String2"
|
1008
|
-
# 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 -
|
1009
1038
|
# C4OnDemand" \}`. This is helpful for recognizing your Batch
|
1010
1039
|
# instances in the Amazon EC2 console. These tags aren't seen when
|
1011
1040
|
# using the Batch `ListTagsForResource` API operation.
|
@@ -1016,7 +1045,7 @@ module Aws::Batch
|
|
1016
1045
|
# User Guide*.
|
1017
1046
|
#
|
1018
1047
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1019
|
-
# resources
|
1048
|
+
# resources. Don't specify it.
|
1020
1049
|
#
|
1021
1050
|
# </note>
|
1022
1051
|
#
|
@@ -1041,7 +1070,7 @@ module Aws::Batch
|
|
1041
1070
|
# *Batch User Guide*.
|
1042
1071
|
#
|
1043
1072
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1044
|
-
# resources
|
1073
|
+
# resources. Don't specify it.
|
1045
1074
|
#
|
1046
1075
|
# </note>
|
1047
1076
|
#
|
@@ -1055,9 +1084,9 @@ module Aws::Batch
|
|
1055
1084
|
# The maximum percentage that a Spot Instance price can be when
|
1056
1085
|
# compared with the On-Demand price for that instance type before
|
1057
1086
|
# instances are launched. For example, if your maximum percentage is
|
1058
|
-
# 20%,
|
1059
|
-
#
|
1060
|
-
#
|
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.
|
1061
1090
|
#
|
1062
1091
|
# When updating a compute environment, changing the bid percentage
|
1063
1092
|
# requires an infrastructure update of the compute environment. For
|
@@ -1065,7 +1094,7 @@ module Aws::Batch
|
|
1065
1094
|
# *Batch User Guide*.
|
1066
1095
|
#
|
1067
1096
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1068
|
-
# resources
|
1097
|
+
# resources. Don't specify it.
|
1069
1098
|
#
|
1070
1099
|
# </note>
|
1071
1100
|
#
|
@@ -1093,7 +1122,7 @@ module Aws::Batch
|
|
1093
1122
|
# *Batch User Guide*.
|
1094
1123
|
#
|
1095
1124
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1096
|
-
# resources
|
1125
|
+
# resources. Don't specify it.
|
1097
1126
|
#
|
1098
1127
|
# </note>
|
1099
1128
|
#
|
@@ -1117,7 +1146,7 @@ module Aws::Batch
|
|
1117
1146
|
# One or two values can be provided.
|
1118
1147
|
#
|
1119
1148
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1120
|
-
# resources
|
1149
|
+
# resources. Don't specify it.
|
1121
1150
|
#
|
1122
1151
|
# </note>
|
1123
1152
|
#
|
@@ -1131,11 +1160,12 @@ module Aws::Batch
|
|
1131
1160
|
# supported by Batch when the compute environment has an
|
1132
1161
|
# infrastructure update. The default value is `false`.
|
1133
1162
|
#
|
1134
|
-
# <note markdown="1">
|
1135
|
-
# parameters or by the launch template
|
1136
|
-
# `launchTemplate` parameter
|
1137
|
-
#
|
1138
|
-
#
|
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*.
|
1139
1169
|
#
|
1140
1170
|
# </note>
|
1141
1171
|
#
|
@@ -1184,7 +1214,7 @@ module Aws::Batch
|
|
1184
1214
|
# User Guide*.
|
1185
1215
|
#
|
1186
1216
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1187
|
-
# resources
|
1217
|
+
# resources. Don't specify it.
|
1188
1218
|
#
|
1189
1219
|
# </note>
|
1190
1220
|
#
|
@@ -1229,7 +1259,7 @@ module Aws::Batch
|
|
1229
1259
|
include Aws::Structure
|
1230
1260
|
end
|
1231
1261
|
|
1232
|
-
# An object
|
1262
|
+
# An object that represents the details of a container that's part of a
|
1233
1263
|
# job.
|
1234
1264
|
#
|
1235
1265
|
# @!attribute [rw] image
|
@@ -1273,8 +1303,8 @@ module Aws::Batch
|
|
1273
1303
|
# @return [Array<String>]
|
1274
1304
|
#
|
1275
1305
|
# @!attribute [rw] job_role_arn
|
1276
|
-
# The Amazon Resource Name (ARN) associated with the job
|
1277
|
-
#
|
1306
|
+
# The Amazon Resource Name (ARN) that's associated with the job when
|
1307
|
+
# run.
|
1278
1308
|
# @return [String]
|
1279
1309
|
#
|
1280
1310
|
# @!attribute [rw] execution_role_arn
|
@@ -1288,15 +1318,14 @@ module Aws::Batch
|
|
1288
1318
|
# @return [String]
|
1289
1319
|
#
|
1290
1320
|
# @!attribute [rw] volumes
|
1291
|
-
# A list of volumes associated with the job.
|
1321
|
+
# A list of volumes that are associated with the job.
|
1292
1322
|
# @return [Array<Types::Volume>]
|
1293
1323
|
#
|
1294
1324
|
# @!attribute [rw] environment
|
1295
1325
|
# The environment variables to pass to a container.
|
1296
1326
|
#
|
1297
|
-
# <note markdown="1"> Environment variables
|
1298
|
-
# convention is reserved for variables that
|
1299
|
-
# service.
|
1327
|
+
# <note markdown="1"> Environment variables cannot start with "`AWS_BATCH`". This naming
|
1328
|
+
# convention is reserved for variables that Batch sets.
|
1300
1329
|
#
|
1301
1330
|
# </note>
|
1302
1331
|
# @return [Array<Types::KeyValuePair>]
|
@@ -1338,10 +1367,10 @@ module Aws::Batch
|
|
1338
1367
|
# @!attribute [rw] privileged
|
1339
1368
|
# When this parameter is true, the container is given elevated
|
1340
1369
|
# permissions on the host container instance (similar to the `root`
|
1341
|
-
# user). The default value is false
|
1370
|
+
# user). The default value is `false`.
|
1342
1371
|
#
|
1343
1372
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
1344
|
-
# resources and shouldn't be provided, or specified as false
|
1373
|
+
# resources and shouldn't be provided, or specified as `false`.
|
1345
1374
|
#
|
1346
1375
|
# </note>
|
1347
1376
|
# @return [Boolean]
|
@@ -1364,7 +1393,7 @@ module Aws::Batch
|
|
1364
1393
|
#
|
1365
1394
|
# @!attribute [rw] reason
|
1366
1395
|
# A short (255 max characters) human-readable string to provide
|
1367
|
-
# additional details
|
1396
|
+
# additional details for a running or stopped container.
|
1368
1397
|
# @return [String]
|
1369
1398
|
#
|
1370
1399
|
# @!attribute [rw] container_instance_arn
|
@@ -1379,10 +1408,10 @@ module Aws::Batch
|
|
1379
1408
|
# @return [String]
|
1380
1409
|
#
|
1381
1410
|
# @!attribute [rw] log_stream_name
|
1382
|
-
# The name of the CloudWatch Logs log stream associated
|
1383
|
-
# container. The log group for Batch jobs is
|
1384
|
-
# container attempt receives a log stream name
|
1385
|
-
# `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.
|
1386
1415
|
# @return [String]
|
1387
1416
|
#
|
1388
1417
|
# @!attribute [rw] instance_type
|
@@ -1396,7 +1425,7 @@ module Aws::Batch
|
|
1396
1425
|
# @return [String]
|
1397
1426
|
#
|
1398
1427
|
# @!attribute [rw] network_interfaces
|
1399
|
-
# The network interfaces associated with the job.
|
1428
|
+
# The network interfaces that are associated with the job.
|
1400
1429
|
# @return [Array<Types::NetworkInterface>]
|
1401
1430
|
#
|
1402
1431
|
# @!attribute [rw] resource_requirements
|
@@ -1434,9 +1463,9 @@ module Aws::Batch
|
|
1434
1463
|
#
|
1435
1464
|
# This parameter requires version 1.18 of the Docker Remote API or
|
1436
1465
|
# greater on your container instance. To check the Docker Remote API
|
1437
|
-
# version on your container instance, log
|
1438
|
-
# and run the following command: `sudo docker version | grep
|
1439
|
-
# 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"`
|
1440
1469
|
#
|
1441
1470
|
# <note markdown="1"> The Amazon ECS container agent running on a container instance must
|
1442
1471
|
# register the logging drivers available on that instance with the
|
@@ -1538,8 +1567,8 @@ module Aws::Batch
|
|
1538
1567
|
# @!attribute [rw] vcpus
|
1539
1568
|
# This parameter is deprecated, use `resourceRequirements` to override
|
1540
1569
|
# the `vcpus` parameter that's set in the job definition. It's not
|
1541
|
-
# supported for jobs running on Fargate resources. For jobs
|
1542
|
-
# 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
|
1543
1572
|
# definition, but doesn't override any vCPU requirement specified in
|
1544
1573
|
# the `resourceRequirements` structure in the job definition. To
|
1545
1574
|
# override vCPU requirements that are specified in the
|
@@ -1557,12 +1586,12 @@ module Aws::Batch
|
|
1557
1586
|
# @!attribute [rw] memory
|
1558
1587
|
# This parameter is deprecated, use `resourceRequirements` to override
|
1559
1588
|
# the memory requirements specified in the job definition. It's not
|
1560
|
-
# supported for jobs running on Fargate resources. For jobs
|
1561
|
-
# EC2 resources, it overrides the `memory` parameter set in the job
|
1562
|
-
# definition, but doesn't override any memory requirement
|
1563
|
-
# in the `resourceRequirements` structure in the job
|
1564
|
-
# override memory requirements that are specified in
|
1565
|
-
# `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,
|
1566
1595
|
# `resourceRequirements` must be specified in the `SubmitJob` request,
|
1567
1596
|
# with `type` set to `MEMORY` and `value` set to the new value. For
|
1568
1597
|
# more information, see [Can't override job definition resource
|
@@ -1593,9 +1622,8 @@ module Aws::Batch
|
|
1593
1622
|
# or you can override the existing environment variables from the
|
1594
1623
|
# Docker image or the job definition.
|
1595
1624
|
#
|
1596
|
-
# <note markdown="1"> Environment variables
|
1597
|
-
# convention is reserved for variables that
|
1598
|
-
# service.
|
1625
|
+
# <note markdown="1"> Environment variables cannot start with "`AWS_BATCH`". This naming
|
1626
|
+
# convention is reserved for variables that Batch sets.
|
1599
1627
|
#
|
1600
1628
|
# </note>
|
1601
1629
|
# @return [Array<Types::KeyValuePair>]
|
@@ -1619,8 +1647,9 @@ module Aws::Batch
|
|
1619
1647
|
include Aws::Structure
|
1620
1648
|
end
|
1621
1649
|
|
1622
|
-
# Container properties are used
|
1623
|
-
# 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.
|
1624
1653
|
#
|
1625
1654
|
# @note When making an API call, you may pass ContainerProperties
|
1626
1655
|
# data as a hash:
|
@@ -1730,11 +1759,12 @@ module Aws::Batch
|
|
1730
1759
|
# The image used to start a container. This string is passed directly
|
1731
1760
|
# to the Docker daemon. Images in the Docker Hub registry are
|
1732
1761
|
# available by default. Other repositories are specified with `
|
1733
|
-
# repository-url/image:tag `.
|
1734
|
-
# lowercase
|
1735
|
-
#
|
1736
|
-
# `Image` in the [Create a
|
1737
|
-
# 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].
|
1738
1768
|
#
|
1739
1769
|
# <note markdown="1"> Docker image architecture must match the processor architecture of
|
1740
1770
|
# the compute resources that they're scheduled on. For example,
|
@@ -1749,7 +1779,7 @@ module Aws::Batch
|
|
1749
1779
|
#
|
1750
1780
|
# * Images in Amazon ECR repositories use the full registry and
|
1751
1781
|
# repository URI (for example,
|
1752
|
-
# `
|
1782
|
+
# `123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>`).
|
1753
1783
|
#
|
1754
1784
|
# * Images in official repositories on Docker Hub use a single name
|
1755
1785
|
# (for example, `ubuntu` or `mongo`).
|
@@ -1789,7 +1819,7 @@ module Aws::Batch
|
|
1789
1819
|
# @!attribute [rw] memory
|
1790
1820
|
# This parameter is deprecated, use `resourceRequirements` to specify
|
1791
1821
|
# the memory requirements for the job definition. It's not supported
|
1792
|
-
# for jobs running on Fargate resources. For jobs
|
1822
|
+
# for jobs running on Fargate resources. For jobs that run on EC2
|
1793
1823
|
# resources, it specifies the memory hard limit (in MiB) for a
|
1794
1824
|
# container. If your container attempts to exceed the specified
|
1795
1825
|
# number, it's terminated. You must specify at least 4 MiB of memory
|
@@ -1847,9 +1877,8 @@ module Aws::Batch
|
|
1847
1877
|
# We don't recommend using plaintext environment variables for
|
1848
1878
|
# sensitive information, such as credential data.
|
1849
1879
|
#
|
1850
|
-
# <note markdown="1"> Environment variables
|
1851
|
-
# convention is reserved for variables that
|
1852
|
-
# service.
|
1880
|
+
# <note markdown="1"> Environment variables cannot start with "`AWS_BATCH`". This naming
|
1881
|
+
# convention is reserved for variables that Batch sets.
|
1853
1882
|
#
|
1854
1883
|
# </note>
|
1855
1884
|
#
|
@@ -1975,9 +2004,9 @@ module Aws::Batch
|
|
1975
2004
|
#
|
1976
2005
|
# This parameter requires version 1.18 of the Docker Remote API or
|
1977
2006
|
# greater on your container instance. To check the Docker Remote API
|
1978
|
-
# version on your container instance, log
|
1979
|
-
# and run the following command: `sudo docker version | grep
|
1980
|
-
# 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"`
|
1981
2010
|
#
|
1982
2011
|
# <note markdown="1"> The Amazon ECS container agent running on a container instance must
|
1983
2012
|
# register the logging drivers available on that instance with the
|
@@ -2046,7 +2075,7 @@ module Aws::Batch
|
|
2046
2075
|
include Aws::Structure
|
2047
2076
|
end
|
2048
2077
|
|
2049
|
-
# An object
|
2078
|
+
# An object that represents summary details of a container within a job.
|
2050
2079
|
#
|
2051
2080
|
# @!attribute [rw] exit_code
|
2052
2081
|
# The exit code to return upon completion.
|
@@ -2054,7 +2083,7 @@ module Aws::Batch
|
|
2054
2083
|
#
|
2055
2084
|
# @!attribute [rw] reason
|
2056
2085
|
# A short (255 max characters) human-readable string to provide
|
2057
|
-
# additional details
|
2086
|
+
# additional details for a running or stopped container.
|
2058
2087
|
# @return [String]
|
2059
2088
|
#
|
2060
2089
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ContainerSummary AWS API Documentation
|
@@ -2103,6 +2132,7 @@ module Aws::Batch
|
|
2103
2132
|
# {
|
2104
2133
|
# image_type: "ImageType", # required
|
2105
2134
|
# image_id_override: "ImageIdOverride",
|
2135
|
+
# image_kubernetes_version: "KubernetesVersion",
|
2106
2136
|
# },
|
2107
2137
|
# ],
|
2108
2138
|
# },
|
@@ -2110,12 +2140,16 @@ module Aws::Batch
|
|
2110
2140
|
# tags: {
|
2111
2141
|
# "TagKey" => "TagValue",
|
2112
2142
|
# },
|
2143
|
+
# eks_configuration: {
|
2144
|
+
# eks_cluster_arn: "String", # required
|
2145
|
+
# kubernetes_namespace: "String", # required
|
2146
|
+
# },
|
2113
2147
|
# }
|
2114
2148
|
#
|
2115
2149
|
# @!attribute [rw] compute_environment_name
|
2116
|
-
# The name for your compute environment. It can be up to 128
|
2117
|
-
# long. It can contain uppercase and lowercase letters,
|
2118
|
-
# 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 (\_).
|
2119
2153
|
# @return [String]
|
2120
2154
|
#
|
2121
2155
|
# @!attribute [rw] type
|
@@ -2185,9 +2219,9 @@ module Aws::Batch
|
|
2185
2219
|
# If your specified role has a path other than `/`, then you must
|
2186
2220
|
# specify either the full role ARN (recommended) or prefix the role
|
2187
2221
|
# name with the path. For example, if a role with the name `bar` has a
|
2188
|
-
# path of `/foo
|
2189
|
-
#
|
2190
|
-
#
|
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*.
|
2191
2225
|
#
|
2192
2226
|
# <note markdown="1"> Depending on how you created your Batch service role, its ARN might
|
2193
2227
|
# contain the `service-role` path prefix. When you only specify the
|
@@ -2221,6 +2255,11 @@ module Aws::Batch
|
|
2221
2255
|
# [3]: https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html
|
2222
2256
|
# @return [Hash<String,String>]
|
2223
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
|
+
#
|
2224
2263
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateComputeEnvironmentRequest AWS API Documentation
|
2225
2264
|
#
|
2226
2265
|
class CreateComputeEnvironmentRequest < Struct.new(
|
@@ -2230,13 +2269,14 @@ module Aws::Batch
|
|
2230
2269
|
:unmanagedv_cpus,
|
2231
2270
|
:compute_resources,
|
2232
2271
|
:service_role,
|
2233
|
-
:tags
|
2272
|
+
:tags,
|
2273
|
+
:eks_configuration)
|
2234
2274
|
SENSITIVE = []
|
2235
2275
|
include Aws::Structure
|
2236
2276
|
end
|
2237
2277
|
|
2238
2278
|
# @!attribute [rw] compute_environment_name
|
2239
|
-
# 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
|
2240
2280
|
# long. It can contain uppercase and lowercase letters, numbers,
|
2241
2281
|
# hyphens (-), and underscores (\_).
|
2242
2282
|
# @return [String]
|
@@ -2297,7 +2337,7 @@ module Aws::Batch
|
|
2297
2337
|
# scheduling policy. The format is
|
2298
2338
|
# `aws:Partition:batch:Region:Account:scheduling-policy/Name `. An
|
2299
2339
|
# example is
|
2300
|
-
# `aws:aws:batch:us-west-2:
|
2340
|
+
# `aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`.
|
2301
2341
|
# @return [String]
|
2302
2342
|
#
|
2303
2343
|
# @!attribute [rw] priority
|
@@ -2437,7 +2477,7 @@ module Aws::Batch
|
|
2437
2477
|
# The Amazon Resource Name (ARN) of the scheduling policy. The format
|
2438
2478
|
# is `aws:Partition:batch:Region:Account:scheduling-policy/Name `. For
|
2439
2479
|
# example,
|
2440
|
-
# `aws:aws:batch:us-west-2:
|
2480
|
+
# `aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`.
|
2441
2481
|
# @return [String]
|
2442
2482
|
#
|
2443
2483
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateSchedulingPolicyResponse AWS API Documentation
|
@@ -2587,9 +2627,9 @@ module Aws::Batch
|
|
2587
2627
|
# `nextToken` value. This value is `null` when there are no more
|
2588
2628
|
# results to return.
|
2589
2629
|
#
|
2590
|
-
# <note markdown="1">
|
2591
|
-
#
|
2592
|
-
#
|
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.
|
2593
2633
|
#
|
2594
2634
|
# </note>
|
2595
2635
|
# @return [String]
|
@@ -2674,9 +2714,9 @@ module Aws::Batch
|
|
2674
2714
|
# value. This value is `null` when there are no more results to
|
2675
2715
|
# return.
|
2676
2716
|
#
|
2677
|
-
# <note markdown="1">
|
2678
|
-
#
|
2679
|
-
#
|
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.
|
2680
2720
|
#
|
2681
2721
|
# </note>
|
2682
2722
|
# @return [String]
|
@@ -2749,9 +2789,9 @@ module Aws::Batch
|
|
2749
2789
|
# value. This value is `null` when there are no more results to
|
2750
2790
|
# return.
|
2751
2791
|
#
|
2752
|
-
# <note markdown="1">
|
2753
|
-
#
|
2754
|
-
#
|
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.
|
2755
2795
|
#
|
2756
2796
|
# </note>
|
2757
2797
|
# @return [String]
|
@@ -2854,7 +2894,7 @@ module Aws::Batch
|
|
2854
2894
|
include Aws::Structure
|
2855
2895
|
end
|
2856
2896
|
|
2857
|
-
# An object
|
2897
|
+
# An object that represents a container instance host device.
|
2858
2898
|
#
|
2859
2899
|
# <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
|
2860
2900
|
# resources and shouldn't be provided.
|
@@ -2910,8 +2950,8 @@ module Aws::Batch
|
|
2910
2950
|
# The Amazon EFS access point ID to use. If an access point is
|
2911
2951
|
# specified, the root directory value specified in the
|
2912
2952
|
# `EFSVolumeConfiguration` must either be omitted or set to `/` which
|
2913
|
-
#
|
2914
|
-
#
|
2953
|
+
# enforces the path set on the EFS access point. If an access point is
|
2954
|
+
# used, transit encryption must be enabled in the
|
2915
2955
|
# `EFSVolumeConfiguration`. For more information, see [Working with
|
2916
2956
|
# Amazon EFS access points][1] in the *Amazon Elastic File System User
|
2917
2957
|
# Guide*.
|
@@ -3045,31 +3085,56 @@ module Aws::Batch
|
|
3045
3085
|
# {
|
3046
3086
|
# image_type: "ImageType", # required
|
3047
3087
|
# image_id_override: "ImageIdOverride",
|
3088
|
+
# image_kubernetes_version: "KubernetesVersion",
|
3048
3089
|
# }
|
3049
3090
|
#
|
3050
3091
|
# @!attribute [rw] image_type
|
3051
|
-
# The image type to match with the instance type to select an AMI.
|
3052
|
-
#
|
3053
|
-
#
|
3054
|
-
#
|
3055
|
-
#
|
3056
|
-
#
|
3057
|
-
#
|
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
|
3096
|
+
#
|
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.
|
3103
|
+
#
|
3104
|
+
# ECS\_AL2
|
3058
3105
|
#
|
3059
|
-
#
|
3106
|
+
# : [Amazon Linux 2][1]\: Default for all non-GPU instance families.
|
3060
3107
|
#
|
3061
|
-
#
|
3108
|
+
# ECS\_AL2\_NVIDIA
|
3062
3109
|
#
|
3063
|
-
#
|
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.
|
3064
3113
|
#
|
3065
|
-
#
|
3066
|
-
# (for example `P4` and `G4`) and can be used for all non Amazon Web
|
3067
|
-
# Services Graviton-based instance types.
|
3114
|
+
# ECS\_AL1
|
3068
3115
|
#
|
3069
|
-
#
|
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].
|
3070
3119
|
#
|
3071
|
-
#
|
3072
|
-
#
|
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.
|
3073
3138
|
#
|
3074
3139
|
#
|
3075
3140
|
#
|
@@ -3077,6 +3142,7 @@ module Aws::Batch
|
|
3077
3142
|
# [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami
|
3078
3143
|
# [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami
|
3079
3144
|
# [4]: http://aws.amazon.com/amazon-linux-ami/
|
3145
|
+
# [5]: https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html
|
3080
3146
|
# @return [String]
|
3081
3147
|
#
|
3082
3148
|
# @!attribute [rw] image_id_override
|
@@ -3100,241 +3166,1597 @@ module Aws::Batch
|
|
3100
3166
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html
|
3101
3167
|
# @return [String]
|
3102
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
|
+
#
|
3103
3174
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/Ec2Configuration AWS API Documentation
|
3104
3175
|
#
|
3105
3176
|
class Ec2Configuration < Struct.new(
|
3106
3177
|
:image_type,
|
3107
|
-
:image_id_override
|
3178
|
+
:image_id_override,
|
3179
|
+
:image_kubernetes_version)
|
3108
3180
|
SENSITIVE = []
|
3109
3181
|
include Aws::Structure
|
3110
3182
|
end
|
3111
3183
|
|
3112
|
-
#
|
3113
|
-
#
|
3184
|
+
# An object that represents the details for an attempt for a job attempt
|
3185
|
+
# that an Amazon EKS container runs.
|
3114
3186
|
#
|
3115
|
-
#
|
3116
|
-
#
|
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]
|
3117
3191
|
#
|
3118
|
-
#
|
3119
|
-
#
|
3120
|
-
#
|
3121
|
-
#
|
3122
|
-
# action: "RETRY", # required, accepts RETRY, EXIT
|
3123
|
-
# }
|
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]
|
3124
3196
|
#
|
3125
|
-
#
|
3126
|
-
# Contains a glob pattern to match against the `StatusReason` returned
|
3127
|
-
# for a job. The pattern can be up to 512 characters in length. It can
|
3128
|
-
# contain letters, numbers, periods (.), colons (:), and white space
|
3129
|
-
# (including spaces or tabs). It can optionally end with an asterisk
|
3130
|
-
# (*) so that only the start of the string needs to be an exact
|
3131
|
-
# match.
|
3197
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EksAttemptContainerDetail AWS API Documentation
|
3132
3198
|
#
|
3133
|
-
|
3134
|
-
|
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.
|
3135
3208
|
#
|
3136
|
-
# @!attribute [rw]
|
3137
|
-
#
|
3138
|
-
#
|
3139
|
-
#
|
3140
|
-
# (including spaces and tabs). It can optionally end with an asterisk
|
3141
|
-
# (*) so that only the start of the string needs to be an exact
|
3142
|
-
# 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>]
|
3143
3213
|
#
|
3144
|
-
#
|
3214
|
+
# @!attribute [rw] pod_name
|
3215
|
+
# The name of the pod for this job attempt.
|
3145
3216
|
# @return [String]
|
3146
3217
|
#
|
3147
|
-
# @!attribute [rw]
|
3148
|
-
#
|
3149
|
-
# of the `ExitCode` returned for a job. The pattern can be up to 512
|
3150
|
-
# characters in length. It can contain only numbers, and can
|
3151
|
-
# optionally end with an asterisk (*) so that only the start of the
|
3152
|
-
# string needs to be an exact match.
|
3153
|
-
#
|
3154
|
-
# 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.
|
3155
3220
|
# @return [String]
|
3156
3221
|
#
|
3157
|
-
# @!attribute [rw]
|
3158
|
-
#
|
3159
|
-
# (
|
3160
|
-
#
|
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.
|
3161
3238
|
# @return [String]
|
3162
3239
|
#
|
3163
|
-
# @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
|
3164
3241
|
#
|
3165
|
-
class
|
3166
|
-
:
|
3167
|
-
:
|
3168
|
-
:
|
3169
|
-
:
|
3242
|
+
class EksAttemptDetail < Struct.new(
|
3243
|
+
:containers,
|
3244
|
+
:pod_name,
|
3245
|
+
:node_name,
|
3246
|
+
:started_at,
|
3247
|
+
:stopped_at,
|
3248
|
+
:status_reason)
|
3170
3249
|
SENSITIVE = []
|
3171
3250
|
include Aws::Structure
|
3172
3251
|
end
|
3173
3252
|
|
3174
|
-
#
|
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.
|
3175
3256
|
#
|
3176
|
-
# @note When making an API call, you may pass
|
3257
|
+
# @note When making an API call, you may pass EksConfiguration
|
3177
3258
|
# data as a hash:
|
3178
3259
|
#
|
3179
3260
|
# {
|
3180
|
-
#
|
3181
|
-
#
|
3182
|
-
# share_distribution: [
|
3183
|
-
# {
|
3184
|
-
# share_identifier: "String", # required
|
3185
|
-
# weight_factor: 1.0,
|
3186
|
-
# },
|
3187
|
-
# ],
|
3261
|
+
# eks_cluster_arn: "String", # required
|
3262
|
+
# kubernetes_namespace: "String", # required
|
3188
3263
|
# }
|
3189
3264
|
#
|
3190
|
-
# @!attribute [rw]
|
3191
|
-
# The
|
3192
|
-
#
|
3193
|
-
#
|
3194
|
-
# allows for more recently run jobs to have more weight than jobs that
|
3195
|
-
# ran earlier. The maximum supported value is 604800 (1 week).
|
3196
|
-
# @return [Integer]
|
3197
|
-
#
|
3198
|
-
# @!attribute [rw] compute_reservation
|
3199
|
-
# A value used to reserve some of the available maximum vCPU for fair
|
3200
|
-
# 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]
|
3201
3269
|
#
|
3202
|
-
#
|
3203
|
-
#
|
3204
|
-
#
|
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.
|
3205
3277
|
#
|
3206
|
-
# For example, a `computeReservation` value of 50 indicates that Batch
|
3207
|
-
# should reserve 50% of the maximum available vCPU if there is only
|
3208
|
-
# one fair share identifier, 25% if there are two fair share
|
3209
|
-
# identifiers, and 12.5% if there are three fair share identifiers. A
|
3210
|
-
# `computeReservation` value of 25 indicates that Batch should reserve
|
3211
|
-
# 25% of the maximum available vCPU if there is only one fair share
|
3212
|
-
# identifier, 6.25% if there are two fair share identifiers, and 1.56%
|
3213
|
-
# if there are three fair share identifiers.
|
3214
3278
|
#
|
3215
|
-
# The minimum value is 0 and the maximum value is 99.
|
3216
|
-
# @return [Integer]
|
3217
3279
|
#
|
3218
|
-
#
|
3219
|
-
#
|
3220
|
-
# the fair share identifiers for the fair share policy. Fair share
|
3221
|
-
# identifiers that aren't included have a default weight of `1.0`.
|
3222
|
-
# @return [Array<Types::ShareAttributes>]
|
3280
|
+
# [1]: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
|
3281
|
+
# @return [String]
|
3223
3282
|
#
|
3224
|
-
# @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
|
3225
3284
|
#
|
3226
|
-
class
|
3227
|
-
:
|
3228
|
-
:
|
3229
|
-
:share_distribution)
|
3285
|
+
class EksConfiguration < Struct.new(
|
3286
|
+
:eks_cluster_arn,
|
3287
|
+
:kubernetes_namespace)
|
3230
3288
|
SENSITIVE = []
|
3231
3289
|
include Aws::Structure
|
3232
3290
|
end
|
3233
3291
|
|
3234
|
-
#
|
3235
|
-
#
|
3236
|
-
#
|
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.
|
3237
3296
|
#
|
3238
|
-
# @note When making an API call, you may pass
|
3297
|
+
# @note When making an API call, you may pass EksContainer
|
3239
3298
|
# data as a hash:
|
3240
3299
|
#
|
3241
3300
|
# {
|
3242
|
-
#
|
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
|
+
# },
|
3243
3334
|
# }
|
3244
3335
|
#
|
3245
|
-
# @!attribute [rw]
|
3246
|
-
# The
|
3247
|
-
#
|
3248
|
-
#
|
3249
|
-
#
|
3250
|
-
# platform for compute resources. For more information, see [Fargate
|
3251
|
-
# platform versions][1] in the *Amazon Elastic Container Service
|
3252
|
-
# 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]
|
3253
3341
|
#
|
3342
|
+
# @!attribute [rw] image
|
3343
|
+
# The Docker image used to start the container.
|
3344
|
+
# @return [String]
|
3254
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*.
|
3255
3352
|
#
|
3256
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
3257
|
-
# @return [String]
|
3258
3353
|
#
|
3259
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/FargatePlatformConfiguration AWS API Documentation
|
3260
3354
|
#
|
3261
|
-
|
3262
|
-
|
3263
|
-
SENSITIVE = []
|
3264
|
-
include Aws::Structure
|
3265
|
-
end
|
3266
|
-
|
3267
|
-
# Determine whether your data volume persists on the host container
|
3268
|
-
# instance and where it is stored. If this parameter is empty, then the
|
3269
|
-
# Docker daemon assigns a host path for your data volume, but the data
|
3270
|
-
# isn't guaranteed to persist after the containers associated with it
|
3271
|
-
# stop running.
|
3355
|
+
# [1]: https://kubernetes.io/docs/concepts/containers/images/#updating-images
|
3356
|
+
# @return [String]
|
3272
3357
|
#
|
3273
|
-
#
|
3274
|
-
#
|
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>]
|
3275
3381
|
#
|
3276
|
-
#
|
3277
|
-
#
|
3278
|
-
#
|
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>]
|
3279
3406
|
#
|
3280
|
-
# @!attribute [rw]
|
3281
|
-
# The
|
3282
|
-
# container. If this parameter is empty, then the Docker daemon has
|
3283
|
-
# assigned a host path for you. If this parameter contains a file
|
3284
|
-
# location, then the data volume persists at the specified location on
|
3285
|
-
# the host container instance until you delete it manually. If the
|
3286
|
-
# source path location doesn't exist on the host container instance,
|
3287
|
-
# the Docker daemon creates it. If the location does exist, the
|
3288
|
-
# contents of the source path folder are exported.
|
3407
|
+
# @!attribute [rw] env
|
3408
|
+
# The environment variables to pass to a container.
|
3289
3409
|
#
|
3290
|
-
# <note markdown="1">
|
3291
|
-
#
|
3410
|
+
# <note markdown="1"> Environment variables cannot start with "`AWS_BATCH`". This naming
|
3411
|
+
# convention is reserved for variables that Batch sets.
|
3292
3412
|
#
|
3293
3413
|
# </note>
|
3294
|
-
# @return [
|
3414
|
+
# @return [Array<Types::EksContainerEnvironmentVariable>]
|
3295
3415
|
#
|
3296
|
-
#
|
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*.
|
3297
3421
|
#
|
3298
|
-
|
3299
|
-
|
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)
|
3300
3460
|
SENSITIVE = []
|
3301
3461
|
include Aws::Structure
|
3302
3462
|
end
|
3303
3463
|
|
3304
|
-
#
|
3464
|
+
# The details for container properties that are returned by
|
3465
|
+
# `DescribeJobs` for jobs that use Amazon EKS.
|
3305
3466
|
#
|
3306
|
-
# @!attribute [rw]
|
3307
|
-
# 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.
|
3308
3471
|
# @return [String]
|
3309
3472
|
#
|
3310
|
-
# @!attribute [rw]
|
3311
|
-
# The
|
3473
|
+
# @!attribute [rw] image
|
3474
|
+
# The Docker image used to start the container.
|
3312
3475
|
# @return [String]
|
3313
3476
|
#
|
3314
|
-
# @!attribute [rw]
|
3315
|
-
# The
|
3316
|
-
#
|
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*.
|
3317
3483
|
#
|
3318
|
-
#
|
3319
|
-
#
|
3484
|
+
#
|
3485
|
+
#
|
3486
|
+
# [1]: https://kubernetes.io/docs/concepts/containers/images/#updating-images
|
3320
3487
|
# @return [String]
|
3321
3488
|
#
|
3322
|
-
# @!attribute [rw]
|
3323
|
-
# The
|
3324
|
-
#
|
3325
|
-
# supported. For more information about multi-node parallel jobs, see
|
3326
|
-
# [Creating a multi-node parallel job definition][1] in the *Batch
|
3327
|
-
# User Guide*.
|
3489
|
+
# @!attribute [rw] command
|
3490
|
+
# The entrypoint for the container. For more information, see
|
3491
|
+
# [Entrypoint][1] in the *Kubernetes documentation*.
|
3328
3492
|
#
|
3329
3493
|
#
|
3330
3494
|
#
|
3331
|
-
# [1]: https://
|
3332
|
-
# @return [String]
|
3495
|
+
# [1]: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint
|
3496
|
+
# @return [Array<String>]
|
3333
3497
|
#
|
3334
|
-
# @!attribute [rw]
|
3335
|
-
#
|
3336
|
-
#
|
3337
|
-
#
|
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>]
|
3522
|
+
#
|
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
|
3338
4760
|
# scheduling priority.
|
3339
4761
|
# @return [Integer]
|
3340
4762
|
#
|
@@ -3357,37 +4779,40 @@ module Aws::Batch
|
|
3357
4779
|
# @return [Types::RetryStrategy]
|
3358
4780
|
#
|
3359
4781
|
# @!attribute [rw] container_properties
|
3360
|
-
# 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.
|
3361
4785
|
# @return [Types::ContainerProperties]
|
3362
4786
|
#
|
3363
4787
|
# @!attribute [rw] timeout
|
3364
|
-
# The timeout
|
3365
|
-
# definition.
|
3366
|
-
# 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.
|
3367
4791
|
# @return [Types::JobTimeout]
|
3368
4792
|
#
|
3369
4793
|
# @!attribute [rw] node_properties
|
3370
|
-
# An object with various properties specific to multi-node
|
3371
|
-
# 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.
|
3372
4797
|
#
|
3373
|
-
# <note markdown="1"> If the job runs on Fargate resources,
|
3374
|
-
# `nodeProperties
|
4798
|
+
# <note markdown="1"> If the job runs on Fargate resources, don't specify
|
4799
|
+
# `nodeProperties`. Use `containerProperties` instead.
|
3375
4800
|
#
|
3376
4801
|
# </note>
|
3377
4802
|
# @return [Types::NodeProperties]
|
3378
4803
|
#
|
3379
4804
|
# @!attribute [rw] tags
|
3380
|
-
# The tags applied to the job definition.
|
4805
|
+
# The tags that are applied to the job definition.
|
3381
4806
|
# @return [Hash<String,String>]
|
3382
4807
|
#
|
3383
4808
|
# @!attribute [rw] propagate_tags
|
3384
4809
|
# Specifies whether to propagate the tags from the job or job
|
3385
4810
|
# definition to the corresponding Amazon ECS task. If no value is
|
3386
4811
|
# specified, the tags aren't propagated. Tags can only be propagated
|
3387
|
-
# to the tasks
|
3388
|
-
# tags are given priority over job definitions tags. If the
|
3389
|
-
# number of combined tags from the job and job definition is
|
3390
|
-
# 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.
|
3391
4816
|
# @return [Boolean]
|
3392
4817
|
#
|
3393
4818
|
# @!attribute [rw] platform_capabilities
|
@@ -3396,6 +4821,17 @@ module Aws::Batch
|
|
3396
4821
|
# resources specify `FARGATE`.
|
3397
4822
|
# @return [Array<String>]
|
3398
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
|
+
#
|
3399
4835
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobDefinition AWS API Documentation
|
3400
4836
|
#
|
3401
4837
|
class JobDefinition < Struct.new(
|
@@ -3412,12 +4848,14 @@ module Aws::Batch
|
|
3412
4848
|
:node_properties,
|
3413
4849
|
:tags,
|
3414
4850
|
:propagate_tags,
|
3415
|
-
:platform_capabilities
|
4851
|
+
:platform_capabilities,
|
4852
|
+
:eks_properties,
|
4853
|
+
:container_orchestration_type)
|
3416
4854
|
SENSITIVE = []
|
3417
4855
|
include Aws::Structure
|
3418
4856
|
end
|
3419
4857
|
|
3420
|
-
# An object
|
4858
|
+
# An object that represents an Batch job dependency.
|
3421
4859
|
#
|
3422
4860
|
# @note When making an API call, you may pass JobDependency
|
3423
4861
|
# data as a hash:
|
@@ -3428,7 +4866,7 @@ module Aws::Batch
|
|
3428
4866
|
# }
|
3429
4867
|
#
|
3430
4868
|
# @!attribute [rw] job_id
|
3431
|
-
# 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.
|
3432
4870
|
# @return [String]
|
3433
4871
|
#
|
3434
4872
|
# @!attribute [rw] type
|
@@ -3444,18 +4882,18 @@ module Aws::Batch
|
|
3444
4882
|
include Aws::Structure
|
3445
4883
|
end
|
3446
4884
|
|
3447
|
-
# An object
|
4885
|
+
# An object that represents an Batch job.
|
3448
4886
|
#
|
3449
4887
|
# @!attribute [rw] job_arn
|
3450
4888
|
# The Amazon Resource Name (ARN) of the job.
|
3451
4889
|
# @return [String]
|
3452
4890
|
#
|
3453
4891
|
# @!attribute [rw] job_name
|
3454
|
-
# The name
|
4892
|
+
# The job name.
|
3455
4893
|
# @return [String]
|
3456
4894
|
#
|
3457
4895
|
# @!attribute [rw] job_id
|
3458
|
-
# The ID
|
4896
|
+
# The job ID.
|
3459
4897
|
# @return [String]
|
3460
4898
|
#
|
3461
4899
|
# @!attribute [rw] job_queue
|
@@ -3489,20 +4927,20 @@ module Aws::Batch
|
|
3489
4927
|
# @return [Integer]
|
3490
4928
|
#
|
3491
4929
|
# @!attribute [rw] attempts
|
3492
|
-
# A list of job attempts associated with this job.
|
4930
|
+
# A list of job attempts that are associated with this job.
|
3493
4931
|
# @return [Array<Types::AttemptDetail>]
|
3494
4932
|
#
|
3495
4933
|
# @!attribute [rw] status_reason
|
3496
|
-
# A short, human-readable string to provide
|
3497
|
-
#
|
4934
|
+
# A short, human-readable string to provide more details for the
|
4935
|
+
# current status of the job.
|
3498
4936
|
# @return [String]
|
3499
4937
|
#
|
3500
4938
|
# @!attribute [rw] created_at
|
3501
4939
|
# The Unix timestamp (in milliseconds) for when the job was created.
|
3502
4940
|
# For non-array jobs and parent array jobs, this is when the job
|
3503
|
-
# entered the `SUBMITTED` state
|
3504
|
-
# For array child jobs, this is when the child
|
3505
|
-
# 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.
|
3506
4944
|
# @return [Integer]
|
3507
4945
|
#
|
3508
4946
|
# @!attribute [rw] retry_strategy
|
@@ -3510,16 +4948,17 @@ module Aws::Batch
|
|
3510
4948
|
# @return [Types::RetryStrategy]
|
3511
4949
|
#
|
3512
4950
|
# @!attribute [rw] started_at
|
3513
|
-
# The Unix timestamp (in milliseconds) for when the job was started
|
3514
|
-
#
|
3515
|
-
# `RUNNING` state
|
3516
|
-
# 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.
|
3517
4955
|
# @return [Integer]
|
3518
4956
|
#
|
3519
4957
|
# @!attribute [rw] stopped_at
|
3520
|
-
# The Unix timestamp (in milliseconds) for when the job was stopped
|
3521
|
-
#
|
3522
|
-
# 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`.
|
3523
4962
|
# @return [Integer]
|
3524
4963
|
#
|
3525
4964
|
# @!attribute [rw] depends_on
|
@@ -3527,29 +4966,29 @@ module Aws::Batch
|
|
3527
4966
|
# @return [Array<Types::JobDependency>]
|
3528
4967
|
#
|
3529
4968
|
# @!attribute [rw] job_definition
|
3530
|
-
# The Amazon Resource Name (ARN) of the job definition that
|
3531
|
-
#
|
4969
|
+
# The Amazon Resource Name (ARN) of the job definition that this job
|
4970
|
+
# uses.
|
3532
4971
|
# @return [String]
|
3533
4972
|
#
|
3534
4973
|
# @!attribute [rw] parameters
|
3535
|
-
# Additional parameters passed to the job that replace
|
3536
|
-
# substitution placeholders or override any corresponding
|
3537
|
-
# 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.
|
3538
4977
|
# @return [Hash<String,String>]
|
3539
4978
|
#
|
3540
4979
|
# @!attribute [rw] container
|
3541
|
-
# An object
|
4980
|
+
# An object that represents the details for the container that's
|
3542
4981
|
# associated with the job.
|
3543
4982
|
# @return [Types::ContainerDetail]
|
3544
4983
|
#
|
3545
4984
|
# @!attribute [rw] node_details
|
3546
|
-
# An object
|
3547
|
-
# 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.
|
3548
4987
|
# @return [Types::NodeDetails]
|
3549
4988
|
#
|
3550
4989
|
# @!attribute [rw] node_properties
|
3551
|
-
# An object
|
3552
|
-
# job.
|
4990
|
+
# An object that represents the node properties of a multi-node
|
4991
|
+
# parallel job.
|
3553
4992
|
#
|
3554
4993
|
# <note markdown="1"> This isn't applicable to jobs that are running on Fargate
|
3555
4994
|
# resources.
|
@@ -3558,7 +4997,7 @@ module Aws::Batch
|
|
3558
4997
|
# @return [Types::NodeProperties]
|
3559
4998
|
#
|
3560
4999
|
# @!attribute [rw] array_properties
|
3561
|
-
# The array properties of the job, if it
|
5000
|
+
# The array properties of the job, if it's an array job.
|
3562
5001
|
# @return [Types::ArrayPropertiesDetail]
|
3563
5002
|
#
|
3564
5003
|
# @!attribute [rw] timeout
|
@@ -3566,17 +5005,17 @@ module Aws::Batch
|
|
3566
5005
|
# @return [Types::JobTimeout]
|
3567
5006
|
#
|
3568
5007
|
# @!attribute [rw] tags
|
3569
|
-
# The tags applied to the job.
|
5008
|
+
# The tags that are applied to the job.
|
3570
5009
|
# @return [Hash<String,String>]
|
3571
5010
|
#
|
3572
5011
|
# @!attribute [rw] propagate_tags
|
3573
5012
|
# Specifies whether to propagate the tags from the job or job
|
3574
5013
|
# definition to the corresponding Amazon ECS task. If no value is
|
3575
5014
|
# specified, the tags aren't propagated. Tags can only be propagated
|
3576
|
-
# to the tasks
|
3577
|
-
# tags are given priority over job definitions tags. If the
|
3578
|
-
# number of combined tags from the job and job definition is
|
3579
|
-
# 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.
|
3580
5019
|
# @return [Boolean]
|
3581
5020
|
#
|
3582
5021
|
# @!attribute [rw] platform_capabilities
|
@@ -3585,6 +5024,16 @@ module Aws::Batch
|
|
3585
5024
|
# resources specify `FARGATE`.
|
3586
5025
|
# @return [Array<String>]
|
3587
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
|
+
#
|
3588
5037
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobDetail AWS API Documentation
|
3589
5038
|
#
|
3590
5039
|
class JobDetail < Struct.new(
|
@@ -3611,15 +5060,17 @@ module Aws::Batch
|
|
3611
5060
|
:timeout,
|
3612
5061
|
:tags,
|
3613
5062
|
:propagate_tags,
|
3614
|
-
:platform_capabilities
|
5063
|
+
:platform_capabilities,
|
5064
|
+
:eks_properties,
|
5065
|
+
:eks_attempts)
|
3615
5066
|
SENSITIVE = []
|
3616
5067
|
include Aws::Structure
|
3617
5068
|
end
|
3618
5069
|
|
3619
|
-
# An object
|
5070
|
+
# An object that represents the details for an Batch job queue.
|
3620
5071
|
#
|
3621
5072
|
# @!attribute [rw] job_queue_name
|
3622
|
-
# The
|
5073
|
+
# The job queue name.
|
3623
5074
|
# @return [String]
|
3624
5075
|
#
|
3625
5076
|
# @!attribute [rw] job_queue_arn
|
@@ -3628,16 +5079,16 @@ module Aws::Batch
|
|
3628
5079
|
#
|
3629
5080
|
# @!attribute [rw] state
|
3630
5081
|
# Describes the ability of the queue to accept new jobs. If the job
|
3631
|
-
# queue state is `ENABLED`, it
|
3632
|
-
#
|
3633
|
-
#
|
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.
|
3634
5085
|
# @return [String]
|
3635
5086
|
#
|
3636
5087
|
# @!attribute [rw] scheduling_policy_arn
|
3637
5088
|
# The Amazon Resource Name (ARN) of the scheduling policy. The format
|
3638
5089
|
# is `aws:Partition:batch:Region:Account:scheduling-policy/Name `. For
|
3639
5090
|
# example,
|
3640
|
-
# `aws:aws:batch:us-west-2:
|
5091
|
+
# `aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`.
|
3641
5092
|
# @return [String]
|
3642
5093
|
#
|
3643
5094
|
# @!attribute [rw] status
|
@@ -3645,19 +5096,19 @@ module Aws::Batch
|
|
3645
5096
|
# @return [String]
|
3646
5097
|
#
|
3647
5098
|
# @!attribute [rw] status_reason
|
3648
|
-
# A short, human-readable string to provide additional details
|
3649
|
-
#
|
5099
|
+
# A short, human-readable string to provide additional details for the
|
5100
|
+
# current status of the job queue.
|
3650
5101
|
# @return [String]
|
3651
5102
|
#
|
3652
5103
|
# @!attribute [rw] priority
|
3653
5104
|
# The priority of the job queue. Job queues with a higher priority (or
|
3654
5105
|
# a higher integer value for the `priority` parameter) are evaluated
|
3655
5106
|
# first when associated with the same compute environment. Priority is
|
3656
|
-
# determined in descending order
|
5107
|
+
# determined in descending order. For example, a job queue with a
|
3657
5108
|
# priority value of `10` is given scheduling preference over a job
|
3658
5109
|
# queue with a priority value of `1`. All of the compute environments
|
3659
5110
|
# must be either EC2 (`EC2` or `SPOT`) or Fargate (`FARGATE` or
|
3660
|
-
# `FARGATE_SPOT`)
|
5111
|
+
# `FARGATE_SPOT`). EC2 and Fargate compute environments can't be
|
3661
5112
|
# mixed.
|
3662
5113
|
# @return [Integer]
|
3663
5114
|
#
|
@@ -3668,8 +5119,8 @@ module Aws::Batch
|
|
3668
5119
|
# @return [Array<Types::ComputeEnvironmentOrder>]
|
3669
5120
|
#
|
3670
5121
|
# @!attribute [rw] tags
|
3671
|
-
# The tags applied to the job queue. For more information,
|
3672
|
-
# [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*.
|
3673
5124
|
#
|
3674
5125
|
#
|
3675
5126
|
#
|
@@ -3692,18 +5143,18 @@ module Aws::Batch
|
|
3692
5143
|
include Aws::Structure
|
3693
5144
|
end
|
3694
5145
|
|
3695
|
-
# An object
|
5146
|
+
# An object that represents summary details of a job.
|
3696
5147
|
#
|
3697
5148
|
# @!attribute [rw] job_arn
|
3698
5149
|
# The Amazon Resource Name (ARN) of the job.
|
3699
5150
|
# @return [String]
|
3700
5151
|
#
|
3701
5152
|
# @!attribute [rw] job_id
|
3702
|
-
# The ID
|
5153
|
+
# The job ID.
|
3703
5154
|
# @return [String]
|
3704
5155
|
#
|
3705
5156
|
# @!attribute [rw] job_name
|
3706
|
-
# The name
|
5157
|
+
# The job name.
|
3707
5158
|
# @return [String]
|
3708
5159
|
#
|
3709
5160
|
# @!attribute [rw] created_at
|
@@ -3719,28 +5170,29 @@ module Aws::Batch
|
|
3719
5170
|
# @return [String]
|
3720
5171
|
#
|
3721
5172
|
# @!attribute [rw] status_reason
|
3722
|
-
# A short, human-readable string to provide
|
3723
|
-
#
|
5173
|
+
# A short, human-readable string to provide more details for the
|
5174
|
+
# current status of the job.
|
3724
5175
|
# @return [String]
|
3725
5176
|
#
|
3726
5177
|
# @!attribute [rw] started_at
|
3727
|
-
# The Unix timestamp for when the job was started
|
3728
|
-
# 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.
|
3729
5181
|
# @return [Integer]
|
3730
5182
|
#
|
3731
5183
|
# @!attribute [rw] stopped_at
|
3732
|
-
# The Unix timestamp for when the job was stopped
|
3733
|
-
# transitioned from the `RUNNING` state to a
|
3734
|
-
# `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`.
|
3735
5187
|
# @return [Integer]
|
3736
5188
|
#
|
3737
5189
|
# @!attribute [rw] container
|
3738
|
-
# An object
|
5190
|
+
# An object that represents the details of the container that's
|
3739
5191
|
# associated with the job.
|
3740
5192
|
# @return [Types::ContainerSummary]
|
3741
5193
|
#
|
3742
5194
|
# @!attribute [rw] array_properties
|
3743
|
-
# The array properties of the job, if it
|
5195
|
+
# The array properties of the job, if it's an array job.
|
3744
5196
|
# @return [Types::ArrayPropertiesSummary]
|
3745
5197
|
#
|
3746
5198
|
# @!attribute [rw] node_properties
|
@@ -3775,7 +5227,7 @@ module Aws::Batch
|
|
3775
5227
|
include Aws::Structure
|
3776
5228
|
end
|
3777
5229
|
|
3778
|
-
# An object
|
5230
|
+
# An object that represents a job timeout configuration.
|
3779
5231
|
#
|
3780
5232
|
# @note When making an API call, you may pass JobTimeout
|
3781
5233
|
# data as a hash:
|
@@ -3785,10 +5237,10 @@ module Aws::Batch
|
|
3785
5237
|
# }
|
3786
5238
|
#
|
3787
5239
|
# @!attribute [rw] attempt_duration_seconds
|
3788
|
-
# The time
|
3789
|
-
# `startedAt` timestamp
|
3790
|
-
# they
|
3791
|
-
# 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.
|
3792
5244
|
# @return [Integer]
|
3793
5245
|
#
|
3794
5246
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobTimeout AWS API Documentation
|
@@ -3856,9 +5308,9 @@ module Aws::Batch
|
|
3856
5308
|
include Aws::Structure
|
3857
5309
|
end
|
3858
5310
|
|
3859
|
-
# An object
|
3860
|
-
# resource. You must specify either the launch template ID or
|
3861
|
-
# 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.
|
3862
5314
|
#
|
3863
5315
|
# If security groups are specified using both the `securityGroupIds`
|
3864
5316
|
# parameter of `CreateComputeEnvironment` and the launch template, the
|
@@ -3952,12 +5404,12 @@ module Aws::Batch
|
|
3952
5404
|
# }
|
3953
5405
|
#
|
3954
5406
|
# @!attribute [rw] devices
|
3955
|
-
# Any host devices to expose to the container. This parameter
|
3956
|
-
# `Devices` in the [Create a container][1] section of the
|
3957
|
-
# 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].
|
3958
5410
|
#
|
3959
5411
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
3960
|
-
# resources
|
5412
|
+
# resources. Don't provide it for these jobs.
|
3961
5413
|
#
|
3962
5414
|
# </note>
|
3963
5415
|
#
|
@@ -3974,7 +5426,7 @@ module Aws::Batch
|
|
3974
5426
|
# option to [docker run][1]. This parameter requires version 1.25 of
|
3975
5427
|
# the Docker Remote API or greater on your container instance. To
|
3976
5428
|
# check the Docker Remote API version on your container instance, log
|
3977
|
-
#
|
5429
|
+
# in to your container instance and run the following command: `sudo
|
3978
5430
|
# docker version | grep "Server API version"`
|
3979
5431
|
#
|
3980
5432
|
#
|
@@ -3987,7 +5439,7 @@ module Aws::Batch
|
|
3987
5439
|
# parameter maps to the `--shm-size` option to [docker run][1].
|
3988
5440
|
#
|
3989
5441
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
3990
|
-
# resources
|
5442
|
+
# resources. Don't provide it for these jobs.
|
3991
5443
|
#
|
3992
5444
|
# </note>
|
3993
5445
|
#
|
@@ -3997,12 +5449,12 @@ module Aws::Batch
|
|
3997
5449
|
# @return [Integer]
|
3998
5450
|
#
|
3999
5451
|
# @!attribute [rw] tmpfs
|
4000
|
-
# 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`
|
4001
5453
|
# mount. This parameter maps to the `--tmpfs` option to [docker
|
4002
5454
|
# run][1].
|
4003
5455
|
#
|
4004
5456
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
4005
|
-
# resources
|
5457
|
+
# resources. Don't provide this parameter for this resource type.
|
4006
5458
|
#
|
4007
5459
|
# </note>
|
4008
5460
|
#
|
@@ -4021,12 +5473,12 @@ module Aws::Batch
|
|
4021
5473
|
# If a `maxSwap` value of `0` is specified, the container doesn't use
|
4022
5474
|
# swap. Accepted values are `0` or any positive integer. If the
|
4023
5475
|
# `maxSwap` parameter is omitted, the container doesn't use the swap
|
4024
|
-
# configuration for the container instance it
|
5476
|
+
# configuration for the container instance that it's running on. A
|
4025
5477
|
# `maxSwap` value must be set for the `swappiness` parameter to be
|
4026
5478
|
# used.
|
4027
5479
|
#
|
4028
5480
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
4029
|
-
# resources
|
5481
|
+
# resources. Don't provide it for these jobs.
|
4030
5482
|
#
|
4031
5483
|
# </note>
|
4032
5484
|
#
|
@@ -4037,10 +5489,10 @@ module Aws::Batch
|
|
4037
5489
|
# @return [Integer]
|
4038
5490
|
#
|
4039
5491
|
# @!attribute [rw] swappiness
|
4040
|
-
#
|
4041
|
-
# `swappiness` value of `0` causes swapping
|
4042
|
-
# absolutely necessary. A `swappiness` value of `100` causes
|
4043
|
-
# 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
|
4044
5496
|
# between `0` and `100`. If the `swappiness` parameter isn't
|
4045
5497
|
# specified, a default value of `60` is used. If a value isn't
|
4046
5498
|
# specified for `maxSwap`, then this parameter is ignored. If
|
@@ -4054,12 +5506,12 @@ module Aws::Batch
|
|
4054
5506
|
# * Swap space must be enabled and allocated on the container instance
|
4055
5507
|
# for the containers to use.
|
4056
5508
|
#
|
4057
|
-
# <note markdown="1">
|
4058
|
-
# You must enable swap on the instance to use this feature.
|
4059
|
-
# information, see [Instance store swap volumes][2] in the
|
4060
|
-
# EC2 User Guide for Linux Instances* or [How do I allocate
|
4061
|
-
# to work as swap space in an Amazon EC2 instance by using a
|
4062
|
-
# 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]
|
4063
5515
|
#
|
4064
5516
|
# </note>
|
4065
5517
|
#
|
@@ -4067,12 +5519,12 @@ module Aws::Batch
|
|
4067
5519
|
# using EC2 resources.
|
4068
5520
|
#
|
4069
5521
|
# * If the `maxSwap` and `swappiness` parameters are omitted from a
|
4070
|
-
# job definition, each container
|
4071
|
-
#
|
4072
|
-
#
|
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.
|
4073
5525
|
#
|
4074
5526
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
4075
|
-
# resources
|
5527
|
+
# resources. Don't provide it for these jobs.
|
4076
5528
|
#
|
4077
5529
|
# </note>
|
4078
5530
|
#
|
@@ -4157,9 +5609,9 @@ module Aws::Batch
|
|
4157
5609
|
# previous results that returned the `nextToken` value. This value is
|
4158
5610
|
# `null` when there are no more results to return.
|
4159
5611
|
#
|
4160
|
-
# <note markdown="1">
|
4161
|
-
#
|
4162
|
-
#
|
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.
|
4163
5615
|
#
|
4164
5616
|
# </note>
|
4165
5617
|
# @return [String]
|
@@ -4174,12 +5626,12 @@ module Aws::Batch
|
|
4174
5626
|
# JOB\_NAME
|
4175
5627
|
#
|
4176
5628
|
# : The value of the filter is a case-insensitive match for the job
|
4177
|
-
# name. If the value ends with an asterisk (*), the filter
|
4178
|
-
#
|
4179
|
-
#
|
4180
|
-
#
|
4181
|
-
# `
|
4182
|
-
#
|
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.
|
4183
5635
|
#
|
4184
5636
|
# JOB\_DEFINITION
|
4185
5637
|
#
|
@@ -4188,15 +5640,15 @@ module Aws::Batch
|
|
4188
5640
|
# value. The value is case sensitive. When the value for the filter
|
4189
5641
|
# is the job definition name, the results include all the jobs that
|
4190
5642
|
# used any revision of that job definition name. If the value ends
|
4191
|
-
# with an asterisk (*), the filter
|
4192
|
-
#
|
4193
|
-
#
|
4194
|
-
#
|
4195
|
-
#
|
4196
|
-
#
|
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
|
4197
5649
|
# `arn:$\{Partition\}:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}`),
|
4198
5650
|
# the results include jobs that used the specified revision of the
|
4199
|
-
# job definition. Asterisk (*)
|
5651
|
+
# job definition. Asterisk (*) isn't supported when the ARN is
|
4200
5652
|
# used.
|
4201
5653
|
#
|
4202
5654
|
# BEFORE\_CREATED\_AT
|
@@ -4278,9 +5730,9 @@ module Aws::Batch
|
|
4278
5730
|
# value. This value is `null` when there are no more results to
|
4279
5731
|
# return.
|
4280
5732
|
#
|
4281
|
-
# <note markdown="1">
|
4282
|
-
#
|
4283
|
-
#
|
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.
|
4284
5736
|
#
|
4285
5737
|
# </note>
|
4286
5738
|
# @return [String]
|
@@ -4329,7 +5781,7 @@ module Aws::Batch
|
|
4329
5781
|
# tags are listed for. Batch resources that support tags are compute
|
4330
5782
|
# environments, jobs, job definitions, job queues, and scheduling
|
4331
5783
|
# policies. ARNs for child jobs of array and multi-node parallel (MNP)
|
4332
|
-
# jobs
|
5784
|
+
# jobs aren't supported.
|
4333
5785
|
# @return [String]
|
4334
5786
|
#
|
4335
5787
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListTagsForResourceRequest AWS API Documentation
|
@@ -4372,9 +5824,9 @@ module Aws::Batch
|
|
4372
5824
|
# }
|
4373
5825
|
#
|
4374
5826
|
# @!attribute [rw] log_driver
|
4375
|
-
# The log driver to use for the container. The valid values
|
4376
|
-
# this parameter are log drivers that the Amazon ECS
|
4377
|
-
# 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.
|
4378
5830
|
#
|
4379
5831
|
# The supported log drivers are `awslogs`, `fluentd`, `gelf`,
|
4380
5832
|
# `json-file`, `journald`, `logentries`, `syslog`, and `splunk`.
|
@@ -4393,39 +5845,39 @@ module Aws::Batch
|
|
4393
5845
|
#
|
4394
5846
|
# fluentd
|
4395
5847
|
#
|
4396
|
-
# : Specifies the Fluentd logging driver. For more information
|
5848
|
+
# : Specifies the Fluentd logging driver. For more information
|
4397
5849
|
# including usage and options, see [Fluentd logging driver][3] in
|
4398
|
-
# the Docker documentation
|
5850
|
+
# the *Docker documentation*.
|
4399
5851
|
#
|
4400
5852
|
# gelf
|
4401
5853
|
#
|
4402
5854
|
# : Specifies the Graylog Extended Format (GELF) logging driver. For
|
4403
|
-
# more information
|
4404
|
-
# 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*.
|
4405
5857
|
#
|
4406
5858
|
# journald
|
4407
5859
|
#
|
4408
|
-
# : Specifies the journald logging driver. For more information
|
5860
|
+
# : Specifies the journald logging driver. For more information
|
4409
5861
|
# including usage and options, see [Journald logging driver][5] in
|
4410
|
-
# the Docker documentation
|
5862
|
+
# the *Docker documentation*.
|
4411
5863
|
#
|
4412
5864
|
# json-file
|
4413
5865
|
#
|
4414
|
-
# : Specifies the JSON file logging driver. For more information
|
5866
|
+
# : Specifies the JSON file logging driver. For more information
|
4415
5867
|
# including usage and options, see [JSON File logging driver][6] in
|
4416
|
-
# the Docker documentation
|
5868
|
+
# the *Docker documentation*.
|
4417
5869
|
#
|
4418
5870
|
# splunk
|
4419
5871
|
#
|
4420
|
-
# : Specifies the Splunk logging driver. For more information
|
5872
|
+
# : Specifies the Splunk logging driver. For more information
|
4421
5873
|
# including usage and options, see [Splunk logging driver][7] in the
|
4422
|
-
# Docker documentation
|
5874
|
+
# *Docker documentation*.
|
4423
5875
|
#
|
4424
5876
|
# syslog
|
4425
5877
|
#
|
4426
|
-
# : Specifies the syslog logging driver. For more information
|
5878
|
+
# : Specifies the syslog logging driver. For more information
|
4427
5879
|
# including usage and options, see [Syslog logging driver][8] in the
|
4428
|
-
# Docker documentation
|
5880
|
+
# *Docker documentation*.
|
4429
5881
|
#
|
4430
5882
|
# <note markdown="1"> If you have a custom driver that's not listed earlier that you want
|
4431
5883
|
# to work with the Amazon ECS container agent, you can fork the Amazon
|
@@ -4439,9 +5891,9 @@ module Aws::Batch
|
|
4439
5891
|
#
|
4440
5892
|
# This parameter requires version 1.18 of the Docker Remote API or
|
4441
5893
|
# greater on your container instance. To check the Docker Remote API
|
4442
|
-
# version on your container instance, log
|
4443
|
-
# and run the following command: `sudo docker version | grep
|
4444
|
-
# 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"`
|
4445
5897
|
#
|
4446
5898
|
#
|
4447
5899
|
#
|
@@ -4460,7 +5912,7 @@ module Aws::Batch
|
|
4460
5912
|
# The configuration options to send to the log driver. This parameter
|
4461
5913
|
# requires version 1.19 of the Docker Remote API or greater on your
|
4462
5914
|
# container instance. To check the Docker Remote API version on your
|
4463
|
-
# container instance, log
|
5915
|
+
# container instance, log in to your container instance and run the
|
4464
5916
|
# following command: `sudo docker version | grep "Server API version"`
|
4465
5917
|
# @return [Hash<String,String>]
|
4466
5918
|
#
|
@@ -4483,9 +5935,9 @@ module Aws::Batch
|
|
4483
5935
|
include Aws::Structure
|
4484
5936
|
end
|
4485
5937
|
|
4486
|
-
# Details
|
5938
|
+
# Details for a Docker volume mount point that's used in a job's
|
4487
5939
|
# container properties. This parameter maps to `Volumes` in the [Create
|
4488
|
-
# 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`
|
4489
5941
|
# option to docker run.
|
4490
5942
|
#
|
4491
5943
|
#
|
@@ -4537,12 +5989,13 @@ module Aws::Batch
|
|
4537
5989
|
# }
|
4538
5990
|
#
|
4539
5991
|
# @!attribute [rw] assign_public_ip
|
4540
|
-
# Indicates whether the job
|
4541
|
-
#
|
4542
|
-
#
|
4543
|
-
#
|
4544
|
-
#
|
4545
|
-
#
|
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`".
|
4546
5999
|
#
|
4547
6000
|
#
|
4548
6001
|
#
|
@@ -4557,8 +6010,8 @@ module Aws::Batch
|
|
4557
6010
|
include Aws::Structure
|
4558
6011
|
end
|
4559
6012
|
|
4560
|
-
# An object
|
4561
|
-
# parallel job node.
|
6013
|
+
# An object that represents the elastic network interface for a
|
6014
|
+
# multi-node parallel job node.
|
4562
6015
|
#
|
4563
6016
|
# @!attribute [rw] attachment_id
|
4564
6017
|
# The attachment ID for the network interface.
|
@@ -4582,10 +6035,11 @@ module Aws::Batch
|
|
4582
6035
|
include Aws::Structure
|
4583
6036
|
end
|
4584
6037
|
|
4585
|
-
# An object
|
6038
|
+
# An object that represents the details of a multi-node parallel job
|
6039
|
+
# node.
|
4586
6040
|
#
|
4587
6041
|
# @!attribute [rw] node_index
|
4588
|
-
# The node index for the node. Node index numbering
|
6042
|
+
# The node index for the node. Node index numbering starts at zero.
|
4589
6043
|
# This index is also available on the node with the
|
4590
6044
|
# `AWS_BATCH_JOB_NODE_INDEX` environment variable.
|
4591
6045
|
# @return [Integer]
|
@@ -4604,11 +6058,12 @@ module Aws::Batch
|
|
4604
6058
|
include Aws::Structure
|
4605
6059
|
end
|
4606
6060
|
|
4607
|
-
#
|
4608
|
-
# 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.
|
4609
6063
|
#
|
4610
|
-
# <note markdown="1"> This isn't applicable to jobs that are running on Fargate
|
4611
|
-
#
|
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.
|
4612
6067
|
#
|
4613
6068
|
# </note>
|
4614
6069
|
#
|
@@ -4645,17 +6100,18 @@ module Aws::Batch
|
|
4645
6100
|
# @!attribute [rw] num_nodes
|
4646
6101
|
# The number of nodes to use with a multi-node parallel job. This
|
4647
6102
|
# value overrides the number of nodes that are specified in the job
|
4648
|
-
# definition. To use this override
|
6103
|
+
# definition. To use this override, you must meet the following
|
6104
|
+
# conditions:
|
4649
6105
|
#
|
4650
6106
|
# * There must be at least one node range in your job definition that
|
4651
|
-
# has an open upper boundary
|
6107
|
+
# has an open upper boundary, such as `:` or `n:`.
|
4652
6108
|
#
|
4653
|
-
# * 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
|
4654
6110
|
# definition must be fewer than the number of nodes specified in the
|
4655
6111
|
# override.
|
4656
6112
|
#
|
4657
|
-
# * The main node index specified in the job definition must
|
4658
|
-
# 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.
|
4659
6115
|
# @return [Integer]
|
4660
6116
|
#
|
4661
6117
|
# @!attribute [rw] node_property_overrides
|
@@ -4671,9 +6127,14 @@ module Aws::Batch
|
|
4671
6127
|
include Aws::Structure
|
4672
6128
|
end
|
4673
6129
|
|
4674
|
-
# An object
|
6130
|
+
# An object that represents the node properties of a multi-node parallel
|
4675
6131
|
# job.
|
4676
6132
|
#
|
6133
|
+
# <note markdown="1"> Node properties can't be specified for Amazon EKS based job
|
6134
|
+
# definitions.
|
6135
|
+
#
|
6136
|
+
# </note>
|
6137
|
+
#
|
4677
6138
|
# @note When making an API call, you may pass NodeProperties
|
4678
6139
|
# data as a hash:
|
4679
6140
|
#
|
@@ -4788,7 +6249,8 @@ module Aws::Batch
|
|
4788
6249
|
# }
|
4789
6250
|
#
|
4790
6251
|
# @!attribute [rw] num_nodes
|
4791
|
-
# 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.
|
4792
6254
|
# @return [Integer]
|
4793
6255
|
#
|
4794
6256
|
# @!attribute [rw] main_node
|
@@ -4797,8 +6259,8 @@ module Aws::Batch
|
|
4797
6259
|
# @return [Integer]
|
4798
6260
|
#
|
4799
6261
|
# @!attribute [rw] node_range_properties
|
4800
|
-
# A list of node ranges and their properties associated with
|
4801
|
-
# multi-node parallel job.
|
6262
|
+
# A list of node ranges and their properties that are associated with
|
6263
|
+
# a multi-node parallel job.
|
4802
6264
|
# @return [Array<Types::NodeRangeProperty>]
|
4803
6265
|
#
|
4804
6266
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/NodeProperties AWS API Documentation
|
@@ -4811,7 +6273,7 @@ module Aws::Batch
|
|
4811
6273
|
include Aws::Structure
|
4812
6274
|
end
|
4813
6275
|
|
4814
|
-
# An object
|
6276
|
+
# An object that represents the properties of a node that's associated
|
4815
6277
|
# with a multi-node parallel job.
|
4816
6278
|
#
|
4817
6279
|
# @!attribute [rw] is_main_node
|
@@ -4820,7 +6282,8 @@ module Aws::Batch
|
|
4820
6282
|
# @return [Boolean]
|
4821
6283
|
#
|
4822
6284
|
# @!attribute [rw] num_nodes
|
4823
|
-
# 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.
|
4824
6287
|
# @return [Integer]
|
4825
6288
|
#
|
4826
6289
|
# @!attribute [rw] node_index
|
@@ -4839,8 +6302,8 @@ module Aws::Batch
|
|
4839
6302
|
include Aws::Structure
|
4840
6303
|
end
|
4841
6304
|
|
4842
|
-
#
|
4843
|
-
# 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.
|
4844
6307
|
#
|
4845
6308
|
# @note When making an API call, you may pass NodePropertyOverride
|
4846
6309
|
# data as a hash:
|
@@ -4877,7 +6340,7 @@ module Aws::Batch
|
|
4877
6340
|
# @return [String]
|
4878
6341
|
#
|
4879
6342
|
# @!attribute [rw] container_overrides
|
4880
|
-
# The overrides that
|
6343
|
+
# The overrides that are sent to a node range.
|
4881
6344
|
# @return [Types::ContainerOverrides]
|
4882
6345
|
#
|
4883
6346
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/NodePropertyOverride AWS API Documentation
|
@@ -4889,7 +6352,7 @@ module Aws::Batch
|
|
4889
6352
|
include Aws::Structure
|
4890
6353
|
end
|
4891
6354
|
|
4892
|
-
# An object
|
6355
|
+
# An object that represents the properties of the node range for a
|
4893
6356
|
# multi-node parallel job.
|
4894
6357
|
#
|
4895
6358
|
# @note When making an API call, you may pass NodeRangeProperty
|
@@ -5006,7 +6469,7 @@ module Aws::Batch
|
|
5006
6469
|
# the range. If the ending range value is omitted (`n:`), then the
|
5007
6470
|
# highest possible node index is used to end the range. Your
|
5008
6471
|
# accumulative node ranges must account for all nodes (`0:n`). You can
|
5009
|
-
# nest node ranges
|
6472
|
+
# nest node ranges (for example, `0:10` and `4:5`). In this case, the
|
5010
6473
|
# `4:5` range properties override the `0:10` properties.
|
5011
6474
|
# @return [String]
|
5012
6475
|
#
|
@@ -5263,6 +6726,66 @@ module Aws::Batch
|
|
5263
6726
|
# "TagKey" => "TagValue",
|
5264
6727
|
# },
|
5265
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
|
+
# },
|
5266
6789
|
# }
|
5267
6790
|
#
|
5268
6791
|
# @!attribute [rw] job_definition_name
|
@@ -5295,19 +6818,20 @@ module Aws::Batch
|
|
5295
6818
|
#
|
5296
6819
|
# @!attribute [rw] scheduling_priority
|
5297
6820
|
# The scheduling priority for jobs that are submitted with this job
|
5298
|
-
# definition. This
|
5299
|
-
#
|
5300
|
-
#
|
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.
|
5301
6824
|
#
|
5302
6825
|
# The minimum supported value is 0 and the maximum supported value is
|
5303
6826
|
# 9999.
|
5304
6827
|
# @return [Integer]
|
5305
6828
|
#
|
5306
6829
|
# @!attribute [rw] container_properties
|
5307
|
-
# An object with various properties specific to
|
5308
|
-
# container-based jobs. If the job definition's `type`
|
5309
|
-
# `container`, then you must specify either
|
5310
|
-
# `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.
|
5311
6835
|
#
|
5312
6836
|
# <note markdown="1"> If the job runs on Fargate resources, then you must not specify
|
5313
6837
|
# `nodeProperties`; use only `containerProperties`.
|
@@ -5328,6 +6852,11 @@ module Aws::Batch
|
|
5328
6852
|
#
|
5329
6853
|
# </note>
|
5330
6854
|
#
|
6855
|
+
# <note markdown="1"> If the job runs on Amazon EKS resources, then you must not specify
|
6856
|
+
# `nodeProperties`.
|
6857
|
+
#
|
6858
|
+
# </note>
|
6859
|
+
#
|
5331
6860
|
#
|
5332
6861
|
#
|
5333
6862
|
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html
|
@@ -5348,6 +6877,11 @@ module Aws::Batch
|
|
5348
6877
|
# tags are given priority over job definitions tags. If the total
|
5349
6878
|
# number of combined tags from the job and job definition is over 50,
|
5350
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>
|
5351
6885
|
# @return [Boolean]
|
5352
6886
|
#
|
5353
6887
|
# @!attribute [rw] timeout
|
@@ -5379,8 +6913,19 @@ module Aws::Batch
|
|
5379
6913
|
# The platform capabilities required by the job definition. If no
|
5380
6914
|
# value is specified, it defaults to `EC2`. To run the job on Fargate
|
5381
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>
|
5382
6921
|
# @return [Array<String>]
|
5383
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
|
+
#
|
5384
6929
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RegisterJobDefinitionRequest AWS API Documentation
|
5385
6930
|
#
|
5386
6931
|
class RegisterJobDefinitionRequest < Struct.new(
|
@@ -5394,7 +6939,8 @@ module Aws::Batch
|
|
5394
6939
|
:propagate_tags,
|
5395
6940
|
:timeout,
|
5396
6941
|
:tags,
|
5397
|
-
:platform_capabilities
|
6942
|
+
:platform_capabilities,
|
6943
|
+
:eks_properties)
|
5398
6944
|
SENSITIVE = []
|
5399
6945
|
include Aws::Structure
|
5400
6946
|
end
|
@@ -5438,12 +6984,12 @@ module Aws::Batch
|
|
5438
6984
|
#
|
5439
6985
|
# type="GPU"
|
5440
6986
|
#
|
5441
|
-
# : The number of physical GPUs to reserve for the container.
|
5442
|
-
# number of GPUs reserved for all containers in a job
|
5443
|
-
# exceed the number of available GPUs on the compute
|
5444
|
-
# 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.
|
5445
6991
|
#
|
5446
|
-
# <note markdown="1"> GPUs
|
6992
|
+
# <note markdown="1"> GPUs aren't available for jobs that are running on Fargate
|
5447
6993
|
# resources.
|
5448
6994
|
#
|
5449
6995
|
# </note>
|
@@ -5570,8 +7116,8 @@ module Aws::Batch
|
|
5570
7116
|
include Aws::Structure
|
5571
7117
|
end
|
5572
7118
|
|
5573
|
-
# The retry strategy associated with a job. For more
|
5574
|
-
# [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*.
|
5575
7121
|
#
|
5576
7122
|
#
|
5577
7123
|
#
|
@@ -5600,9 +7146,10 @@ module Aws::Batch
|
|
5600
7146
|
# @return [Integer]
|
5601
7147
|
#
|
5602
7148
|
# @!attribute [rw] evaluate_on_exit
|
5603
|
-
# Array of up to 5 objects that specify conditions
|
5604
|
-
#
|
5605
|
-
#
|
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.
|
5606
7153
|
# @return [Array<Types::EvaluateOnExit>]
|
5607
7154
|
#
|
5608
7155
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RetryStrategy AWS API Documentation
|
@@ -5668,8 +7215,8 @@ module Aws::Batch
|
|
5668
7215
|
include Aws::Structure
|
5669
7216
|
end
|
5670
7217
|
|
5671
|
-
# An object
|
5672
|
-
# 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:
|
5673
7220
|
#
|
5674
7221
|
# * To inject sensitive data into your containers as environment
|
5675
7222
|
# variables, use the `secrets` container definition parameter.
|
@@ -5698,14 +7245,15 @@ module Aws::Batch
|
|
5698
7245
|
#
|
5699
7246
|
# @!attribute [rw] value_from
|
5700
7247
|
# The secret to expose to the container. The supported values are
|
5701
|
-
# either the full ARN of the Secrets Manager
|
5702
|
-
# the parameter in the Amazon Web Services
|
5703
|
-
# 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.
|
5704
7251
|
#
|
5705
7252
|
# <note markdown="1"> If the Amazon Web Services Systems Manager Parameter Store parameter
|
5706
7253
|
# exists in the same Region as the job you're launching, then you can
|
5707
|
-
# use either the full ARN or name of the
|
5708
|
-
# 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.
|
5709
7257
|
#
|
5710
7258
|
# </note>
|
5711
7259
|
# @return [String]
|
@@ -5749,14 +7297,14 @@ module Aws::Batch
|
|
5749
7297
|
# string ends with an asterisk (*), this entry specifies the weight
|
5750
7298
|
# factor to use for fair share identifiers that start with that
|
5751
7299
|
# prefix. The list of fair share identifiers in a fair share policy
|
5752
|
-
#
|
7300
|
+
# can't overlap. For example, you can't have one that specifies a
|
5753
7301
|
# `shareIdentifier` of `UserA*` and another that specifies a
|
5754
7302
|
# `shareIdentifier` of `UserA-1`.
|
5755
7303
|
#
|
5756
7304
|
# There can be no more than 500 fair share identifiers active in a job
|
5757
7305
|
# queue.
|
5758
7306
|
#
|
5759
|
-
# The string is limited to 255 alphanumeric characters,
|
7307
|
+
# The string is limited to 255 alphanumeric characters, and can be
|
5760
7308
|
# followed by an asterisk (*).
|
5761
7309
|
# @return [String]
|
5762
7310
|
#
|
@@ -5865,6 +7413,31 @@ module Aws::Batch
|
|
5865
7413
|
# tags: {
|
5866
7414
|
# "TagKey" => "TagValue",
|
5867
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
|
+
# },
|
5868
7441
|
# }
|
5869
7442
|
#
|
5870
7443
|
# @!attribute [rw] job_name
|
@@ -5879,15 +7452,17 @@ module Aws::Batch
|
|
5879
7452
|
# @return [String]
|
5880
7453
|
#
|
5881
7454
|
# @!attribute [rw] share_identifier
|
5882
|
-
# The share identifier for the job.
|
7455
|
+
# The share identifier for the job. If the job queue doesn't have a
|
7456
|
+
# scheduling policy, then this parameter must not be specified. If the
|
7457
|
+
# job queue has a scheduling policy, then this parameter must be
|
7458
|
+
# specified.
|
5883
7459
|
# @return [String]
|
5884
7460
|
#
|
5885
7461
|
# @!attribute [rw] scheduling_priority_override
|
5886
|
-
# The scheduling priority for the job. This
|
5887
|
-
#
|
5888
|
-
# priority
|
5889
|
-
#
|
5890
|
-
# 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.
|
5891
7466
|
#
|
5892
7467
|
# The minimum supported value is 0 and the maximum supported value is
|
5893
7468
|
# 9999.
|
@@ -5930,13 +7505,13 @@ module Aws::Batch
|
|
5930
7505
|
# @return [Hash<String,String>]
|
5931
7506
|
#
|
5932
7507
|
# @!attribute [rw] container_overrides
|
5933
|
-
#
|
5934
|
-
# name of a container in the specified
|
5935
|
-
# overrides it
|
5936
|
-
# container, which is specified in the job
|
5937
|
-
# image, with a `command` override. You can
|
5938
|
-
# environment variables on a container or add
|
5939
|
-
# 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.
|
5940
7515
|
# @return [Types::ContainerOverrides]
|
5941
7516
|
#
|
5942
7517
|
# @!attribute [rw] node_overrides
|
@@ -5993,6 +7568,12 @@ module Aws::Batch
|
|
5993
7568
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
5994
7569
|
# @return [Hash<String,String>]
|
5995
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
|
+
#
|
5996
7577
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/SubmitJobRequest AWS API Documentation
|
5997
7578
|
#
|
5998
7579
|
class SubmitJobRequest < Struct.new(
|
@@ -6009,7 +7590,8 @@ module Aws::Batch
|
|
6009
7590
|
:retry_strategy,
|
6010
7591
|
:propagate_tags,
|
6011
7592
|
:timeout,
|
6012
|
-
:tags
|
7593
|
+
:tags,
|
7594
|
+
:eks_properties_override)
|
6013
7595
|
SENSITIVE = []
|
6014
7596
|
include Aws::Structure
|
6015
7597
|
end
|
@@ -6052,7 +7634,7 @@ module Aws::Batch
|
|
6052
7634
|
# The Amazon Resource Name (ARN) of the resource that tags are added
|
6053
7635
|
# to. Batch resources that support tags are compute environments,
|
6054
7636
|
# jobs, job definitions, job queues, and scheduling policies. ARNs for
|
6055
|
-
# child jobs of array and multi-node parallel (MNP) jobs
|
7637
|
+
# child jobs of array and multi-node parallel (MNP) jobs aren't
|
6056
7638
|
# supported.
|
6057
7639
|
# @return [String]
|
6058
7640
|
#
|
@@ -6114,7 +7696,7 @@ module Aws::Batch
|
|
6114
7696
|
#
|
6115
7697
|
class TerminateJobResponse < Aws::EmptyStructure; end
|
6116
7698
|
|
6117
|
-
# The container path, mount options, and size of the tmpfs mount.
|
7699
|
+
# The container path, mount options, and size of the `tmpfs` mount.
|
6118
7700
|
#
|
6119
7701
|
# <note markdown="1"> This object isn't applicable to jobs that are running on Fargate
|
6120
7702
|
# resources.
|
@@ -6131,16 +7713,16 @@ module Aws::Batch
|
|
6131
7713
|
# }
|
6132
7714
|
#
|
6133
7715
|
# @!attribute [rw] container_path
|
6134
|
-
# 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
|
6135
7717
|
# mounted.
|
6136
7718
|
# @return [String]
|
6137
7719
|
#
|
6138
7720
|
# @!attribute [rw] size
|
6139
|
-
# The size (in MiB) of the tmpfs volume.
|
7721
|
+
# The size (in MiB) of the `tmpfs` volume.
|
6140
7722
|
# @return [Integer]
|
6141
7723
|
#
|
6142
7724
|
# @!attribute [rw] mount_options
|
6143
|
-
# The list of tmpfs volume mount options.
|
7725
|
+
# The list of `tmpfs` volume mount options.
|
6144
7726
|
#
|
6145
7727
|
# Valid values: "`defaults`" \| "`ro`" \| "`rw`" \| "`suid`"
|
6146
7728
|
# \| "`nosuid`" \| "`dev`" \| "`nodev`" \| "`exec`" \|
|
@@ -6216,7 +7798,7 @@ module Aws::Batch
|
|
6216
7798
|
# The Amazon Resource Name (ARN) of the resource from which to delete
|
6217
7799
|
# tags. Batch resources that support tags are compute environments,
|
6218
7800
|
# jobs, job definitions, job queues, and scheduling policies. ARNs for
|
6219
|
-
# child jobs of array and multi-node parallel (MNP) jobs
|
7801
|
+
# child jobs of array and multi-node parallel (MNP) jobs aren't
|
6220
7802
|
# supported.
|
6221
7803
|
# @return [String]
|
6222
7804
|
#
|
@@ -6270,6 +7852,7 @@ module Aws::Batch
|
|
6270
7852
|
# {
|
6271
7853
|
# image_type: "ImageType", # required
|
6272
7854
|
# image_id_override: "ImageIdOverride",
|
7855
|
+
# image_kubernetes_version: "KubernetesVersion",
|
6273
7856
|
# },
|
6274
7857
|
# ],
|
6275
7858
|
# update_to_latest_image_version: false,
|
@@ -6308,11 +7891,11 @@ module Aws::Batch
|
|
6308
7891
|
#
|
6309
7892
|
# @!attribute [rw] unmanagedv_cpus
|
6310
7893
|
# The maximum number of vCPUs expected to be used for an unmanaged
|
6311
|
-
# compute environment.
|
7894
|
+
# compute environment. Don't specify this parameter for a managed
|
6312
7895
|
# compute environment. This parameter is only used for fair share
|
6313
7896
|
# scheduling to reserve vCPU capacity for new share identifiers. If
|
6314
|
-
# this parameter
|
6315
|
-
# capacity
|
7897
|
+
# this parameter isn't provided for a fair share job queue, no vCPU
|
7898
|
+
# capacity is reserved.
|
6316
7899
|
# @return [Integer]
|
6317
7900
|
#
|
6318
7901
|
# @!attribute [rw] compute_resources
|
@@ -6383,7 +7966,7 @@ module Aws::Batch
|
|
6383
7966
|
end
|
6384
7967
|
|
6385
7968
|
# @!attribute [rw] compute_environment_name
|
6386
|
-
# 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
|
6387
7970
|
# long. It can contain uppercase and lowercase letters, numbers,
|
6388
7971
|
# hyphens (-), and underscores (\_).
|
6389
7972
|
# @return [String]
|
@@ -6436,7 +8019,7 @@ module Aws::Batch
|
|
6436
8019
|
# replaced but not removed. The format is
|
6437
8020
|
# `aws:Partition:batch:Region:Account:scheduling-policy/Name `. For
|
6438
8021
|
# example,
|
6439
|
-
# `aws:aws:batch:us-west-2:
|
8022
|
+
# `aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`.
|
6440
8023
|
# @return [String]
|
6441
8024
|
#
|
6442
8025
|
# @!attribute [rw] priority
|
@@ -6520,7 +8103,7 @@ module Aws::Batch
|
|
6520
8103
|
# @return [Boolean]
|
6521
8104
|
#
|
6522
8105
|
# @!attribute [rw] job_execution_timeout_minutes
|
6523
|
-
# Specifies the job timeout
|
8106
|
+
# Specifies the job timeout (in minutes) when the compute environment
|
6524
8107
|
# infrastructure is updated. The default value is 30.
|
6525
8108
|
# @return [Integer]
|
6526
8109
|
#
|
@@ -6573,7 +8156,7 @@ module Aws::Batch
|
|
6573
8156
|
#
|
6574
8157
|
class UpdateSchedulingPolicyResponse < Aws::EmptyStructure; end
|
6575
8158
|
|
6576
|
-
# A data volume used in a job's container properties.
|
8159
|
+
# A data volume that's used in a job's container properties.
|
6577
8160
|
#
|
6578
8161
|
# @note When making an API call, you may pass Volume
|
6579
8162
|
# data as a hash:
|
@@ -6597,11 +8180,11 @@ module Aws::Batch
|
|
6597
8180
|
#
|
6598
8181
|
# @!attribute [rw] host
|
6599
8182
|
# The contents of the `host` parameter determine whether your data
|
6600
|
-
# volume persists on the host container instance and where it
|
8183
|
+
# volume persists on the host container instance and where it's
|
6601
8184
|
# stored. If the host parameter is empty, then the Docker daemon
|
6602
8185
|
# assigns a host path for your data volume. However, the data isn't
|
6603
|
-
# guaranteed to persist after the containers associated with
|
6604
|
-
# running.
|
8186
|
+
# guaranteed to persist after the containers that are associated with
|
8187
|
+
# it stop running.
|
6605
8188
|
#
|
6606
8189
|
# <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
|
6607
8190
|
# resources and shouldn't be provided.
|
@@ -6610,14 +8193,14 @@ module Aws::Batch
|
|
6610
8193
|
# @return [Types::Host]
|
6611
8194
|
#
|
6612
8195
|
# @!attribute [rw] name
|
6613
|
-
# 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
|
6614
8197
|
# contain uppercase and lowercase letters, numbers, hyphens (-), and
|
6615
8198
|
# underscores (\_). This name is referenced in the `sourceVolume`
|
6616
8199
|
# parameter of container definition `mountPoints`.
|
6617
8200
|
# @return [String]
|
6618
8201
|
#
|
6619
8202
|
# @!attribute [rw] efs_volume_configuration
|
6620
|
-
# This parameter is specified when you
|
8203
|
+
# This parameter is specified when you're using an Amazon Elastic
|
6621
8204
|
# File System file system for job storage. Jobs that are running on
|
6622
8205
|
# Fargate resources must specify a `platformVersion` of at least
|
6623
8206
|
# `1.4.0`.
|