@aws-sdk/client-batch 3.379.1 → 3.385.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.
@@ -18,6 +18,7 @@ export type ArrayJobDependency = (typeof ArrayJobDependency)[keyof typeof ArrayJ
18
18
  */
19
19
  export interface ArrayProperties {
20
20
  /**
21
+ * @public
21
22
  * <p>The size of the array job.</p>
22
23
  */
23
24
  size?: number;
@@ -28,15 +29,18 @@ export interface ArrayProperties {
28
29
  */
29
30
  export interface ArrayPropertiesDetail {
30
31
  /**
32
+ * @public
31
33
  * <p>A summary of the number of array job children in each available job status. This parameter
32
34
  * is returned for parent array jobs.</p>
33
35
  */
34
36
  statusSummary?: Record<string, number>;
35
37
  /**
38
+ * @public
36
39
  * <p>The size of the array job. This parameter is returned for parent array jobs.</p>
37
40
  */
38
41
  size?: number;
39
42
  /**
43
+ * @public
40
44
  * <p>The job index within the array that's associated with this job. This parameter is returned
41
45
  * for array job children.</p>
42
46
  */
@@ -48,10 +52,12 @@ export interface ArrayPropertiesDetail {
48
52
  */
49
53
  export interface ArrayPropertiesSummary {
50
54
  /**
55
+ * @public
51
56
  * <p>The size of the array job. This parameter is returned for parent array jobs.</p>
52
57
  */
53
58
  size?: number;
54
59
  /**
60
+ * @public
55
61
  * <p>The job index within the array that's associated with this job. This parameter is returned
56
62
  * for children of array jobs.</p>
57
63
  */
@@ -76,14 +82,17 @@ export type AssignPublicIp = (typeof AssignPublicIp)[keyof typeof AssignPublicIp
76
82
  */
77
83
  export interface NetworkInterface {
78
84
  /**
85
+ * @public
79
86
  * <p>The attachment ID for the network interface.</p>
80
87
  */
81
88
  attachmentId?: string;
82
89
  /**
90
+ * @public
83
91
  * <p>The private IPv6 address for the network interface.</p>
84
92
  */
85
93
  ipv6Address?: string;
86
94
  /**
95
+ * @public
87
96
  * <p>The private IPv4 address for the network interface.</p>
88
97
  */
89
98
  privateIpv4Address?: string;
@@ -94,30 +103,36 @@ export interface NetworkInterface {
94
103
  */
95
104
  export interface AttemptContainerDetail {
96
105
  /**
106
+ * @public
97
107
  * <p>The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.</p>
98
108
  */
99
109
  containerInstanceArn?: string;
100
110
  /**
111
+ * @public
101
112
  * <p>The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container
102
113
  * attempt receives a task ARN when they reach the <code>STARTING</code> status.</p>
103
114
  */
104
115
  taskArn?: string;
105
116
  /**
117
+ * @public
106
118
  * <p>The exit code for the job attempt. A non-zero exit code is considered failed.</p>
107
119
  */
108
120
  exitCode?: number;
109
121
  /**
122
+ * @public
110
123
  * <p>A short (255 max characters) human-readable string to provide additional details for a
111
124
  * running or stopped container.</p>
112
125
  */
113
126
  reason?: string;
114
127
  /**
128
+ * @public
115
129
  * <p>The name of the CloudWatch Logs log stream that's associated with the container. The log
116
130
  * group for Batch jobs is <code>/aws/batch/job</code>. Each container attempt receives a log
117
131
  * stream name when they reach the <code>RUNNING</code> status.</p>
118
132
  */
119
133
  logStreamName?: string;
120
134
  /**
135
+ * @public
121
136
  * <p>The network interfaces that are associated with the job attempt.</p>
122
137
  */
123
138
  networkInterfaces?: NetworkInterface[];
@@ -128,21 +143,25 @@ export interface AttemptContainerDetail {
128
143
  */
129
144
  export interface AttemptDetail {
130
145
  /**
146
+ * @public
131
147
  * <p>The details for the container in this job attempt.</p>
132
148
  */
133
149
  container?: AttemptContainerDetail;
134
150
  /**
151
+ * @public
135
152
  * <p>The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt
136
153
  * transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>
137
154
  */
138
155
  startedAt?: number;
139
156
  /**
157
+ * @public
140
158
  * <p>The Unix timestamp (in milliseconds) for when the attempt was stopped (when the attempt
141
159
  * transitioned from the <code>RUNNING</code> state to a terminal state, such as
142
160
  * <code>SUCCEEDED</code> or <code>FAILED</code>).</p>
143
161
  */
144
162
  stoppedAt?: number;
145
163
  /**
164
+ * @public
146
165
  * <p>A short, human-readable string to provide additional details for the current status of the
147
166
  * job attempt.</p>
148
167
  */
@@ -154,10 +173,12 @@ export interface AttemptDetail {
154
173
  */
155
174
  export interface CancelJobRequest {
156
175
  /**
176
+ * @public
157
177
  * <p>The Batch job ID of the job to cancel.</p>
158
178
  */
159
179
  jobId: string | undefined;
160
180
  /**
181
+ * @public
161
182
  * <p>A message to attach to the job that explains the reason for canceling it. This message is returned by future
162
183
  * <a>DescribeJobs</a> operations on the job. This message is also recorded in the Batch activity
163
184
  * logs.</p>
@@ -203,6 +224,7 @@ export declare const CRAllocationStrategy: {
203
224
  readonly BEST_FIT: "BEST_FIT";
204
225
  readonly BEST_FIT_PROGRESSIVE: "BEST_FIT_PROGRESSIVE";
205
226
  readonly SPOT_CAPACITY_OPTIMIZED: "SPOT_CAPACITY_OPTIMIZED";
227
+ readonly SPOT_PRICE_CAPACITY_OPTIMIZED: "SPOT_PRICE_CAPACITY_OPTIMIZED";
206
228
  };
207
229
  /**
208
230
  * @public
@@ -219,6 +241,7 @@ export type CRAllocationStrategy = (typeof CRAllocationStrategy)[keyof typeof CR
219
241
  */
220
242
  export interface Ec2Configuration {
221
243
  /**
244
+ * @public
222
245
  * <p>The image type to match with the instance type to select an AMI. The supported values are
223
246
  * different for <code>ECS</code> and <code>EKS</code> resources.</p>
224
247
  * <dl>
@@ -277,6 +300,7 @@ export interface Ec2Configuration {
277
300
  */
278
301
  imageType: string | undefined;
279
302
  /**
303
+ * @public
280
304
  * <p>The AMI ID used for instances launched in the compute environment that match the image type.
281
305
  * This setting overrides the <code>imageId</code> set in the <code>computeResource</code>
282
306
  * object.</p>
@@ -291,6 +315,7 @@ export interface Ec2Configuration {
291
315
  */
292
316
  imageIdOverride?: string;
293
317
  /**
318
+ * @public
294
319
  * <p>The Kubernetes version for the compute environment. If you don't specify a value, the latest
295
320
  * version that Batch supports is used.</p>
296
321
  */
@@ -311,14 +336,17 @@ export interface Ec2Configuration {
311
336
  */
312
337
  export interface LaunchTemplateSpecification {
313
338
  /**
339
+ * @public
314
340
  * <p>The ID of the launch template.</p>
315
341
  */
316
342
  launchTemplateId?: string;
317
343
  /**
344
+ * @public
318
345
  * <p>The name of the launch template.</p>
319
346
  */
320
347
  launchTemplateName?: string;
321
348
  /**
349
+ * @public
322
350
  * <p>The version number of the launch template, <code>$Latest</code>, or
323
351
  * <code>$Default</code>.</p>
324
352
  * <p>If the value is <code>$Latest</code>, the latest version of the launch template is used. If
@@ -360,6 +388,7 @@ export type CRType = (typeof CRType)[keyof typeof CRType];
360
388
  */
361
389
  export interface ComputeResource {
362
390
  /**
391
+ * @public
363
392
  * <p>The type of compute environment: <code>EC2</code>, <code>SPOT</code>, <code>FARGATE</code>,
364
393
  * or <code>FARGATE_SPOT</code>. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute environments</a> in the
365
394
  * <i>Batch User Guide</i>.</p>
@@ -369,6 +398,7 @@ export interface ComputeResource {
369
398
  */
370
399
  type: CRType | string | undefined;
371
400
  /**
401
+ * @public
372
402
  * <p>The allocation strategy to use for the compute resource if not enough instances of the best
373
403
  * fitting instance type can be allocated. This might be because of availability of the instance
374
404
  * type in the Region or <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html">Amazon EC2 service limits</a>. For more
@@ -404,14 +434,22 @@ export interface ComputeResource {
404
434
  * interrupted. This allocation strategy is only available for Spot Instance compute
405
435
  * resources.</p>
406
436
  * </dd>
437
+ * <dt>SPOT_PRICE_CAPACITY_OPTIMIZED</dt>
438
+ * <dd>
439
+ * <p>The price and capacity optimized allocation strategy looks at both price and capacity to
440
+ * select the Spot Instance pools that are the least likely to be interrupted and have the lowest
441
+ * possible price. This allocation strategy is only available for Spot Instance compute
442
+ * resources.</p>
443
+ * </dd>
407
444
  * </dl>
408
- * <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code>
445
+ * <p>With <code>BEST_FIT_PROGRESSIVE</code>,<code>SPOT_CAPACITY_OPTIMIZED</code> and <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
409
446
  * strategies using On-Demand or Spot Instances, and the <code>BEST_FIT</code> strategy using Spot
410
447
  * Instances, Batch might need to exceed <code>maxvCpus</code> to meet your capacity requirements.
411
448
  * In this event, Batch never exceeds <code>maxvCpus</code> by more than a single instance.</p>
412
449
  */
413
450
  allocationStrategy?: CRAllocationStrategy | string;
414
451
  /**
452
+ * @public
415
453
  * <p>The minimum number of
416
454
  * vCPUs that
417
455
  * a
@@ -423,12 +461,13 @@ export interface ComputeResource {
423
461
  */
424
462
  minvCpus?: number;
425
463
  /**
464
+ * @public
426
465
  * <p>The maximum number of
427
466
  * vCPUs that a
428
467
  * compute environment can
429
468
  * support.</p>
430
469
  * <note>
431
- * <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code>
470
+ * <p>With <code>BEST_FIT_PROGRESSIVE</code>, <code>SPOT_CAPACITY_OPTIMIZED</code> and <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
432
471
  * allocation strategies using On-Demand or Spot Instances, and the <code>BEST_FIT</code> strategy
433
472
  * using Spot Instances, Batch might need to exceed <code>maxvCpus</code> to meet your capacity
434
473
  * requirements. In this event, Batch never exceeds <code>maxvCpus</code> by more than a single
@@ -438,6 +477,7 @@ export interface ComputeResource {
438
477
  */
439
478
  maxvCpus: number | undefined;
440
479
  /**
480
+ * @public
441
481
  * <p>The desired number of
442
482
  * vCPUS in the
443
483
  * compute environment. Batch modifies this value between the minimum and maximum values based on
@@ -448,6 +488,7 @@ export interface ComputeResource {
448
488
  */
449
489
  desiredvCpus?: number;
450
490
  /**
491
+ * @public
451
492
  * <p>The instances types that can be launched. You can specify instance families to launch any
452
493
  * instance type within those families (for example, <code>c5</code> or <code>p3</code>), or you can
453
494
  * specify specific sizes within a family (such as <code>c5.8xlarge</code>). You can also choose
@@ -469,6 +510,7 @@ export interface ComputeResource {
469
510
  */
470
511
  instanceTypes?: string[];
471
512
  /**
513
+ * @public
472
514
  * @deprecated
473
515
  *
474
516
  * <p>The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
@@ -488,6 +530,7 @@ export interface ComputeResource {
488
530
  */
489
531
  imageId?: string;
490
532
  /**
533
+ * @public
491
534
  * <p>The VPC subnets where the compute resources are launched. These subnets must be within the
492
535
  * same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see
493
536
  * <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">VPCs and subnets</a>
@@ -503,6 +546,7 @@ export interface ComputeResource {
503
546
  */
504
547
  subnets: string[] | undefined;
505
548
  /**
549
+ * @public
506
550
  * <p>The Amazon EC2 security groups that are associated with instances launched in the compute
507
551
  * environment. One or more security groups must be specified, either in
508
552
  * <code>securityGroupIds</code> or using a launch template referenced in
@@ -513,6 +557,7 @@ export interface ComputeResource {
513
557
  */
514
558
  securityGroupIds?: string[];
515
559
  /**
560
+ * @public
516
561
  * <p>The Amazon EC2 key pair that's used for instances launched in the compute environment. You can
517
562
  * use this key pair to log in to your instances with SSH.</p>
518
563
  * <note>
@@ -521,6 +566,7 @@ export interface ComputeResource {
521
566
  */
522
567
  ec2KeyPair?: string;
523
568
  /**
569
+ * @public
524
570
  * <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can
525
571
  * specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example,
526
572
  * <code>
@@ -535,6 +581,7 @@ export interface ComputeResource {
535
581
  */
536
582
  instanceRole?: string;
537
583
  /**
584
+ * @public
538
585
  * <p>Key-value pair tags to be applied to EC2 resources that are launched in the compute
539
586
  * environment. For Batch, these take the form of <code>"String1": "String2"</code>, where
540
587
  * <code>String1</code> is the tag key and <code>String2</code> is the tag value-for example,
@@ -549,6 +596,7 @@ export interface ComputeResource {
549
596
  */
550
597
  tags?: Record<string, string>;
551
598
  /**
599
+ * @public
552
600
  * <p>The Amazon EC2 placement group to associate with your compute resources. If you intend to submit
553
601
  * multi-node parallel jobs to your compute environment, you should consider creating a cluster
554
602
  * placement group and associate it with your compute resources. This keeps your multi-node parallel
@@ -561,6 +609,7 @@ export interface ComputeResource {
561
609
  */
562
610
  placementGroup?: string;
563
611
  /**
612
+ * @public
564
613
  * <p>The maximum percentage that a Spot Instance price can be when compared with the On-Demand
565
614
  * price for that instance type before instances are launched. For example, if your maximum
566
615
  * percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for
@@ -574,6 +623,7 @@ export interface ComputeResource {
574
623
  */
575
624
  bidPercentage?: number;
576
625
  /**
626
+ * @public
577
627
  * <p>The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a <code>SPOT</code> compute
578
628
  * environment. This role is required if the allocation strategy set to <code>BEST_FIT</code> or if
579
629
  * the allocation strategy isn't specified. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html">Amazon EC2 spot fleet role</a> in the
@@ -591,6 +641,7 @@ export interface ComputeResource {
591
641
  */
592
642
  spotIamFleetRole?: string;
593
643
  /**
644
+ * @public
594
645
  * <p>The launch template to use for your compute resources. Any other compute resource parameters
595
646
  * that you specify in a <a>CreateComputeEnvironment</a> API operation override the same
596
647
  * parameters in the launch template. You must specify either the launch template ID or launch
@@ -602,6 +653,7 @@ export interface ComputeResource {
602
653
  */
603
654
  launchTemplate?: LaunchTemplateSpecification;
604
655
  /**
656
+ * @public
605
657
  * <p>Provides information that's used to select Amazon Machine Images (AMIs) for EC2 instances in
606
658
  * the compute environment. If <code>Ec2Configuration</code> isn't specified, the default is
607
659
  * <code>ECS_AL2</code>.</p>
@@ -619,6 +671,7 @@ export interface ComputeResource {
619
671
  */
620
672
  export interface EksConfiguration {
621
673
  /**
674
+ * @public
622
675
  * <p>The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is
623
676
  * <code>arn:<i>aws</i>:eks:<i>us-east-1</i>:<i>123456789012</i>:cluster/<i>ClusterForBatch</i>
624
677
  * </code>.
@@ -626,6 +679,7 @@ export interface EksConfiguration {
626
679
  */
627
680
  eksClusterArn: string | undefined;
628
681
  /**
682
+ * @public
629
683
  * <p>The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. The value
630
684
  * can't left empty or null. It must be fewer than 64 characters long, can't be set to
631
685
  * <code>default</code>, can't start with "<code>kube-</code>," and must match this regular
@@ -663,17 +717,20 @@ export type CEType = (typeof CEType)[keyof typeof CEType];
663
717
  */
664
718
  export interface CreateComputeEnvironmentRequest {
665
719
  /**
720
+ * @public
666
721
  * <p>The name for your compute environment. It can be up to 128 characters long. It can contain uppercase and
667
722
  * lowercase letters, numbers, hyphens (-), and underscores (_).</p>
668
723
  */
669
724
  computeEnvironmentName: string | undefined;
670
725
  /**
726
+ * @public
671
727
  * <p>The type of the compute environment: <code>MANAGED</code> or <code>UNMANAGED</code>. For more information, see
672
728
  * <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute Environments</a> in the
673
729
  * <i>Batch User Guide</i>.</p>
674
730
  */
675
731
  type: CEType | string | undefined;
676
732
  /**
733
+ * @public
677
734
  * <p>The state of the compute environment. If the state is <code>ENABLED</code>, then the
678
735
  * compute environment accepts jobs from a queue and can scale out automatically based on
679
736
  * queues.</p>
@@ -698,6 +755,7 @@ export interface CreateComputeEnvironmentRequest {
698
755
  */
699
756
  state?: CEState | string;
700
757
  /**
758
+ * @public
701
759
  * <p>The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair share
702
760
  * scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job
703
761
  * queue, no vCPU capacity is reserved.</p>
@@ -707,11 +765,13 @@ export interface CreateComputeEnvironmentRequest {
707
765
  */
708
766
  unmanagedvCpus?: number;
709
767
  /**
768
+ * @public
710
769
  * <p>Details about the compute resources managed by the compute environment. This parameter is required for managed
711
770
  * compute environments. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute Environments</a> in the <i>Batch User Guide</i>.</p>
712
771
  */
713
772
  computeResources?: ComputeResource;
714
773
  /**
774
+ * @public
715
775
  * <p>The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For
716
776
  * more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM
717
777
  * role</a> in the <i>Batch User Guide</i>.</p>
@@ -734,6 +794,7 @@ export interface CreateComputeEnvironmentRequest {
734
794
  */
735
795
  serviceRole?: string;
736
796
  /**
797
+ * @public
737
798
  * <p>The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag
738
799
  * consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in <i>Amazon Web Services General
739
800
  * Reference</i>.</p>
@@ -742,6 +803,7 @@ export interface CreateComputeEnvironmentRequest {
742
803
  */
743
804
  tags?: Record<string, string>;
744
805
  /**
806
+ * @public
745
807
  * <p>The details for the Amazon EKS cluster that supports the compute environment.</p>
746
808
  */
747
809
  eksConfiguration?: EksConfiguration;
@@ -751,11 +813,13 @@ export interface CreateComputeEnvironmentRequest {
751
813
  */
752
814
  export interface CreateComputeEnvironmentResponse {
753
815
  /**
816
+ * @public
754
817
  * <p>The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and
755
818
  * lowercase letters, numbers, hyphens (-), and underscores (_).</p>
756
819
  */
757
820
  computeEnvironmentName?: string;
758
821
  /**
822
+ * @public
759
823
  * <p>The Amazon Resource Name (ARN) of the compute environment.</p>
760
824
  */
761
825
  computeEnvironmentArn?: string;
@@ -777,12 +841,14 @@ export interface CreateComputeEnvironmentResponse {
777
841
  */
778
842
  export interface ComputeEnvironmentOrder {
779
843
  /**
844
+ * @public
780
845
  * <p>The order of the compute environment. Compute environments are tried in ascending order. For
781
846
  * example, if two compute environments are associated with a job queue, the compute environment
782
847
  * with a lower <code>order</code> integer value is tried for job placement first.</p>
783
848
  */
784
849
  order: number | undefined;
785
850
  /**
851
+ * @public
786
852
  * <p>The Amazon Resource Name (ARN) of the compute environment.</p>
787
853
  */
788
854
  computeEnvironment: string | undefined;
@@ -805,17 +871,20 @@ export type JQState = (typeof JQState)[keyof typeof JQState];
805
871
  */
806
872
  export interface CreateJobQueueRequest {
807
873
  /**
874
+ * @public
808
875
  * <p>The name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters,
809
876
  * numbers, hyphens (-), and underscores (_).</p>
810
877
  */
811
878
  jobQueueName: string | undefined;
812
879
  /**
880
+ * @public
813
881
  * <p>The state of the job queue. If the job queue state is <code>ENABLED</code>, it is able to accept jobs. If the
814
882
  * job queue state is <code>DISABLED</code>, new jobs can't be added to the queue, but jobs already in the queue can
815
883
  * finish.</p>
816
884
  */
817
885
  state?: JQState | string;
818
886
  /**
887
+ * @public
819
888
  * <p>The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue uses a fair
820
889
  * share scheduling policy. If this parameter isn't specified, the job queue uses a first in, first out (FIFO)
821
890
  * scheduling policy. After a job queue is created, you can replace but can't remove the fair share scheduling policy.
@@ -827,6 +896,7 @@ export interface CreateJobQueueRequest {
827
896
  */
828
897
  schedulingPolicyArn?: string;
829
898
  /**
899
+ * @public
830
900
  * <p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the
831
901
  * <code>priority</code> parameter) are evaluated first when associated with the same compute environment. Priority is
832
902
  * determined in descending order. For example, a job queue with a priority value of <code>10</code> is given scheduling
@@ -836,6 +906,7 @@ export interface CreateJobQueueRequest {
836
906
  */
837
907
  priority: number | undefined;
838
908
  /**
909
+ * @public
839
910
  * <p>The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler
840
911
  * uses this parameter to determine which compute environment runs a specific job. Compute environments must be in
841
912
  * the <code>VALID</code> state before you can associate them with a job queue. You can associate up to three compute
@@ -849,6 +920,7 @@ export interface CreateJobQueueRequest {
849
920
  */
850
921
  computeEnvironmentOrder: ComputeEnvironmentOrder[] | undefined;
851
922
  /**
923
+ * @public
852
924
  * <p>The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists
853
925
  * of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a> in <i>Batch User Guide</i>.</p>
854
926
  */
@@ -859,10 +931,12 @@ export interface CreateJobQueueRequest {
859
931
  */
860
932
  export interface CreateJobQueueResponse {
861
933
  /**
934
+ * @public
862
935
  * <p>The name of the job queue.</p>
863
936
  */
864
937
  jobQueueName: string | undefined;
865
938
  /**
939
+ * @public
866
940
  * <p>The Amazon Resource Name (ARN) of the job queue.</p>
867
941
  */
868
942
  jobQueueArn: string | undefined;
@@ -874,6 +948,7 @@ export interface CreateJobQueueResponse {
874
948
  */
875
949
  export interface ShareAttributes {
876
950
  /**
951
+ * @public
877
952
  * <p>A fair share identifier or fair share identifier prefix. If the string ends with an asterisk
878
953
  * (*), this entry specifies the weight factor to use for fair share identifiers that start with
879
954
  * that prefix. The list of fair share identifiers in a fair share policy can't overlap. For
@@ -885,6 +960,7 @@ export interface ShareAttributes {
885
960
  */
886
961
  shareIdentifier: string | undefined;
887
962
  /**
963
+ * @public
888
964
  * <p>The weight factor for the fair share identifier. The default value is 1.0. A lower value has
889
965
  * a higher priority for compute resources. For example, jobs that use a share identifier with a
890
966
  * weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share
@@ -899,6 +975,7 @@ export interface ShareAttributes {
899
975
  */
900
976
  export interface FairsharePolicy {
901
977
  /**
978
+ * @public
902
979
  * <p>The amount of time (in seconds) to use to calculate a fair share percentage for each fair
903
980
  * share identifier in use. A value of zero (0) indicates that only current usage is measured. The
904
981
  * decay allows for more recently run jobs to have more weight than jobs that ran earlier. The
@@ -906,6 +983,7 @@ export interface FairsharePolicy {
906
983
  */
907
984
  shareDecaySeconds?: number;
908
985
  /**
986
+ * @public
909
987
  * <p>A value used to reserve some of the available maximum vCPU for fair share identifiers that
910
988
  * aren't already used.</p>
911
989
  * <p>The reserved ratio is
@@ -925,6 +1003,7 @@ export interface FairsharePolicy {
925
1003
  */
926
1004
  computeReservation?: number;
927
1005
  /**
1006
+ * @public
928
1007
  * <p>An array of <code>SharedIdentifier</code> objects that contain the weights for the fair
929
1008
  * share identifiers for the fair share policy. Fair share identifiers that aren't included have a
930
1009
  * default weight of <code>1.0</code>.</p>
@@ -937,15 +1016,18 @@ export interface FairsharePolicy {
937
1016
  */
938
1017
  export interface CreateSchedulingPolicyRequest {
939
1018
  /**
1019
+ * @public
940
1020
  * <p>The name of the scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase
941
1021
  * letters, numbers, hyphens (-), and underscores (_).</p>
942
1022
  */
943
1023
  name: string | undefined;
944
1024
  /**
1025
+ * @public
945
1026
  * <p>The fair share policy of the scheduling policy.</p>
946
1027
  */
947
1028
  fairsharePolicy?: FairsharePolicy;
948
1029
  /**
1030
+ * @public
949
1031
  * <p>The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag
950
1032
  * consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in <i>Amazon Web Services General
951
1033
  * Reference</i>.</p>
@@ -958,10 +1040,12 @@ export interface CreateSchedulingPolicyRequest {
958
1040
  */
959
1041
  export interface CreateSchedulingPolicyResponse {
960
1042
  /**
1043
+ * @public
961
1044
  * <p>The name of the scheduling policy.</p>
962
1045
  */
963
1046
  name: string | undefined;
964
1047
  /**
1048
+ * @public
965
1049
  * <p>The Amazon Resource Name (ARN) of the scheduling policy. The format is
966
1050
  * <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
967
1051
  * </code>.
@@ -976,6 +1060,7 @@ export interface CreateSchedulingPolicyResponse {
976
1060
  */
977
1061
  export interface DeleteComputeEnvironmentRequest {
978
1062
  /**
1063
+ * @public
979
1064
  * <p>The name or Amazon Resource Name (ARN) of the compute environment to delete.</p>
980
1065
  */
981
1066
  computeEnvironment: string | undefined;
@@ -991,6 +1076,7 @@ export interface DeleteComputeEnvironmentResponse {
991
1076
  */
992
1077
  export interface DeleteJobQueueRequest {
993
1078
  /**
1079
+ * @public
994
1080
  * <p>The short name or full Amazon Resource Name (ARN) of the queue to delete.</p>
995
1081
  */
996
1082
  jobQueue: string | undefined;
@@ -1006,6 +1092,7 @@ export interface DeleteJobQueueResponse {
1006
1092
  */
1007
1093
  export interface DeleteSchedulingPolicyRequest {
1008
1094
  /**
1095
+ * @public
1009
1096
  * <p>The Amazon Resource Name (ARN) of the scheduling policy to delete.</p>
1010
1097
  */
1011
1098
  arn: string | undefined;
@@ -1020,6 +1107,7 @@ export interface DeleteSchedulingPolicyResponse {
1020
1107
  */
1021
1108
  export interface DeregisterJobDefinitionRequest {
1022
1109
  /**
1110
+ * @public
1023
1111
  * <p>The name and revision (<code>name:revision</code>) or full Amazon Resource Name (ARN) of the job definition to deregister.</p>
1024
1112
  */
1025
1113
  jobDefinition: string | undefined;
@@ -1035,10 +1123,12 @@ export interface DeregisterJobDefinitionResponse {
1035
1123
  */
1036
1124
  export interface DescribeComputeEnvironmentsRequest {
1037
1125
  /**
1126
+ * @public
1038
1127
  * <p>A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.</p>
1039
1128
  */
1040
1129
  computeEnvironments?: string[];
1041
1130
  /**
1131
+ * @public
1042
1132
  * <p>The maximum number of cluster results returned by <code>DescribeComputeEnvironments</code> in paginated output.
1043
1133
  * When this parameter is used, <code>DescribeComputeEnvironments</code> only returns <code>maxResults</code> results in
1044
1134
  * a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can
@@ -1049,6 +1139,7 @@ export interface DescribeComputeEnvironmentsRequest {
1049
1139
  */
1050
1140
  maxResults?: number;
1051
1141
  /**
1142
+ * @public
1052
1143
  * <p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeComputeEnvironments</code>
1053
1144
  * request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination
1054
1145
  * continues from the end of the previous results that returned the <code>nextToken</code> value. This value is
@@ -1096,11 +1187,13 @@ export type CEStatus = (typeof CEStatus)[keyof typeof CEStatus];
1096
1187
  */
1097
1188
  export interface UpdatePolicy {
1098
1189
  /**
1190
+ * @public
1099
1191
  * <p>Specifies whether jobs are automatically terminated when the computer environment
1100
1192
  * infrastructure is updated. The default value is <code>false</code>.</p>
1101
1193
  */
1102
1194
  terminateJobsOnUpdate?: boolean;
1103
1195
  /**
1196
+ * @public
1104
1197
  * <p>Specifies the job timeout (in minutes) when the compute environment infrastructure is
1105
1198
  * updated. The default value is 30.</p>
1106
1199
  */
@@ -1112,32 +1205,39 @@ export interface UpdatePolicy {
1112
1205
  */
1113
1206
  export interface ComputeEnvironmentDetail {
1114
1207
  /**
1208
+ * @public
1115
1209
  * <p>The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and
1116
1210
  * lowercase letters, numbers, hyphens (-), and underscores (_).</p>
1117
1211
  */
1118
1212
  computeEnvironmentName: string | undefined;
1119
1213
  /**
1214
+ * @public
1120
1215
  * <p>The Amazon Resource Name (ARN) of the compute environment.</p>
1121
1216
  */
1122
1217
  computeEnvironmentArn: string | undefined;
1123
1218
  /**
1219
+ * @public
1124
1220
  * <p>The maximum number of VCPUs expected to be used for an unmanaged compute environment.</p>
1125
1221
  */
1126
1222
  unmanagedvCpus?: number;
1127
1223
  /**
1224
+ * @public
1128
1225
  * <p>The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.</p>
1129
1226
  */
1130
1227
  ecsClusterArn?: string;
1131
1228
  /**
1229
+ * @public
1132
1230
  * <p>The tags applied to the compute environment.</p>
1133
1231
  */
1134
1232
  tags?: Record<string, string>;
1135
1233
  /**
1234
+ * @public
1136
1235
  * <p>The type of the compute environment: <code>MANAGED</code> or <code>UNMANAGED</code>. For
1137
1236
  * more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute environments</a> in the <i>Batch User Guide</i>.</p>
1138
1237
  */
1139
1238
  type?: CEType | string;
1140
1239
  /**
1240
+ * @public
1141
1241
  * <p>The state of the compute environment. The valid values are <code>ENABLED</code> or
1142
1242
  * <code>DISABLED</code>.</p>
1143
1243
  * <p>If the state is <code>ENABLED</code>, then the Batch scheduler can attempt to place jobs
@@ -1161,43 +1261,51 @@ export interface ComputeEnvironmentDetail {
1161
1261
  */
1162
1262
  state?: CEState | string;
1163
1263
  /**
1264
+ * @public
1164
1265
  * <p>The current status of the compute environment (for example, <code>CREATING</code> or
1165
1266
  * <code>VALID</code>).</p>
1166
1267
  */
1167
1268
  status?: CEStatus | string;
1168
1269
  /**
1270
+ * @public
1169
1271
  * <p>A short, human-readable string to provide additional details for the current status of the
1170
1272
  * compute environment.</p>
1171
1273
  */
1172
1274
  statusReason?: string;
1173
1275
  /**
1276
+ * @public
1174
1277
  * <p>The compute resources defined for the compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute environments</a> in
1175
1278
  * the <i>Batch User Guide</i>.</p>
1176
1279
  */
1177
1280
  computeResources?: ComputeResource;
1178
1281
  /**
1282
+ * @public
1179
1283
  * <p>The service role that's associated with the compute environment that allows Batch to make
1180
1284
  * calls to Amazon Web Services API operations on your behalf. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM role</a> in
1181
1285
  * the <i>Batch User Guide</i>.</p>
1182
1286
  */
1183
1287
  serviceRole?: string;
1184
1288
  /**
1289
+ * @public
1185
1290
  * <p>Specifies the infrastructure update policy for the compute environment. For more information
1186
1291
  * about infrastructure updates, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the
1187
1292
  * <i>Batch User Guide</i>.</p>
1188
1293
  */
1189
1294
  updatePolicy?: UpdatePolicy;
1190
1295
  /**
1296
+ * @public
1191
1297
  * <p>The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only
1192
1298
  * specify this parameter if the <code>containerOrchestrationType</code> is <code>EKS</code>.</p>
1193
1299
  */
1194
1300
  eksConfiguration?: EksConfiguration;
1195
1301
  /**
1302
+ * @public
1196
1303
  * <p>The orchestration type of the compute environment. The valid values are <code>ECS</code>
1197
1304
  * (default) or <code>EKS</code>.</p>
1198
1305
  */
1199
1306
  containerOrchestrationType?: OrchestrationType | string;
1200
1307
  /**
1308
+ * @public
1201
1309
  * <p>Unique identifier for the compute environment.</p>
1202
1310
  */
1203
1311
  uuid?: string;
@@ -1207,10 +1315,12 @@ export interface ComputeEnvironmentDetail {
1207
1315
  */
1208
1316
  export interface DescribeComputeEnvironmentsResponse {
1209
1317
  /**
1318
+ * @public
1210
1319
  * <p>The list of compute environments.</p>
1211
1320
  */
1212
1321
  computeEnvironments?: ComputeEnvironmentDetail[];
1213
1322
  /**
1323
+ * @public
1214
1324
  * <p>The <code>nextToken</code> value to include in a future <code>DescribeComputeEnvironments</code> request. When
1215
1325
  * the results of a <code>DescribeComputeEnvironments</code> request exceed <code>maxResults</code>, this value can be
1216
1326
  * used to retrieve the next page of results. This value is <code>null</code> when there are no more results to
@@ -1224,12 +1334,14 @@ export interface DescribeComputeEnvironmentsResponse {
1224
1334
  */
1225
1335
  export interface DescribeJobDefinitionsRequest {
1226
1336
  /**
1337
+ * @public
1227
1338
  * <p>A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format
1228
1339
  * <code>arn:aws:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}</code> or a short version
1229
1340
  * using the form <code>$\{JobDefinitionName\}:$\{Revision\}</code>.</p>
1230
1341
  */
1231
1342
  jobDefinitions?: string[];
1232
1343
  /**
1344
+ * @public
1233
1345
  * <p>The maximum number of results returned by <code>DescribeJobDefinitions</code> in paginated output. When this
1234
1346
  * parameter is used, <code>DescribeJobDefinitions</code> only returns <code>maxResults</code> results in a single page
1235
1347
  * and a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending
@@ -1240,14 +1352,17 @@ export interface DescribeJobDefinitionsRequest {
1240
1352
  */
1241
1353
  maxResults?: number;
1242
1354
  /**
1355
+ * @public
1243
1356
  * <p>The name of the job definition to describe.</p>
1244
1357
  */
1245
1358
  jobDefinitionName?: string;
1246
1359
  /**
1360
+ * @public
1247
1361
  * <p>The status used to filter job definitions.</p>
1248
1362
  */
1249
1363
  status?: string;
1250
1364
  /**
1365
+ * @public
1251
1366
  * <p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeJobDefinitions</code> request
1252
1367
  * where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues
1253
1368
  * from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code>
@@ -1265,11 +1380,13 @@ export interface DescribeJobDefinitionsRequest {
1265
1380
  */
1266
1381
  export interface KeyValuePair {
1267
1382
  /**
1383
+ * @public
1268
1384
  * <p>The name of the key-value pair. For environment variables, this is the name of the
1269
1385
  * environment variable.</p>
1270
1386
  */
1271
1387
  name?: string;
1272
1388
  /**
1389
+ * @public
1273
1390
  * <p>The value of the key-value pair. For environment variables, this is the value of the
1274
1391
  * environment variable.</p>
1275
1392
  */
@@ -1283,6 +1400,7 @@ export interface KeyValuePair {
1283
1400
  */
1284
1401
  export interface EphemeralStorage {
1285
1402
  /**
1403
+ * @public
1286
1404
  * <p>The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported
1287
1405
  * value is <code>21</code> GiB and the maximum supported value is <code>200</code> GiB.</p>
1288
1406
  */
@@ -1295,6 +1413,7 @@ export interface EphemeralStorage {
1295
1413
  */
1296
1414
  export interface FargatePlatformConfiguration {
1297
1415
  /**
1416
+ * @public
1298
1417
  * <p>The Fargate platform version where the jobs are running. A platform version is
1299
1418
  * specified only for jobs that are running on Fargate resources. If one isn't specified, the
1300
1419
  * <code>LATEST</code> platform version is used by default. This uses a recent, approved version of
@@ -1326,15 +1445,18 @@ export type DeviceCgroupPermission = (typeof DeviceCgroupPermission)[keyof typeo
1326
1445
  */
1327
1446
  export interface Device {
1328
1447
  /**
1448
+ * @public
1329
1449
  * <p>The path for the device on the host container instance.</p>
1330
1450
  */
1331
1451
  hostPath: string | undefined;
1332
1452
  /**
1453
+ * @public
1333
1454
  * <p>The path inside the container that's used to expose the host device. By default, the
1334
1455
  * <code>hostPath</code> value is used.</p>
1335
1456
  */
1336
1457
  containerPath?: string;
1337
1458
  /**
1459
+ * @public
1338
1460
  * <p>The explicit permissions to provide to the container for the device. By default, the
1339
1461
  * container has permissions for <code>read</code>, <code>write</code>, and <code>mknod</code> for
1340
1462
  * the device.</p>
@@ -1350,15 +1472,18 @@ export interface Device {
1350
1472
  */
1351
1473
  export interface Tmpfs {
1352
1474
  /**
1475
+ * @public
1353
1476
  * <p>The absolute file path in the container where the <code>tmpfs</code> volume is
1354
1477
  * mounted.</p>
1355
1478
  */
1356
1479
  containerPath: string | undefined;
1357
1480
  /**
1481
+ * @public
1358
1482
  * <p>The size (in MiB) of the <code>tmpfs</code> volume.</p>
1359
1483
  */
1360
1484
  size: number | undefined;
1361
1485
  /**
1486
+ * @public
1362
1487
  * <p>The list of <code>tmpfs</code> volume mount options.</p>
1363
1488
  * <p>Valid values: "<code>defaults</code>" | "<code>ro</code>" | "<code>rw</code>" |
1364
1489
  * "<code>suid</code>" | "<code>nosuid</code>" | "<code>dev</code>" | "<code>nodev</code>" |
@@ -1380,6 +1505,7 @@ export interface Tmpfs {
1380
1505
  */
1381
1506
  export interface LinuxParameters {
1382
1507
  /**
1508
+ * @public
1383
1509
  * <p>Any of the host devices to expose to the container. This parameter maps to
1384
1510
  * <code>Devices</code> in the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a>
1385
1511
  * and the <code>--device</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker
@@ -1391,6 +1517,7 @@ export interface LinuxParameters {
1391
1517
  */
1392
1518
  devices?: Device[];
1393
1519
  /**
1520
+ * @public
1394
1521
  * <p>If true, run an <code>init</code> process inside the container that forwards signals and
1395
1522
  * reaps processes. This parameter maps to the <code>--init</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. This parameter requires version 1.25 of the Docker Remote API or greater on your
1396
1523
  * container instance. To check the Docker Remote API version on your container instance, log in to your
@@ -1399,6 +1526,7 @@ export interface LinuxParameters {
1399
1526
  */
1400
1527
  initProcessEnabled?: boolean;
1401
1528
  /**
1529
+ * @public
1402
1530
  * <p>The value for the size (in MiB) of the <code>/dev/shm</code> volume. This parameter maps to
1403
1531
  * the <code>--shm-size</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker
1404
1532
  * run</a>.</p>
@@ -1409,6 +1537,7 @@ export interface LinuxParameters {
1409
1537
  */
1410
1538
  sharedMemorySize?: number;
1411
1539
  /**
1540
+ * @public
1412
1541
  * <p>The container path, mount options, and size (in MiB) of the <code>tmpfs</code> mount. This
1413
1542
  * parameter maps to the <code>--tmpfs</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker
1414
1543
  * run</a>.</p>
@@ -1419,6 +1548,7 @@ export interface LinuxParameters {
1419
1548
  */
1420
1549
  tmpfs?: Tmpfs[];
1421
1550
  /**
1551
+ * @public
1422
1552
  * <p>The total amount of swap memory (in MiB) a container can use. This parameter is translated
1423
1553
  * to the <code>--memory-swap</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker
1424
1554
  * run</a> where the value is the sum of the container memory plus the <code>maxSwap</code>
@@ -1436,6 +1566,7 @@ export interface LinuxParameters {
1436
1566
  */
1437
1567
  maxSwap?: number;
1438
1568
  /**
1569
+ * @public
1439
1570
  * <p>You can use this parameter to tune a container's memory swappiness behavior. A
1440
1571
  * <code>swappiness</code> value of <code>0</code> causes swapping to not occur unless absolutely
1441
1572
  * necessary. A <code>swappiness</code> value of <code>100</code> causes pages to be swapped
@@ -1512,10 +1643,12 @@ export type LogDriver = (typeof LogDriver)[keyof typeof LogDriver];
1512
1643
  */
1513
1644
  export interface Secret {
1514
1645
  /**
1646
+ * @public
1515
1647
  * <p>The name of the secret.</p>
1516
1648
  */
1517
1649
  name: string | undefined;
1518
1650
  /**
1651
+ * @public
1519
1652
  * <p>The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of
1520
1653
  * the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.</p>
1521
1654
  * <note>
@@ -1532,6 +1665,7 @@ export interface Secret {
1532
1665
  */
1533
1666
  export interface LogConfiguration {
1534
1667
  /**
1668
+ * @public
1535
1669
  * <p>The log driver to use for the container. The valid values that are listed for this parameter
1536
1670
  * are log drivers that the Amazon ECS container agent can communicate with by default.</p>
1537
1671
  * <p>The supported log drivers are <code>awslogs</code>, <code>fluentd</code>, <code>gelf</code>,
@@ -1599,6 +1733,7 @@ export interface LogConfiguration {
1599
1733
  */
1600
1734
  logDriver: LogDriver | string | undefined;
1601
1735
  /**
1736
+ * @public
1602
1737
  * <p>The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your
1603
1738
  * container instance. To check the Docker Remote API version on your container instance, log in to your
1604
1739
  * container instance and run the following command: <code>sudo docker version | grep "Server API version"</code>
@@ -1606,6 +1741,7 @@ export interface LogConfiguration {
1606
1741
  */
1607
1742
  options?: Record<string, string>;
1608
1743
  /**
1744
+ * @public
1609
1745
  * <p>The secrets to pass to the log configuration. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html">Specifying sensitive
1610
1746
  * data</a> in the <i>Batch User Guide</i>.</p>
1611
1747
  */
@@ -1619,15 +1755,18 @@ export interface LogConfiguration {
1619
1755
  */
1620
1756
  export interface MountPoint {
1621
1757
  /**
1758
+ * @public
1622
1759
  * <p>The path on the container where the host volume is mounted.</p>
1623
1760
  */
1624
1761
  containerPath?: string;
1625
1762
  /**
1763
+ * @public
1626
1764
  * <p>If this value is <code>true</code>, the container has read-only access to the volume.
1627
1765
  * Otherwise, the container can write to the volume. The default value is <code>false</code>.</p>
1628
1766
  */
1629
1767
  readOnly?: boolean;
1630
1768
  /**
1769
+ * @public
1631
1770
  * <p>The name of the volume to mount.</p>
1632
1771
  */
1633
1772
  sourceVolume?: string;
@@ -1639,6 +1778,7 @@ export interface MountPoint {
1639
1778
  */
1640
1779
  export interface NetworkConfiguration {
1641
1780
  /**
1781
+ * @public
1642
1782
  * <p>Indicates whether the job has a public IP address. For a job that's running on Fargate
1643
1783
  * resources in a private subnet to send outbound traffic to the internet (for example, to pull
1644
1784
  * container images), the private subnet requires a NAT gateway be attached to route requests to the
@@ -1667,6 +1807,7 @@ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
1667
1807
  */
1668
1808
  export interface ResourceRequirement {
1669
1809
  /**
1810
+ * @public
1670
1811
  * <p>The quantity of the specified resource to reserve for the container. The values vary based
1671
1812
  * on the <code>type</code> specified.</p>
1672
1813
  * <dl>
@@ -1830,6 +1971,7 @@ export interface ResourceRequirement {
1830
1971
  */
1831
1972
  value: string | undefined;
1832
1973
  /**
1974
+ * @public
1833
1975
  * <p>The type of resource to assign to a container. The supported resources include
1834
1976
  * <code>GPU</code>, <code>MEMORY</code>, and <code>VCPU</code>.</p>
1835
1977
  */
@@ -1841,6 +1983,7 @@ export interface ResourceRequirement {
1841
1983
  */
1842
1984
  export interface RuntimePlatform {
1843
1985
  /**
1986
+ * @public
1844
1987
  * <p>The operating system for the compute environment.
1845
1988
  * Valid values are:
1846
1989
  * <code>LINUX</code> (default), <code>WINDOWS_SERVER_2019_CORE</code>,
@@ -1869,8 +2012,9 @@ export interface RuntimePlatform {
1869
2012
  */
1870
2013
  operatingSystemFamily?: string;
1871
2014
  /**
1872
- * <p>The vCPU architecture. The default value is <code>X86_64</code>. Valid values are <code>X86_64</code> and
1873
- * <code> ARM64</code>.</p>
2015
+ * @public
2016
+ * <p>The vCPU architecture. The default value is <code>X86_64</code>. Valid values are
2017
+ * <code>X86_64</code> and <code>ARM64</code>.</p>
1874
2018
  * <note>
1875
2019
  * <p>This parameter must be set to
1876
2020
  * <code>X86_64</code>
@@ -1888,14 +2032,17 @@ export interface RuntimePlatform {
1888
2032
  */
1889
2033
  export interface Ulimit {
1890
2034
  /**
2035
+ * @public
1891
2036
  * <p>The hard limit for the <code>ulimit</code> type.</p>
1892
2037
  */
1893
2038
  hardLimit: number | undefined;
1894
2039
  /**
2040
+ * @public
1895
2041
  * <p>The <code>type</code> of the <code>ulimit</code>.</p>
1896
2042
  */
1897
2043
  name: string | undefined;
1898
2044
  /**
2045
+ * @public
1899
2046
  * <p>The soft limit for the <code>ulimit</code> type.</p>
1900
2047
  */
1901
2048
  softLimit: number | undefined;
@@ -1918,6 +2065,7 @@ export type EFSAuthorizationConfigIAM = (typeof EFSAuthorizationConfigIAM)[keyof
1918
2065
  */
1919
2066
  export interface EFSAuthorizationConfig {
1920
2067
  /**
2068
+ * @public
1921
2069
  * <p>The Amazon EFS access point ID to use. If an access point is specified, the root directory value
1922
2070
  * specified in the <code>EFSVolumeConfiguration</code> must either be omitted or set to
1923
2071
  * <code>/</code> which enforces the path set on the EFS access point. If an access point is used,
@@ -1927,6 +2075,7 @@ export interface EFSAuthorizationConfig {
1927
2075
  */
1928
2076
  accessPointId?: string;
1929
2077
  /**
2078
+ * @public
1930
2079
  * <p>Whether or not to use the Batch job IAM role defined in a job definition when mounting the
1931
2080
  * Amazon EFS file system. If enabled, transit encryption must be enabled in the
1932
2081
  * <code>EFSVolumeConfiguration</code>. If this parameter is omitted, the default value of
@@ -1957,10 +2106,12 @@ export type EFSTransitEncryption = (typeof EFSTransitEncryption)[keyof typeof EF
1957
2106
  */
1958
2107
  export interface EFSVolumeConfiguration {
1959
2108
  /**
2109
+ * @public
1960
2110
  * <p>The Amazon EFS file system ID to use.</p>
1961
2111
  */
1962
2112
  fileSystemId: string | undefined;
1963
2113
  /**
2114
+ * @public
1964
2115
  * <p>The directory within the Amazon EFS file system to mount as the root directory inside the host.
1965
2116
  * If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying
1966
2117
  * <code>/</code> has the same effect as omitting this parameter. The maximum length is 4,096
@@ -1973,6 +2124,7 @@ export interface EFSVolumeConfiguration {
1973
2124
  */
1974
2125
  rootDirectory?: string;
1975
2126
  /**
2127
+ * @public
1976
2128
  * <p>Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and
1977
2129
  * the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If
1978
2130
  * this parameter is omitted, the default value of <code>DISABLED</code> is used. For more
@@ -1980,6 +2132,7 @@ export interface EFSVolumeConfiguration {
1980
2132
  */
1981
2133
  transitEncryption?: EFSTransitEncryption | string;
1982
2134
  /**
2135
+ * @public
1983
2136
  * <p>The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If
1984
2137
  * you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS
1985
2138
  * mount helper uses. The value must be between 0 and 65,535. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html">EFS mount helper</a> in the
@@ -1987,6 +2140,7 @@ export interface EFSVolumeConfiguration {
1987
2140
  */
1988
2141
  transitEncryptionPort?: number;
1989
2142
  /**
2143
+ * @public
1990
2144
  * <p>The authorization configuration details for the Amazon EFS file system.</p>
1991
2145
  */
1992
2146
  authorizationConfig?: EFSAuthorizationConfig;
@@ -2000,6 +2154,7 @@ export interface EFSVolumeConfiguration {
2000
2154
  */
2001
2155
  export interface Host {
2002
2156
  /**
2157
+ * @public
2003
2158
  * <p>The path on the host container instance that's presented to the container. If this parameter
2004
2159
  * is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a
2005
2160
  * file location, then the data volume persists at the specified location on the host container
@@ -2019,6 +2174,7 @@ export interface Host {
2019
2174
  */
2020
2175
  export interface Volume {
2021
2176
  /**
2177
+ * @public
2022
2178
  * <p>The contents of the <code>host</code> parameter determine whether your data volume persists
2023
2179
  * on the host container instance and where it's stored. If the host parameter is empty, then the
2024
2180
  * Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to
@@ -2030,12 +2186,14 @@ export interface Volume {
2030
2186
  */
2031
2187
  host?: Host;
2032
2188
  /**
2189
+ * @public
2033
2190
  * <p>The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters,
2034
2191
  * numbers, hyphens (-), and underscores (_). This name is referenced in the
2035
2192
  * <code>sourceVolume</code> parameter of container definition <code>mountPoints</code>.</p>
2036
2193
  */
2037
2194
  name?: string;
2038
2195
  /**
2196
+ * @public
2039
2197
  * <p>This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs
2040
2198
  * that are running on Fargate resources must specify a <code>platformVersion</code> of at least
2041
2199
  * <code>1.4.0</code>.</p>
@@ -2051,6 +2209,7 @@ export interface Volume {
2051
2209
  */
2052
2210
  export interface ContainerProperties {
2053
2211
  /**
2212
+ * @public
2054
2213
  * <p>The image used to start a container. This string is passed directly to the Docker daemon.
2055
2214
  * Images in the Docker Hub registry are available by default. Other repositories are specified with
2056
2215
  * <code>
@@ -2092,6 +2251,7 @@ export interface ContainerProperties {
2092
2251
  */
2093
2252
  image?: string;
2094
2253
  /**
2254
+ * @public
2095
2255
  * @deprecated
2096
2256
  *
2097
2257
  * <p>This parameter is deprecated, use <code>resourceRequirements</code> to specify the vCPU
@@ -2105,6 +2265,7 @@ export interface ContainerProperties {
2105
2265
  */
2106
2266
  vcpus?: number;
2107
2267
  /**
2268
+ * @public
2108
2269
  * @deprecated
2109
2270
  *
2110
2271
  * <p>This parameter is deprecated, use <code>resourceRequirements</code> to specify the memory
@@ -2116,6 +2277,7 @@ export interface ContainerProperties {
2116
2277
  */
2117
2278
  memory?: number;
2118
2279
  /**
2280
+ * @public
2119
2281
  * <p>The command that's passed to the container. This parameter maps to <code>Cmd</code> in the
2120
2282
  * <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the <code>COMMAND</code>
2121
2283
  * parameter to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. For more information, see
@@ -2123,22 +2285,26 @@ export interface ContainerProperties {
2123
2285
  */
2124
2286
  command?: string[];
2125
2287
  /**
2288
+ * @public
2126
2289
  * <p>The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more
2127
2290
  * information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM roles for tasks</a> in the
2128
2291
  * <i>Amazon Elastic Container Service Developer Guide</i>.</p>
2129
2292
  */
2130
2293
  jobRoleArn?: string;
2131
2294
  /**
2295
+ * @public
2132
2296
  * <p>The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate
2133
2297
  * resources, you must provide an execution role. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html">Batch execution IAM role</a>
2134
2298
  * in the <i>Batch User Guide</i>.</p>
2135
2299
  */
2136
2300
  executionRoleArn?: string;
2137
2301
  /**
2302
+ * @public
2138
2303
  * <p>A list of data volumes used in a job.</p>
2139
2304
  */
2140
2305
  volumes?: Volume[];
2141
2306
  /**
2307
+ * @public
2142
2308
  * <p>The environment variables to pass to a container. This parameter maps to <code>Env</code> in
2143
2309
  * the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the
2144
2310
  * <code>--env</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>.</p>
@@ -2153,6 +2319,7 @@ export interface ContainerProperties {
2153
2319
  */
2154
2320
  environment?: KeyValuePair[];
2155
2321
  /**
2322
+ * @public
2156
2323
  * <p>The mount points for data volumes in your container. This parameter maps to
2157
2324
  * <code>Volumes</code> in the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a>
2158
2325
  * and the <code>--volume</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker
@@ -2160,6 +2327,7 @@ export interface ContainerProperties {
2160
2327
  */
2161
2328
  mountPoints?: MountPoint[];
2162
2329
  /**
2330
+ * @public
2163
2331
  * <p>When this parameter is true, the container is given read-only access to its root file
2164
2332
  * system. This parameter maps to <code>ReadonlyRootfs</code> in the
2165
2333
  * <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the
@@ -2167,6 +2335,7 @@ export interface ContainerProperties {
2167
2335
  */
2168
2336
  readonlyRootFilesystem?: boolean;
2169
2337
  /**
2338
+ * @public
2170
2339
  * <p>When this parameter is true, the container is given elevated permissions on the host
2171
2340
  * container instance (similar to the <code>root</code> user). This parameter maps to
2172
2341
  * <code>Privileged</code> in the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the
@@ -2178,6 +2347,7 @@ export interface ContainerProperties {
2178
2347
  */
2179
2348
  privileged?: boolean;
2180
2349
  /**
2350
+ * @public
2181
2351
  * <p>A list of <code>ulimits</code> to set in the container. This parameter maps to
2182
2352
  * <code>Ulimits</code> in the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a>
2183
2353
  * and the <code>--ulimit</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker
@@ -2189,12 +2359,14 @@ export interface ContainerProperties {
2189
2359
  */
2190
2360
  ulimits?: Ulimit[];
2191
2361
  /**
2362
+ * @public
2192
2363
  * <p>The user name to use inside the container. This parameter maps to <code>User</code> in the
2193
2364
  * <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the <code>--user</code>
2194
2365
  * option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>.</p>
2195
2366
  */
2196
2367
  user?: string;
2197
2368
  /**
2369
+ * @public
2198
2370
  * <p>The instance type to use for a multi-node parallel job. All node groups in a multi-node
2199
2371
  * parallel job must use the same instance type.</p>
2200
2372
  * <note>
@@ -2204,16 +2376,19 @@ export interface ContainerProperties {
2204
2376
  */
2205
2377
  instanceType?: string;
2206
2378
  /**
2379
+ * @public
2207
2380
  * <p>The type and amount of resources to assign to a container. The supported resources include
2208
2381
  * <code>GPU</code>, <code>MEMORY</code>, and <code>VCPU</code>.</p>
2209
2382
  */
2210
2383
  resourceRequirements?: ResourceRequirement[];
2211
2384
  /**
2385
+ * @public
2212
2386
  * <p>Linux-specific modifications that are applied to the container, such as details for device
2213
2387
  * mappings.</p>
2214
2388
  */
2215
2389
  linuxParameters?: LinuxParameters;
2216
2390
  /**
2391
+ * @public
2217
2392
  * <p>The log configuration specification for the container.</p>
2218
2393
  * <p>This parameter maps to <code>LogConfig</code> in the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a>
2219
2394
  * section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the <code>--log-driver</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. By default, containers use the same logging
@@ -2241,27 +2416,32 @@ export interface ContainerProperties {
2241
2416
  */
2242
2417
  logConfiguration?: LogConfiguration;
2243
2418
  /**
2419
+ * @public
2244
2420
  * <p>The secrets for the container. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html">Specifying sensitive data</a> in the
2245
2421
  * <i>Batch User Guide</i>.</p>
2246
2422
  */
2247
2423
  secrets?: Secret[];
2248
2424
  /**
2425
+ * @public
2249
2426
  * <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
2250
2427
  * running on EC2 resources must not specify this parameter.</p>
2251
2428
  */
2252
2429
  networkConfiguration?: NetworkConfiguration;
2253
2430
  /**
2431
+ * @public
2254
2432
  * <p>The platform configuration for jobs that are running on Fargate resources. Jobs that are
2255
2433
  * running on EC2 resources must not specify this parameter.</p>
2256
2434
  */
2257
2435
  fargatePlatformConfiguration?: FargatePlatformConfiguration;
2258
2436
  /**
2437
+ * @public
2259
2438
  * <p>The amount of ephemeral storage to allocate for the task. This parameter is used to expand
2260
2439
  * the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on
2261
2440
  * Fargate.</p>
2262
2441
  */
2263
2442
  ephemeralStorage?: EphemeralStorage;
2264
2443
  /**
2444
+ * @public
2265
2445
  * <p>An object that represents the compute environment architecture for Batch jobs on Fargate.</p>
2266
2446
  */
2267
2447
  runtimePlatform?: RuntimePlatform;
@@ -2272,10 +2452,12 @@ export interface ContainerProperties {
2272
2452
  */
2273
2453
  export interface EksContainerEnvironmentVariable {
2274
2454
  /**
2455
+ * @public
2275
2456
  * <p>The name of the environment variable.</p>
2276
2457
  */
2277
2458
  name: string | undefined;
2278
2459
  /**
2460
+ * @public
2279
2461
  * <p>The value of the environment variable.</p>
2280
2462
  */
2281
2463
  value?: string;
@@ -2289,6 +2471,7 @@ export interface EksContainerEnvironmentVariable {
2289
2471
  */
2290
2472
  export interface EksContainerResourceRequirements {
2291
2473
  /**
2474
+ * @public
2292
2475
  * <p>The type and quantity of the resources to reserve for the container. The values vary based
2293
2476
  * on the <code>name</code> that's specified. Resources can be requested using either the
2294
2477
  * <code>limits</code> or the <code>requests</code> objects.</p>
@@ -2327,6 +2510,7 @@ export interface EksContainerResourceRequirements {
2327
2510
  */
2328
2511
  limits?: Record<string, string>;
2329
2512
  /**
2513
+ * @public
2330
2514
  * <p>The type and quantity of the resources to request for the container. The values vary based
2331
2515
  * on the <code>name</code> that's specified. Resources can be requested by using either the
2332
2516
  * <code>limits</code> or the <code>requests</code> objects.</p>
@@ -2373,6 +2557,7 @@ export interface EksContainerResourceRequirements {
2373
2557
  */
2374
2558
  export interface EksContainerSecurityContext {
2375
2559
  /**
2560
+ * @public
2376
2561
  * <p>When this parameter is specified, the container is run as the specified user ID
2377
2562
  * (<code>uid</code>). If this parameter isn't specified, the default is the user that's specified
2378
2563
  * in the image metadata. This parameter maps to <code>RunAsUser</code> and <code>MustRanAs</code>
@@ -2382,6 +2567,7 @@ export interface EksContainerSecurityContext {
2382
2567
  */
2383
2568
  runAsUser?: number;
2384
2569
  /**
2570
+ * @public
2385
2571
  * <p>When this parameter is specified, the container is run as the specified group ID
2386
2572
  * (<code>gid</code>). If this parameter isn't specified, the default is the group that's specified
2387
2573
  * in the image metadata. This parameter maps to <code>RunAsGroup</code> and <code>MustRunAs</code>
@@ -2391,6 +2577,7 @@ export interface EksContainerSecurityContext {
2391
2577
  */
2392
2578
  runAsGroup?: number;
2393
2579
  /**
2580
+ * @public
2394
2581
  * <p>When this parameter is <code>true</code>, the container is given elevated permissions on the
2395
2582
  * host container instance. The level of permissions are similar to the <code>root</code> user
2396
2583
  * permissions. The default value is <code>false</code>. This parameter maps to
@@ -2399,6 +2586,7 @@ export interface EksContainerSecurityContext {
2399
2586
  */
2400
2587
  privileged?: boolean;
2401
2588
  /**
2589
+ * @public
2402
2590
  * <p>When this parameter is <code>true</code>, the container is given read-only access to its
2403
2591
  * root file system. The default value is <code>false</code>. This parameter maps to
2404
2592
  * <code>ReadOnlyRootFilesystem</code> policy in the <a href="https://kubernetes.io/docs/concepts/security/pod-security-policy/#volumes-and-file-systems">Volumes and file systems pod security policies</a> in the <i>Kubernetes
@@ -2406,6 +2594,7 @@ export interface EksContainerSecurityContext {
2406
2594
  */
2407
2595
  readOnlyRootFilesystem?: boolean;
2408
2596
  /**
2597
+ * @public
2409
2598
  * <p>When this parameter is specified, the container is run as a user with a <code>uid</code>
2410
2599
  * other than 0. If this parameter isn't specified, so such rule is enforced. This parameter maps to
2411
2600
  * <code>RunAsUser</code> and <code>MustRunAsNonRoot</code> policy in the <a href="https://kubernetes.io/docs/concepts/security/pod-security-policy/#users-and-groups">Users
@@ -2421,15 +2610,18 @@ export interface EksContainerSecurityContext {
2421
2610
  */
2422
2611
  export interface EksContainerVolumeMount {
2423
2612
  /**
2613
+ * @public
2424
2614
  * <p>The name the volume mount. This must match the name of one of the volumes in the
2425
2615
  * pod.</p>
2426
2616
  */
2427
2617
  name?: string;
2428
2618
  /**
2619
+ * @public
2429
2620
  * <p>The path on the container where the volume is mounted.</p>
2430
2621
  */
2431
2622
  mountPath?: string;
2432
2623
  /**
2624
+ * @public
2433
2625
  * <p>If this value is <code>true</code>, the container has read-only access to the volume.
2434
2626
  * Otherwise, the container can write to the volume. The default value is <code>false</code>.</p>
2435
2627
  */
@@ -2443,15 +2635,18 @@ export interface EksContainerVolumeMount {
2443
2635
  */
2444
2636
  export interface EksContainer {
2445
2637
  /**
2638
+ * @public
2446
2639
  * <p>The name of the container. If the name isn't specified, the default name
2447
2640
  * "<code>Default</code>" is used. Each container in a pod must have a unique name.</p>
2448
2641
  */
2449
2642
  name?: string;
2450
2643
  /**
2644
+ * @public
2451
2645
  * <p>The Docker image used to start the container.</p>
2452
2646
  */
2453
2647
  image: string | undefined;
2454
2648
  /**
2649
+ * @public
2455
2650
  * <p>The image pull policy for the container. Supported values are <code>Always</code>,
2456
2651
  * <code>IfNotPresent</code>, and <code>Never</code>. This parameter defaults to
2457
2652
  * <code>IfNotPresent</code>. However, if the <code>:latest</code> tag is specified, it defaults to
@@ -2460,6 +2655,7 @@ export interface EksContainer {
2460
2655
  */
2461
2656
  imagePullPolicy?: string;
2462
2657
  /**
2658
+ * @public
2463
2659
  * <p>The entrypoint for the container. This isn't run within a shell. If this isn't specified,
2464
2660
  * the <code>ENTRYPOINT</code> of the container image is used. Environment variable references are
2465
2661
  * expanded using the container's environment.</p>
@@ -2473,6 +2669,7 @@ export interface EksContainer {
2473
2669
  */
2474
2670
  command?: string[];
2475
2671
  /**
2672
+ * @public
2476
2673
  * <p>An array of arguments to the entrypoint. If this isn't specified, the <code>CMD</code> of
2477
2674
  * the container image is used. This corresponds to the <code>args</code> member in the <a href="https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint">Entrypoint</a> portion of the <a href="https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/">Pod</a>
2478
2675
  * in Kubernetes. Environment variable references are expanded using the container's environment.</p>
@@ -2487,6 +2684,7 @@ export interface EksContainer {
2487
2684
  */
2488
2685
  args?: string[];
2489
2686
  /**
2687
+ * @public
2490
2688
  * <p>The environment variables to pass to a container.</p>
2491
2689
  * <note>
2492
2690
  * <p>Environment variables cannot start with "<code>AWS_BATCH</code>". This naming
@@ -2495,6 +2693,7 @@ export interface EksContainer {
2495
2693
  */
2496
2694
  env?: EksContainerEnvironmentVariable[];
2497
2695
  /**
2696
+ * @public
2498
2697
  * <p>The type and amount of resources to assign to a container. The supported resources include
2499
2698
  * <code>memory</code>, <code>cpu</code>, and <code>nvidia.com/gpu</code>. For more information,
2500
2699
  * see <a href="https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/">Resource management for pods and containers</a> in the <i>Kubernetes
@@ -2502,12 +2701,14 @@ export interface EksContainer {
2502
2701
  */
2503
2702
  resources?: EksContainerResourceRequirements;
2504
2703
  /**
2704
+ * @public
2505
2705
  * <p>The volume mounts for the container. Batch supports <code>emptyDir</code>,
2506
2706
  * <code>hostPath</code>, and <code>secret</code> volume types. For more information about volumes
2507
2707
  * and volume mounts in Kubernetes, see <a href="https://kubernetes.io/docs/concepts/storage/volumes/">Volumes</a> in the <i>Kubernetes documentation</i>.</p>
2508
2708
  */
2509
2709
  volumeMounts?: EksContainerVolumeMount[];
2510
2710
  /**
2711
+ * @public
2511
2712
  * <p>The security context for a job. For more information, see <a href="https://kubernetes.io/docs/tasks/configure-pod-container/security-context/">Configure a
2512
2713
  * security context for a pod or container</a> in the <i>Kubernetes
2513
2714
  * documentation</i>.</p>
@@ -2523,6 +2724,7 @@ export interface EksContainer {
2523
2724
  */
2524
2725
  export interface EksMetadata {
2525
2726
  /**
2727
+ * @public
2526
2728
  * <p>Key-value pairs used to identify, sort, and organize cube resources. Can contain up to 63
2527
2729
  * uppercase letters, lowercase letters, numbers, hyphens (-), and underscores (_). Labels can be
2528
2730
  * added or modified at any time. Each resource can have multiple labels, but each key must be
@@ -2543,6 +2745,7 @@ export interface EksMetadata {
2543
2745
  */
2544
2746
  export interface EksEmptyDir {
2545
2747
  /**
2748
+ * @public
2546
2749
  * <p>The medium to store the volume. The default value is an empty string, which uses the storage
2547
2750
  * of the node.</p>
2548
2751
  * <dl>
@@ -2561,6 +2764,7 @@ export interface EksEmptyDir {
2561
2764
  */
2562
2765
  medium?: string;
2563
2766
  /**
2767
+ * @public
2564
2768
  * <p>The maximum size of the volume. By default, there's no maximum size defined.</p>
2565
2769
  */
2566
2770
  sizeLimit?: string;
@@ -2573,6 +2777,7 @@ export interface EksEmptyDir {
2573
2777
  */
2574
2778
  export interface EksHostPath {
2575
2779
  /**
2780
+ * @public
2576
2781
  * <p>The path of the file or directory on the host to mount into containers on the pod.</p>
2577
2782
  */
2578
2783
  path?: string;
@@ -2585,11 +2790,13 @@ export interface EksHostPath {
2585
2790
  */
2586
2791
  export interface EksSecret {
2587
2792
  /**
2793
+ * @public
2588
2794
  * <p>The name of the secret. The name must be allowed as a DNS subdomain name. For more
2589
2795
  * information, see <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names">DNS subdomain names</a> in the <i>Kubernetes documentation</i>.</p>
2590
2796
  */
2591
2797
  secretName: string | undefined;
2592
2798
  /**
2799
+ * @public
2593
2800
  * <p>Specifies whether the secret or the secret's keys must be defined.</p>
2594
2801
  */
2595
2802
  optional?: boolean;
@@ -2600,23 +2807,27 @@ export interface EksSecret {
2600
2807
  */
2601
2808
  export interface EksVolume {
2602
2809
  /**
2810
+ * @public
2603
2811
  * <p>The name of the volume. The name must be allowed as a DNS subdomain name. For more
2604
2812
  * information, see <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names">DNS subdomain names</a> in the <i>Kubernetes documentation</i>.</p>
2605
2813
  */
2606
2814
  name: string | undefined;
2607
2815
  /**
2816
+ * @public
2608
2817
  * <p>Specifies the configuration of a Kubernetes <code>hostPath</code> volume. For more information,
2609
2818
  * see <a href="https://kubernetes.io/docs/concepts/storage/volumes/#hostpath">hostPath</a>
2610
2819
  * in the <i>Kubernetes documentation</i>.</p>
2611
2820
  */
2612
2821
  hostPath?: EksHostPath;
2613
2822
  /**
2823
+ * @public
2614
2824
  * <p>Specifies the configuration of a Kubernetes <code>emptyDir</code> volume. For more information,
2615
2825
  * see <a href="https://kubernetes.io/docs/concepts/storage/volumes/#emptydir">emptyDir</a>
2616
2826
  * in the <i>Kubernetes documentation</i>.</p>
2617
2827
  */
2618
2828
  emptyDir?: EksEmptyDir;
2619
2829
  /**
2830
+ * @public
2620
2831
  * <p>Specifies the configuration of a Kubernetes <code>secret</code> volume. For more information, see
2621
2832
  * <a href="https://kubernetes.io/docs/concepts/storage/volumes/#secret">secret</a> in the
2622
2833
  * <i>Kubernetes documentation</i>.</p>
@@ -2629,6 +2840,7 @@ export interface EksVolume {
2629
2840
  */
2630
2841
  export interface EksPodProperties {
2631
2842
  /**
2843
+ * @public
2632
2844
  * <p>The name of the service account that's used to run the pod. For more information, see
2633
2845
  * <a href="https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html">Kubernetes service
2634
2846
  * accounts</a> and <a href="https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html">Configure a Kubernetes service account
@@ -2637,6 +2849,7 @@ export interface EksPodProperties {
2637
2849
  */
2638
2850
  serviceAccountName?: string;
2639
2851
  /**
2852
+ * @public
2640
2853
  * <p>Indicates if the pod uses the hosts' network IP address. The default value is
2641
2854
  * <code>true</code>. Setting this to <code>false</code> enables the Kubernetes pod networking model.
2642
2855
  * Most Batch workloads are egress-only and don't require the overhead of IP allocation for each
@@ -2646,6 +2859,7 @@ export interface EksPodProperties {
2646
2859
  */
2647
2860
  hostNetwork?: boolean;
2648
2861
  /**
2862
+ * @public
2649
2863
  * <p>The DNS policy for the pod. The default value is <code>ClusterFirst</code>. If the
2650
2864
  * <code>hostNetwork</code> parameter is not specified, the default is
2651
2865
  * <code>ClusterFirstWithHostNet</code>. <code>ClusterFirst</code> indicates that any DNS query
@@ -2657,14 +2871,17 @@ export interface EksPodProperties {
2657
2871
  */
2658
2872
  dnsPolicy?: string;
2659
2873
  /**
2874
+ * @public
2660
2875
  * <p>The properties of the container that's used on the Amazon EKS pod.</p>
2661
2876
  */
2662
2877
  containers?: EksContainer[];
2663
2878
  /**
2879
+ * @public
2664
2880
  * <p>Specifies the volumes for a job definition that uses Amazon EKS resources.</p>
2665
2881
  */
2666
2882
  volumes?: EksVolume[];
2667
2883
  /**
2884
+ * @public
2668
2885
  * <p>Metadata about the
2669
2886
  * Kubernetes
2670
2887
  * pod. For
@@ -2679,6 +2896,7 @@ export interface EksPodProperties {
2679
2896
  */
2680
2897
  export interface EksProperties {
2681
2898
  /**
2899
+ * @public
2682
2900
  * <p>The properties for the Kubernetes pod resources of a job.</p>
2683
2901
  */
2684
2902
  podProperties?: EksPodProperties;
@@ -2690,6 +2908,7 @@ export interface EksProperties {
2690
2908
  */
2691
2909
  export interface NodeRangeProperty {
2692
2910
  /**
2911
+ * @public
2693
2912
  * <p>The range of nodes, using node index values. A range of <code>0:3</code> indicates nodes
2694
2913
  * with index values of <code>0</code> through <code>3</code>. If the starting range value is
2695
2914
  * omitted (<code>:n</code>), then <code>0</code> is used to start the range. If the ending range
@@ -2700,6 +2919,7 @@ export interface NodeRangeProperty {
2700
2919
  */
2701
2920
  targetNodes: string | undefined;
2702
2921
  /**
2922
+ * @public
2703
2923
  * <p>The container details for the node range.</p>
2704
2924
  */
2705
2925
  container?: ContainerProperties;
@@ -2713,15 +2933,18 @@ export interface NodeRangeProperty {
2713
2933
  */
2714
2934
  export interface NodeProperties {
2715
2935
  /**
2936
+ * @public
2716
2937
  * <p>The number of nodes that are associated with a multi-node parallel job.</p>
2717
2938
  */
2718
2939
  numNodes: number | undefined;
2719
2940
  /**
2941
+ * @public
2720
2942
  * <p>Specifies the node index for the main node of a multi-node parallel job. This node index
2721
2943
  * value must be fewer than the number of nodes.</p>
2722
2944
  */
2723
2945
  mainNode: number | undefined;
2724
2946
  /**
2947
+ * @public
2725
2948
  * <p>A list of node ranges and their properties that are associated with a multi-node parallel
2726
2949
  * job.</p>
2727
2950
  */
@@ -2760,6 +2983,7 @@ export type RetryAction = (typeof RetryAction)[keyof typeof RetryAction];
2760
2983
  */
2761
2984
  export interface EvaluateOnExit {
2762
2985
  /**
2986
+ * @public
2763
2987
  * <p>Contains a glob pattern to match against the <code>StatusReason</code> returned for a job.
2764
2988
  * The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.),
2765
2989
  * colons (:), and white spaces (including spaces or tabs).
@@ -2769,6 +2993,7 @@ export interface EvaluateOnExit {
2769
2993
  */
2770
2994
  onStatusReason?: string;
2771
2995
  /**
2996
+ * @public
2772
2997
  * <p>Contains a glob pattern to match against the <code>Reason</code> returned for a job. The
2773
2998
  * pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons
2774
2999
  * (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so
@@ -2776,6 +3001,7 @@ export interface EvaluateOnExit {
2776
3001
  */
2777
3002
  onReason?: string;
2778
3003
  /**
3004
+ * @public
2779
3005
  * <p>Contains a glob pattern to match against the decimal representation of the
2780
3006
  * <code>ExitCode</code> returned for a job. The pattern can be up to 512 characters long. It can
2781
3007
  * contain only numbers, and can end with an asterisk (*) so that only the start of the string needs
@@ -2784,6 +3010,7 @@ export interface EvaluateOnExit {
2784
3010
  */
2785
3011
  onExitCode?: string;
2786
3012
  /**
3013
+ * @public
2787
3014
  * <p>Specifies the action to take if all of the specified conditions
2788
3015
  * (<code>onStatusReason</code>, <code>onReason</code>, and <code>onExitCode</code>) are met. The
2789
3016
  * values aren't case sensitive.</p>
@@ -2797,12 +3024,14 @@ export interface EvaluateOnExit {
2797
3024
  */
2798
3025
  export interface RetryStrategy {
2799
3026
  /**
3027
+ * @public
2800
3028
  * <p>The number of times to move a job to the <code>RUNNABLE</code> status. You can specify
2801
3029
  * between 1 and 10 attempts. If the value of <code>attempts</code> is greater than one, the job is
2802
3030
  * retried on failure the same number of attempts as the value.</p>
2803
3031
  */
2804
3032
  attempts?: number;
2805
3033
  /**
3034
+ * @public
2806
3035
  * <p>Array of up to 5 objects that specify the conditions where jobs are retried or failed. If
2807
3036
  * this parameter is specified, then the <code>attempts</code> parameter must also be specified. If
2808
3037
  * none of the listed conditions match, then the job is retried.</p>
@@ -2815,6 +3044,7 @@ export interface RetryStrategy {
2815
3044
  */
2816
3045
  export interface JobTimeout {
2817
3046
  /**
3047
+ * @public
2818
3048
  * <p>The job timeout time (in seconds) that's measured from the job attempt's
2819
3049
  * <code>startedAt</code> timestamp. After this time passes, Batch terminates your jobs if they
2820
3050
  * aren't finished. The minimum value for the timeout is 60 seconds.</p>
@@ -2830,22 +3060,27 @@ export interface JobTimeout {
2830
3060
  */
2831
3061
  export interface JobDefinition {
2832
3062
  /**
3063
+ * @public
2833
3064
  * <p>The name of the job definition.</p>
2834
3065
  */
2835
3066
  jobDefinitionName: string | undefined;
2836
3067
  /**
3068
+ * @public
2837
3069
  * <p>The Amazon Resource Name (ARN) for the job definition.</p>
2838
3070
  */
2839
3071
  jobDefinitionArn: string | undefined;
2840
3072
  /**
3073
+ * @public
2841
3074
  * <p>The revision of the job definition.</p>
2842
3075
  */
2843
3076
  revision: number | undefined;
2844
3077
  /**
3078
+ * @public
2845
3079
  * <p>The status of the job definition.</p>
2846
3080
  */
2847
3081
  status?: string;
2848
3082
  /**
3083
+ * @public
2849
3084
  * <p>The type of job definition. It's either <code>container</code> or <code>multinode</code>. If
2850
3085
  * the job is run on Fargate resources, then <code>multinode</code> isn't supported. For more
2851
3086
  * information about multi-node parallel jobs, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html">Creating a multi-node parallel job definition</a> in
@@ -2853,12 +3088,14 @@ export interface JobDefinition {
2853
3088
  */
2854
3089
  type: string | undefined;
2855
3090
  /**
3091
+ * @public
2856
3092
  * <p>The scheduling priority of the job definition. This only affects jobs in job queues with a
2857
3093
  * fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
2858
3094
  * scheduling priority.</p>
2859
3095
  */
2860
3096
  schedulingPriority?: number;
2861
3097
  /**
3098
+ * @public
2862
3099
  * <p>Default parameters or parameter substitution placeholders that are set in the job
2863
3100
  * definition. Parameters are specified as a key-value pair mapping. Parameters in a
2864
3101
  * <code>SubmitJob</code> request override any corresponding parameter defaults from the job
@@ -2867,22 +3104,26 @@ export interface JobDefinition {
2867
3104
  */
2868
3105
  parameters?: Record<string, string>;
2869
3106
  /**
3107
+ * @public
2870
3108
  * <p>The retry strategy to use for failed jobs that are submitted with this job
2871
3109
  * definition.</p>
2872
3110
  */
2873
3111
  retryStrategy?: RetryStrategy;
2874
3112
  /**
3113
+ * @public
2875
3114
  * <p>An object with various properties specific to Amazon ECS based jobs. Valid values are
2876
3115
  * <code>containerProperties</code>, <code>eksProperties</code>, and <code>nodeProperties</code>.
2877
3116
  * Only one can be specified.</p>
2878
3117
  */
2879
3118
  containerProperties?: ContainerProperties;
2880
3119
  /**
3120
+ * @public
2881
3121
  * <p>The timeout time for jobs that are submitted with this job definition. After the amount of
2882
3122
  * time you specify passes, Batch terminates your jobs if they aren't finished.</p>
2883
3123
  */
2884
3124
  timeout?: JobTimeout;
2885
3125
  /**
3126
+ * @public
2886
3127
  * <p>An object with various properties that are specific to multi-node parallel jobs. Valid
2887
3128
  * values are <code>containerProperties</code>, <code>eksProperties</code>, and
2888
3129
  * <code>nodeProperties</code>. Only one can be specified.</p>
@@ -2893,10 +3134,12 @@ export interface JobDefinition {
2893
3134
  */
2894
3135
  nodeProperties?: NodeProperties;
2895
3136
  /**
3137
+ * @public
2896
3138
  * <p>The tags that are applied to the job definition.</p>
2897
3139
  */
2898
3140
  tags?: Record<string, string>;
2899
3141
  /**
3142
+ * @public
2900
3143
  * <p>Specifies whether to propagate the tags from the job or job definition to the corresponding
2901
3144
  * Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to
2902
3145
  * the tasks when the tasks are created. For tags with the same name, job tags are given priority
@@ -2905,18 +3148,21 @@ export interface JobDefinition {
2905
3148
  */
2906
3149
  propagateTags?: boolean;
2907
3150
  /**
3151
+ * @public
2908
3152
  * <p>The platform capabilities required by the job definition. If no value is specified, it
2909
3153
  * defaults to <code>EC2</code>. Jobs run on Fargate resources specify
2910
3154
  * <code>FARGATE</code>.</p>
2911
3155
  */
2912
3156
  platformCapabilities?: (PlatformCapability | string)[];
2913
3157
  /**
3158
+ * @public
2914
3159
  * <p>An object with various properties that are specific to Amazon EKS based jobs. Valid values are
2915
3160
  * <code>containerProperties</code>, <code>eksProperties</code>, and <code>nodeProperties</code>.
2916
3161
  * Only one can be specified.</p>
2917
3162
  */
2918
3163
  eksProperties?: EksProperties;
2919
3164
  /**
3165
+ * @public
2920
3166
  * <p>The orchestration type of the compute environment. The valid values are <code>ECS</code>
2921
3167
  * (default) or <code>EKS</code>.</p>
2922
3168
  */
@@ -2927,10 +3173,12 @@ export interface JobDefinition {
2927
3173
  */
2928
3174
  export interface DescribeJobDefinitionsResponse {
2929
3175
  /**
3176
+ * @public
2930
3177
  * <p>The list of job definitions.</p>
2931
3178
  */
2932
3179
  jobDefinitions?: JobDefinition[];
2933
3180
  /**
3181
+ * @public
2934
3182
  * <p>The <code>nextToken</code> value to include in a future <code>DescribeJobDefinitions</code> request. When the
2935
3183
  * results of a <code>DescribeJobDefinitions</code> request exceed <code>maxResults</code>, this value can be used to
2936
3184
  * retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
@@ -2943,10 +3191,12 @@ export interface DescribeJobDefinitionsResponse {
2943
3191
  */
2944
3192
  export interface DescribeJobQueuesRequest {
2945
3193
  /**
3194
+ * @public
2946
3195
  * <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.</p>
2947
3196
  */
2948
3197
  jobQueues?: string[];
2949
3198
  /**
3199
+ * @public
2950
3200
  * <p>The maximum number of results returned by <code>DescribeJobQueues</code> in paginated output. When this
2951
3201
  * parameter is used, <code>DescribeJobQueues</code> only returns <code>maxResults</code> results in a single page and a
2952
3202
  * <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another
@@ -2956,6 +3206,7 @@ export interface DescribeJobQueuesRequest {
2956
3206
  */
2957
3207
  maxResults?: number;
2958
3208
  /**
3209
+ * @public
2959
3210
  * <p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeJobQueues</code> request where
2960
3211
  * <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the
2961
3212
  * end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when
@@ -2989,20 +3240,24 @@ export type JQStatus = (typeof JQStatus)[keyof typeof JQStatus];
2989
3240
  */
2990
3241
  export interface JobQueueDetail {
2991
3242
  /**
3243
+ * @public
2992
3244
  * <p>The job queue name.</p>
2993
3245
  */
2994
3246
  jobQueueName: string | undefined;
2995
3247
  /**
3248
+ * @public
2996
3249
  * <p>The Amazon Resource Name (ARN) of the job queue.</p>
2997
3250
  */
2998
3251
  jobQueueArn: string | undefined;
2999
3252
  /**
3253
+ * @public
3000
3254
  * <p>Describes the ability of the queue to accept new jobs. If the job queue state is
3001
3255
  * <code>ENABLED</code>, it can accept jobs. If the job queue state is <code>DISABLED</code>, new
3002
3256
  * jobs can't be added to the queue, but jobs already in the queue can finish.</p>
3003
3257
  */
3004
3258
  state: JQState | string | undefined;
3005
3259
  /**
3260
+ * @public
3006
3261
  * <p>The Amazon Resource Name (ARN) of the scheduling policy. The format is
3007
3262
  * <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
3008
3263
  * </code>.
@@ -3011,16 +3266,19 @@ export interface JobQueueDetail {
3011
3266
  */
3012
3267
  schedulingPolicyArn?: string;
3013
3268
  /**
3269
+ * @public
3014
3270
  * <p>The status of the job queue (for example, <code>CREATING</code> or
3015
3271
  * <code>VALID</code>).</p>
3016
3272
  */
3017
3273
  status?: JQStatus | string;
3018
3274
  /**
3275
+ * @public
3019
3276
  * <p>A short, human-readable string to provide additional details for the current status of the
3020
3277
  * job queue.</p>
3021
3278
  */
3022
3279
  statusReason?: string;
3023
3280
  /**
3281
+ * @public
3024
3282
  * <p>The priority of the job queue. Job queues with a higher priority (or a higher integer value
3025
3283
  * for the <code>priority</code> parameter) are evaluated first when associated with the same
3026
3284
  * compute environment. Priority is determined in descending order. For example, a job queue with a
@@ -3031,11 +3289,13 @@ export interface JobQueueDetail {
3031
3289
  */
3032
3290
  priority: number | undefined;
3033
3291
  /**
3292
+ * @public
3034
3293
  * <p>The compute environments that are attached to the job queue and the order that job placement
3035
3294
  * is preferred. Compute environments are selected for job placement in ascending order.</p>
3036
3295
  */
3037
3296
  computeEnvironmentOrder: ComputeEnvironmentOrder[] | undefined;
3038
3297
  /**
3298
+ * @public
3039
3299
  * <p>The tags that are applied to the job queue. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a> in
3040
3300
  * <i>Batch User Guide</i>.</p>
3041
3301
  */
@@ -3046,10 +3306,12 @@ export interface JobQueueDetail {
3046
3306
  */
3047
3307
  export interface DescribeJobQueuesResponse {
3048
3308
  /**
3309
+ * @public
3049
3310
  * <p>The list of job queues.</p>
3050
3311
  */
3051
3312
  jobQueues?: JobQueueDetail[];
3052
3313
  /**
3314
+ * @public
3053
3315
  * <p>The <code>nextToken</code> value to include in a future <code>DescribeJobQueues</code> request. When the results
3054
3316
  * of a <code>DescribeJobQueues</code> request exceed <code>maxResults</code>, this value can be used to retrieve the
3055
3317
  * next page of results. This value is <code>null</code> when there are no more results to return.</p>
@@ -3062,6 +3324,7 @@ export interface DescribeJobQueuesResponse {
3062
3324
  */
3063
3325
  export interface DescribeJobsRequest {
3064
3326
  /**
3327
+ * @public
3065
3328
  * <p>A list of up to 100 job IDs.</p>
3066
3329
  */
3067
3330
  jobs: string[] | undefined;
@@ -3072,10 +3335,12 @@ export interface DescribeJobsRequest {
3072
3335
  */
3073
3336
  export interface ContainerDetail {
3074
3337
  /**
3338
+ * @public
3075
3339
  * <p>The image used to start the container.</p>
3076
3340
  */
3077
3341
  image?: string;
3078
3342
  /**
3343
+ * @public
3079
3344
  * <p>The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can
3080
3345
  * specify the vCPU requirement for the job using <code>resourceRequirements</code>, but you can't
3081
3346
  * specify the vCPU requirements in both the <code>vcpus</code> and
@@ -3092,20 +3357,24 @@ export interface ContainerDetail {
3092
3357
  */
3093
3358
  vcpus?: number;
3094
3359
  /**
3360
+ * @public
3095
3361
  * <p>For jobs running on EC2 resources that didn't specify memory requirements using
3096
3362
  * <code>resourceRequirements</code>, the number of MiB of memory reserved for the job. For other
3097
3363
  * jobs, including all run on Fargate resources, see <code>resourceRequirements</code>.</p>
3098
3364
  */
3099
3365
  memory?: number;
3100
3366
  /**
3367
+ * @public
3101
3368
  * <p>The command that's passed to the container.</p>
3102
3369
  */
3103
3370
  command?: string[];
3104
3371
  /**
3372
+ * @public
3105
3373
  * <p>The Amazon Resource Name (ARN) that's associated with the job when run.</p>
3106
3374
  */
3107
3375
  jobRoleArn?: string;
3108
3376
  /**
3377
+ * @public
3109
3378
  * <p>The Amazon Resource Name (ARN) of the
3110
3379
  * execution
3111
3380
  * role that Batch can assume. For more information,
@@ -3114,10 +3383,12 @@ export interface ContainerDetail {
3114
3383
  */
3115
3384
  executionRoleArn?: string;
3116
3385
  /**
3386
+ * @public
3117
3387
  * <p>A list of volumes that are associated with the job.</p>
3118
3388
  */
3119
3389
  volumes?: Volume[];
3120
3390
  /**
3391
+ * @public
3121
3392
  * <p>The environment variables to pass to a container.</p>
3122
3393
  * <note>
3123
3394
  * <p>Environment variables cannot start with "<code>AWS_BATCH</code>". This naming
@@ -3126,10 +3397,12 @@ export interface ContainerDetail {
3126
3397
  */
3127
3398
  environment?: KeyValuePair[];
3128
3399
  /**
3400
+ * @public
3129
3401
  * <p>The mount points for data volumes in your container.</p>
3130
3402
  */
3131
3403
  mountPoints?: MountPoint[];
3132
3404
  /**
3405
+ * @public
3133
3406
  * <p>When this parameter is true, the container is given read-only access to its root file
3134
3407
  * system. This parameter maps to <code>ReadonlyRootfs</code> in the
3135
3408
  * <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the
@@ -3140,6 +3413,7 @@ export interface ContainerDetail {
3140
3413
  */
3141
3414
  readonlyRootFilesystem?: boolean;
3142
3415
  /**
3416
+ * @public
3143
3417
  * <p>A list of <code>ulimit</code> values to set in the container. This parameter maps to
3144
3418
  * <code>Ulimits</code> in the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a>
3145
3419
  * and the <code>--ulimit</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker
@@ -3150,6 +3424,7 @@ export interface ContainerDetail {
3150
3424
  */
3151
3425
  ulimits?: Ulimit[];
3152
3426
  /**
3427
+ * @public
3153
3428
  * <p>When this parameter is true, the container is given elevated permissions on the host
3154
3429
  * container instance (similar to the <code>root</code> user). The default value is
3155
3430
  * <code>false</code>.</p>
@@ -3160,36 +3435,43 @@ export interface ContainerDetail {
3160
3435
  */
3161
3436
  privileged?: boolean;
3162
3437
  /**
3438
+ * @public
3163
3439
  * <p>The user name to use inside the container. This parameter maps to <code>User</code> in the
3164
3440
  * <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the <code>--user</code>
3165
3441
  * option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>.</p>
3166
3442
  */
3167
3443
  user?: string;
3168
3444
  /**
3445
+ * @public
3169
3446
  * <p>The exit code to return upon completion.</p>
3170
3447
  */
3171
3448
  exitCode?: number;
3172
3449
  /**
3450
+ * @public
3173
3451
  * <p>A short (255 max characters) human-readable string to provide additional details for a
3174
3452
  * running or stopped container.</p>
3175
3453
  */
3176
3454
  reason?: string;
3177
3455
  /**
3456
+ * @public
3178
3457
  * <p>The Amazon Resource Name (ARN) of the container instance that the container is running on.</p>
3179
3458
  */
3180
3459
  containerInstanceArn?: string;
3181
3460
  /**
3461
+ * @public
3182
3462
  * <p>The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container
3183
3463
  * attempt receives a task ARN when they reach the <code>STARTING</code> status.</p>
3184
3464
  */
3185
3465
  taskArn?: string;
3186
3466
  /**
3467
+ * @public
3187
3468
  * <p>The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for
3188
3469
  * Batch jobs is <code>/aws/batch/job</code>. Each container attempt receives a log stream name
3189
3470
  * when they reach the <code>RUNNING</code> status.</p>
3190
3471
  */
3191
3472
  logStreamName?: string;
3192
3473
  /**
3474
+ * @public
3193
3475
  * <p>The instance type of the underlying host infrastructure of a multi-node parallel job.</p>
3194
3476
  * <note>
3195
3477
  * <p>This parameter isn't applicable to jobs that are running on Fargate resources.</p>
@@ -3197,20 +3479,24 @@ export interface ContainerDetail {
3197
3479
  */
3198
3480
  instanceType?: string;
3199
3481
  /**
3482
+ * @public
3200
3483
  * <p>The network interfaces that are associated with the job.</p>
3201
3484
  */
3202
3485
  networkInterfaces?: NetworkInterface[];
3203
3486
  /**
3487
+ * @public
3204
3488
  * <p>The type and amount of resources to assign to a container. The supported resources include
3205
3489
  * <code>GPU</code>, <code>MEMORY</code>, and <code>VCPU</code>.</p>
3206
3490
  */
3207
3491
  resourceRequirements?: ResourceRequirement[];
3208
3492
  /**
3493
+ * @public
3209
3494
  * <p>Linux-specific modifications that are applied to the container, such as details for device
3210
3495
  * mappings.</p>
3211
3496
  */
3212
3497
  linuxParameters?: LinuxParameters;
3213
3498
  /**
3499
+ * @public
3214
3500
  * <p>The log configuration specification for the container.</p>
3215
3501
  * <p>This parameter maps to <code>LogConfig</code> in the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a>
3216
3502
  * section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the <code>--log-driver</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. By default, containers use the same logging
@@ -3240,27 +3526,32 @@ export interface ContainerDetail {
3240
3526
  */
3241
3527
  logConfiguration?: LogConfiguration;
3242
3528
  /**
3529
+ * @public
3243
3530
  * <p>The secrets to pass to the container. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html">Specifying sensitive data</a> in the
3244
3531
  * <i>Batch User Guide</i>.</p>
3245
3532
  */
3246
3533
  secrets?: Secret[];
3247
3534
  /**
3535
+ * @public
3248
3536
  * <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
3249
3537
  * running on EC2 resources must not specify this parameter.</p>
3250
3538
  */
3251
3539
  networkConfiguration?: NetworkConfiguration;
3252
3540
  /**
3541
+ * @public
3253
3542
  * <p>The platform configuration for jobs that are running on Fargate resources. Jobs that are
3254
3543
  * running on EC2 resources must not specify this parameter.</p>
3255
3544
  */
3256
3545
  fargatePlatformConfiguration?: FargatePlatformConfiguration;
3257
3546
  /**
3547
+ * @public
3258
3548
  * <p>The amount of ephemeral storage allocated for the task. This parameter is used to expand the
3259
3549
  * total amount of ephemeral storage available, beyond the default amount, for tasks hosted on
3260
3550
  * Fargate.</p>
3261
3551
  */
3262
3552
  ephemeralStorage?: EphemeralStorage;
3263
3553
  /**
3554
+ * @public
3264
3555
  * <p>An object that represents the compute environment architecture for Batch jobs on Fargate.</p>
3265
3556
  */
3266
3557
  runtimePlatform?: RuntimePlatform;
@@ -3271,10 +3562,12 @@ export interface ContainerDetail {
3271
3562
  */
3272
3563
  export interface JobDependency {
3273
3564
  /**
3565
+ * @public
3274
3566
  * <p>The job ID of the Batch job that's associated with this dependency.</p>
3275
3567
  */
3276
3568
  jobId?: string;
3277
3569
  /**
3570
+ * @public
3278
3571
  * <p>The type of the job dependency.</p>
3279
3572
  */
3280
3573
  type?: ArrayJobDependency | string;
@@ -3286,10 +3579,12 @@ export interface JobDependency {
3286
3579
  */
3287
3580
  export interface EksAttemptContainerDetail {
3288
3581
  /**
3582
+ * @public
3289
3583
  * <p>The exit code for the job attempt. A non-zero exit code is considered failed.</p>
3290
3584
  */
3291
3585
  exitCode?: number;
3292
3586
  /**
3587
+ * @public
3293
3588
  * <p>A short (255 max characters) human-readable string to provide additional details for a
3294
3589
  * running or stopped container.</p>
3295
3590
  */
@@ -3302,29 +3597,35 @@ export interface EksAttemptContainerDetail {
3302
3597
  */
3303
3598
  export interface EksAttemptDetail {
3304
3599
  /**
3600
+ * @public
3305
3601
  * <p>The details for the final status of the containers for this job attempt.</p>
3306
3602
  */
3307
3603
  containers?: EksAttemptContainerDetail[];
3308
3604
  /**
3605
+ * @public
3309
3606
  * <p>The name of the pod for this job attempt.</p>
3310
3607
  */
3311
3608
  podName?: string;
3312
3609
  /**
3610
+ * @public
3313
3611
  * <p>The name of the node for this job attempt.</p>
3314
3612
  */
3315
3613
  nodeName?: string;
3316
3614
  /**
3615
+ * @public
3317
3616
  * <p>The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt
3318
3617
  * transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>
3319
3618
  */
3320
3619
  startedAt?: number;
3321
3620
  /**
3621
+ * @public
3322
3622
  * <p>The Unix timestamp (in milliseconds) for when the attempt was stopped. This happens when the
3323
3623
  * attempt transitioned from the <code>RUNNING</code> state to a terminal state, such as
3324
3624
  * <code>SUCCEEDED</code> or <code>FAILED</code>.</p>
3325
3625
  */
3326
3626
  stoppedAt?: number;
3327
3627
  /**
3628
+ * @public
3328
3629
  * <p>A short, human-readable string to provide additional details for the current status of the
3329
3630
  * job attempt.</p>
3330
3631
  */
@@ -3337,15 +3638,18 @@ export interface EksAttemptDetail {
3337
3638
  */
3338
3639
  export interface EksContainerDetail {
3339
3640
  /**
3641
+ * @public
3340
3642
  * <p>The name of the container. If the name isn't specified, the default name
3341
3643
  * "<code>Default</code>" is used. Each container in a pod must have a unique name.</p>
3342
3644
  */
3343
3645
  name?: string;
3344
3646
  /**
3647
+ * @public
3345
3648
  * <p>The Docker image used to start the container.</p>
3346
3649
  */
3347
3650
  image?: string;
3348
3651
  /**
3652
+ * @public
3349
3653
  * <p>The image pull policy for the container. Supported values are <code>Always</code>,
3350
3654
  * <code>IfNotPresent</code>, and <code>Never</code>. This parameter defaults to
3351
3655
  * <code>Always</code> if the <code>:latest</code> tag is specified, <code>IfNotPresent</code>
@@ -3354,10 +3658,12 @@ export interface EksContainerDetail {
3354
3658
  */
3355
3659
  imagePullPolicy?: string;
3356
3660
  /**
3661
+ * @public
3357
3662
  * <p>The entrypoint for the container. For more information, see <a href="https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint">Entrypoint</a> in the <i>Kubernetes documentation</i>.</p>
3358
3663
  */
3359
3664
  command?: string[];
3360
3665
  /**
3666
+ * @public
3361
3667
  * <p>An array of arguments to the entrypoint. If this isn't specified, the <code>CMD</code> of
3362
3668
  * the container image is used. This corresponds to the <code>args</code> member in the <a href="https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#entrypoint">Entrypoint</a> portion of the <a href="https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/">Pod</a>
3363
3669
  * in Kubernetes. Environment variable references are expanded using the container's environment.</p>
@@ -3372,6 +3678,7 @@ export interface EksContainerDetail {
3372
3678
  */
3373
3679
  args?: string[];
3374
3680
  /**
3681
+ * @public
3375
3682
  * <p>The environment variables to pass to a container.</p>
3376
3683
  * <note>
3377
3684
  * <p>Environment variables cannot start with "<code>AWS_BATCH</code>". This naming
@@ -3380,6 +3687,7 @@ export interface EksContainerDetail {
3380
3687
  */
3381
3688
  env?: EksContainerEnvironmentVariable[];
3382
3689
  /**
3690
+ * @public
3383
3691
  * <p>The type and amount of resources to assign to a container. The supported resources include
3384
3692
  * <code>memory</code>, <code>cpu</code>, and <code>nvidia.com/gpu</code>. For more information,
3385
3693
  * see <a href="https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/">Resource management for pods and containers</a> in the <i>Kubernetes
@@ -3387,21 +3695,25 @@ export interface EksContainerDetail {
3387
3695
  */
3388
3696
  resources?: EksContainerResourceRequirements;
3389
3697
  /**
3698
+ * @public
3390
3699
  * <p>The exit code for the job attempt. A non-zero exit code is considered failed.</p>
3391
3700
  */
3392
3701
  exitCode?: number;
3393
3702
  /**
3703
+ * @public
3394
3704
  * <p>A short human-readable string to provide additional details for a running or stopped
3395
3705
  * container. It can be up to 255 characters long.</p>
3396
3706
  */
3397
3707
  reason?: string;
3398
3708
  /**
3709
+ * @public
3399
3710
  * <p>The volume mounts for the container. Batch supports <code>emptyDir</code>,
3400
3711
  * <code>hostPath</code>, and <code>secret</code> volume types. For more information about volumes
3401
3712
  * and volume mounts in Kubernetes, see <a href="https://kubernetes.io/docs/concepts/storage/volumes/">Volumes</a> in the <i>Kubernetes documentation</i>.</p>
3402
3713
  */
3403
3714
  volumeMounts?: EksContainerVolumeMount[];
3404
3715
  /**
3716
+ * @public
3405
3717
  * <p>The security context for a job. For more information, see <a href="https://kubernetes.io/docs/tasks/configure-pod-container/security-context/">Configure a
3406
3718
  * security context for a pod or container</a> in the <i>Kubernetes
3407
3719
  * documentation</i>.</p>
@@ -3414,6 +3726,7 @@ export interface EksContainerDetail {
3414
3726
  */
3415
3727
  export interface EksPodPropertiesDetail {
3416
3728
  /**
3729
+ * @public
3417
3730
  * <p>The name of the service account that's used to run the pod. For more information, see
3418
3731
  * <a href="https://docs.aws.amazon.com/eks/latest/userguide/service-accounts.html">Kubernetes service
3419
3732
  * accounts</a> and <a href="https://docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html">Configure a Kubernetes service account
@@ -3422,6 +3735,7 @@ export interface EksPodPropertiesDetail {
3422
3735
  */
3423
3736
  serviceAccountName?: string;
3424
3737
  /**
3738
+ * @public
3425
3739
  * <p>Indicates if the pod uses the hosts' network IP address. The default value is
3426
3740
  * <code>true</code>. Setting this to <code>false</code> enables the Kubernetes pod networking model.
3427
3741
  * Most Batch workloads are egress-only and don't require the overhead of IP allocation for each
@@ -3431,6 +3745,7 @@ export interface EksPodPropertiesDetail {
3431
3745
  */
3432
3746
  hostNetwork?: boolean;
3433
3747
  /**
3748
+ * @public
3434
3749
  * <p>The DNS policy for the pod. The default value is <code>ClusterFirst</code>. If the
3435
3750
  * <code>hostNetwork</code> parameter is not specified, the default is
3436
3751
  * <code>ClusterFirstWithHostNet</code>. <code>ClusterFirst</code> indicates that any DNS query
@@ -3446,22 +3761,27 @@ export interface EksPodPropertiesDetail {
3446
3761
  */
3447
3762
  dnsPolicy?: string;
3448
3763
  /**
3764
+ * @public
3449
3765
  * <p>The properties of the container that's used on the Amazon EKS pod.</p>
3450
3766
  */
3451
3767
  containers?: EksContainerDetail[];
3452
3768
  /**
3769
+ * @public
3453
3770
  * <p>Specifies the volumes for a job definition using Amazon EKS resources.</p>
3454
3771
  */
3455
3772
  volumes?: EksVolume[];
3456
3773
  /**
3774
+ * @public
3457
3775
  * <p>The name of the pod for this job.</p>
3458
3776
  */
3459
3777
  podName?: string;
3460
3778
  /**
3779
+ * @public
3461
3780
  * <p>The name of the node for this job.</p>
3462
3781
  */
3463
3782
  nodeName?: string;
3464
3783
  /**
3784
+ * @public
3465
3785
  * <p>Describes and uniquely identifies Kubernetes resources. For example, the compute environment
3466
3786
  * that a pod runs in or the <code>jobID</code> for a job running in the pod. For more information,
3467
3787
  * see <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/">Understanding Kubernetes Objects</a> in the <i>Kubernetes
@@ -3475,6 +3795,7 @@ export interface EksPodPropertiesDetail {
3475
3795
  */
3476
3796
  export interface EksPropertiesDetail {
3477
3797
  /**
3798
+ * @public
3478
3799
  * <p>The properties for the Kubernetes pod resources of a job.</p>
3479
3800
  */
3480
3801
  podProperties?: EksPodPropertiesDetail;
@@ -3485,11 +3806,13 @@ export interface EksPropertiesDetail {
3485
3806
  */
3486
3807
  export interface NodeDetails {
3487
3808
  /**
3809
+ * @public
3488
3810
  * <p>The node index for the node. Node index numbering starts at zero. This index is also
3489
3811
  * available on the node with the <code>AWS_BATCH_JOB_NODE_INDEX</code> environment variable.</p>
3490
3812
  */
3491
3813
  nodeIndex?: number;
3492
3814
  /**
3815
+ * @public
3493
3816
  * <p>Specifies whether the current node is the main node for a multi-node parallel job.</p>
3494
3817
  */
3495
3818
  isMainNode?: boolean;
@@ -3517,22 +3840,27 @@ export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
3517
3840
  */
3518
3841
  export interface JobDetail {
3519
3842
  /**
3843
+ * @public
3520
3844
  * <p>The Amazon Resource Name (ARN) of the job.</p>
3521
3845
  */
3522
3846
  jobArn?: string;
3523
3847
  /**
3848
+ * @public
3524
3849
  * <p>The job name.</p>
3525
3850
  */
3526
3851
  jobName: string | undefined;
3527
3852
  /**
3853
+ * @public
3528
3854
  * <p>The job ID.</p>
3529
3855
  */
3530
3856
  jobId: string | undefined;
3531
3857
  /**
3858
+ * @public
3532
3859
  * <p>The Amazon Resource Name (ARN) of the job queue that the job is associated with.</p>
3533
3860
  */
3534
3861
  jobQueue: string | undefined;
3535
3862
  /**
3863
+ * @public
3536
3864
  * <p>The current status for the job.</p>
3537
3865
  * <note>
3538
3866
  * <p>If your jobs don't progress to <code>STARTING</code>, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#job_stuck_in_runnable">Jobs stuck in RUNNABLE
@@ -3542,25 +3870,30 @@ export interface JobDetail {
3542
3870
  */
3543
3871
  status: JobStatus | string | undefined;
3544
3872
  /**
3873
+ * @public
3545
3874
  * <p>The share identifier for the job.</p>
3546
3875
  */
3547
3876
  shareIdentifier?: string;
3548
3877
  /**
3878
+ * @public
3549
3879
  * <p>The scheduling policy of the job definition. This only affects jobs in job queues with a
3550
3880
  * fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
3551
3881
  * scheduling priority.</p>
3552
3882
  */
3553
3883
  schedulingPriority?: number;
3554
3884
  /**
3885
+ * @public
3555
3886
  * <p>A list of job attempts that are associated with this job.</p>
3556
3887
  */
3557
3888
  attempts?: AttemptDetail[];
3558
3889
  /**
3890
+ * @public
3559
3891
  * <p>A short, human-readable string to provide more details for the current status of the
3560
3892
  * job.</p>
3561
3893
  */
3562
3894
  statusReason?: string;
3563
3895
  /**
3896
+ * @public
3564
3897
  * <p>The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and
3565
3898
  * parent array jobs, this is when the job entered the <code>SUBMITTED</code> state. This is
3566
3899
  * specifically at the time <a>SubmitJob</a> was called. For array child jobs, this is
@@ -3568,45 +3901,54 @@ export interface JobDetail {
3568
3901
  */
3569
3902
  createdAt?: number;
3570
3903
  /**
3904
+ * @public
3571
3905
  * <p>The retry strategy to use for this job if an attempt fails.</p>
3572
3906
  */
3573
3907
  retryStrategy?: RetryStrategy;
3574
3908
  /**
3909
+ * @public
3575
3910
  * <p>The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's
3576
3911
  * when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state.
3577
3912
  * This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.</p>
3578
3913
  */
3579
3914
  startedAt: number | undefined;
3580
3915
  /**
3916
+ * @public
3581
3917
  * <p>The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's
3582
3918
  * when the job transitioned from the <code>RUNNING</code> state to a terminal state, such as
3583
3919
  * <code>SUCCEEDED</code> or <code>FAILED</code>.</p>
3584
3920
  */
3585
3921
  stoppedAt?: number;
3586
3922
  /**
3923
+ * @public
3587
3924
  * <p>A list of job IDs that this job depends on.</p>
3588
3925
  */
3589
3926
  dependsOn?: JobDependency[];
3590
3927
  /**
3928
+ * @public
3591
3929
  * <p>The Amazon Resource Name (ARN) of the job definition that this job uses.</p>
3592
3930
  */
3593
3931
  jobDefinition: string | undefined;
3594
3932
  /**
3933
+ * @public
3595
3934
  * <p>Additional parameters that are passed to the job that replace parameter substitution
3596
3935
  * placeholders or override any corresponding parameter defaults from the job definition.</p>
3597
3936
  */
3598
3937
  parameters?: Record<string, string>;
3599
3938
  /**
3939
+ * @public
3600
3940
  * <p>An object that represents the details for the container that's associated with the
3601
3941
  * job.</p>
3602
3942
  */
3603
3943
  container?: ContainerDetail;
3604
3944
  /**
3945
+ * @public
3605
3946
  * <p>An object that represents the details of a node that's associated with a multi-node parallel
3606
3947
  * job.</p>
3607
3948
  */
3608
3949
  nodeDetails?: NodeDetails;
3609
3950
  /**
3951
+ * @public
3610
3952
  * <p>An object that represents the node properties of a multi-node parallel job.</p>
3611
3953
  * <note>
3612
3954
  * <p>This isn't applicable to jobs that are running on Fargate resources.</p>
@@ -3614,18 +3956,22 @@ export interface JobDetail {
3614
3956
  */
3615
3957
  nodeProperties?: NodeProperties;
3616
3958
  /**
3959
+ * @public
3617
3960
  * <p>The array properties of the job, if it's an array job.</p>
3618
3961
  */
3619
3962
  arrayProperties?: ArrayPropertiesDetail;
3620
3963
  /**
3964
+ * @public
3621
3965
  * <p>The timeout configuration for the job.</p>
3622
3966
  */
3623
3967
  timeout?: JobTimeout;
3624
3968
  /**
3969
+ * @public
3625
3970
  * <p>The tags that are applied to the job.</p>
3626
3971
  */
3627
3972
  tags?: Record<string, string>;
3628
3973
  /**
3974
+ * @public
3629
3975
  * <p>Specifies whether to propagate the tags from the job or job definition to the corresponding
3630
3976
  * Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to
3631
3977
  * the tasks when the tasks are created. For tags with the same name, job tags are given priority
@@ -3634,26 +3980,31 @@ export interface JobDetail {
3634
3980
  */
3635
3981
  propagateTags?: boolean;
3636
3982
  /**
3983
+ * @public
3637
3984
  * <p>The platform capabilities required by the job definition. If no value is specified, it
3638
3985
  * defaults to <code>EC2</code>. Jobs run on Fargate resources specify
3639
3986
  * <code>FARGATE</code>.</p>
3640
3987
  */
3641
3988
  platformCapabilities?: (PlatformCapability | string)[];
3642
3989
  /**
3990
+ * @public
3643
3991
  * <p>An object with various properties that are specific to Amazon EKS based jobs. Only one of
3644
3992
  * <code>container</code>, <code>eksProperties</code>, or <code>nodeDetails</code> is
3645
3993
  * specified.</p>
3646
3994
  */
3647
3995
  eksProperties?: EksPropertiesDetail;
3648
3996
  /**
3997
+ * @public
3649
3998
  * <p>A list of job attempts that are associated with this job.</p>
3650
3999
  */
3651
4000
  eksAttempts?: EksAttemptDetail[];
3652
4001
  /**
4002
+ * @public
3653
4003
  * <p>Indicates whether the job is canceled.</p>
3654
4004
  */
3655
4005
  isCancelled?: boolean;
3656
4006
  /**
4007
+ * @public
3657
4008
  * <p>Indicates whether the job is terminated.</p>
3658
4009
  */
3659
4010
  isTerminated?: boolean;
@@ -3663,6 +4014,7 @@ export interface JobDetail {
3663
4014
  */
3664
4015
  export interface DescribeJobsResponse {
3665
4016
  /**
4017
+ * @public
3666
4018
  * <p>The list of jobs.</p>
3667
4019
  */
3668
4020
  jobs?: JobDetail[];
@@ -3673,6 +4025,7 @@ export interface DescribeJobsResponse {
3673
4025
  */
3674
4026
  export interface DescribeSchedulingPoliciesRequest {
3675
4027
  /**
4028
+ * @public
3676
4029
  * <p>A list of up to 100 scheduling policy Amazon Resource Name (ARN) entries.</p>
3677
4030
  */
3678
4031
  arns: string[] | undefined;
@@ -3683,20 +4036,24 @@ export interface DescribeSchedulingPoliciesRequest {
3683
4036
  */
3684
4037
  export interface SchedulingPolicyDetail {
3685
4038
  /**
4039
+ * @public
3686
4040
  * <p>The name of the scheduling policy.</p>
3687
4041
  */
3688
4042
  name: string | undefined;
3689
4043
  /**
4044
+ * @public
3690
4045
  * <p>The Amazon Resource Name (ARN) of the scheduling policy. An example is
3691
4046
  * <code>arn:<i>aws</i>:batch:<i>us-east-1</i>:<i>123456789012</i>:scheduling-policy/<i>HighPriority</i>
3692
4047
  * </code>.</p>
3693
4048
  */
3694
4049
  arn: string | undefined;
3695
4050
  /**
4051
+ * @public
3696
4052
  * <p>The fair share policy for the scheduling policy.</p>
3697
4053
  */
3698
4054
  fairsharePolicy?: FairsharePolicy;
3699
4055
  /**
4056
+ * @public
3700
4057
  * <p>The tags that you apply to the scheduling policy to categorize and organize your resources.
3701
4058
  * Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in
3702
4059
  * <i>Amazon Web Services General Reference</i>.</p>
@@ -3708,6 +4065,7 @@ export interface SchedulingPolicyDetail {
3708
4065
  */
3709
4066
  export interface DescribeSchedulingPoliciesResponse {
3710
4067
  /**
4068
+ * @public
3711
4069
  * <p>The list of scheduling policies.</p>
3712
4070
  */
3713
4071
  schedulingPolicies?: SchedulingPolicyDetail[];
@@ -3719,10 +4077,12 @@ export interface DescribeSchedulingPoliciesResponse {
3719
4077
  */
3720
4078
  export interface KeyValuesPair {
3721
4079
  /**
4080
+ * @public
3722
4081
  * <p>The name of the filter. Filter names are case sensitive.</p>
3723
4082
  */
3724
4083
  name?: string;
3725
4084
  /**
4085
+ * @public
3726
4086
  * <p>The filter values.</p>
3727
4087
  */
3728
4088
  values?: string[];
@@ -3733,26 +4093,31 @@ export interface KeyValuesPair {
3733
4093
  */
3734
4094
  export interface ListJobsRequest {
3735
4095
  /**
4096
+ * @public
3736
4097
  * <p>The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.</p>
3737
4098
  */
3738
4099
  jobQueue?: string;
3739
4100
  /**
4101
+ * @public
3740
4102
  * <p>The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the
3741
4103
  * specified array.</p>
3742
4104
  */
3743
4105
  arrayJobId?: string;
3744
4106
  /**
4107
+ * @public
3745
4108
  * <p>The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all
3746
4109
  * nodes that are associated with the specified job.</p>
3747
4110
  */
3748
4111
  multiNodeJobId?: string;
3749
4112
  /**
4113
+ * @public
3750
4114
  * <p>The job status used to filter jobs in the specified queue. If the <code>filters</code> parameter is specified,
3751
4115
  * the <code>jobStatus</code> parameter is ignored and jobs with any status are returned. If you don't specify a status,
3752
4116
  * only <code>RUNNING</code> jobs are returned.</p>
3753
4117
  */
3754
4118
  jobStatus?: JobStatus | string;
3755
4119
  /**
4120
+ * @public
3756
4121
  * <p>The maximum number of results returned by <code>ListJobs</code> in paginated output. When this parameter is
3757
4122
  * used, <code>ListJobs</code> only returns <code>maxResults</code> results in a single page and a
3758
4123
  * <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another
@@ -3762,6 +4127,7 @@ export interface ListJobsRequest {
3762
4127
  */
3763
4128
  maxResults?: number;
3764
4129
  /**
4130
+ * @public
3765
4131
  * <p>The <code>nextToken</code> value returned from a previous paginated <code>ListJobs</code> request where
3766
4132
  * <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the
3767
4133
  * end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when
@@ -3773,6 +4139,7 @@ export interface ListJobsRequest {
3773
4139
  */
3774
4140
  nextToken?: string;
3775
4141
  /**
4142
+ * @public
3776
4143
  * <p>The filter to apply to the query. Only one filter can be used at a time. When the filter is used,
3777
4144
  * <code>jobStatus</code> is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP)
3778
4145
  * jobs. The results are sorted by the <code>createdAt</code> field, with the most recent jobs being first.</p>
@@ -3820,10 +4187,12 @@ export interface ListJobsRequest {
3820
4187
  */
3821
4188
  export interface ContainerSummary {
3822
4189
  /**
4190
+ * @public
3823
4191
  * <p>The exit code to return upon completion.</p>
3824
4192
  */
3825
4193
  exitCode?: number;
3826
4194
  /**
4195
+ * @public
3827
4196
  * <p>A short (255 max characters) human-readable string to provide additional details for a
3828
4197
  * running or stopped container.</p>
3829
4198
  */
@@ -3836,14 +4205,17 @@ export interface ContainerSummary {
3836
4205
  */
3837
4206
  export interface NodePropertiesSummary {
3838
4207
  /**
4208
+ * @public
3839
4209
  * <p>Specifies whether the current node is the main node for a multi-node parallel job.</p>
3840
4210
  */
3841
4211
  isMainNode?: boolean;
3842
4212
  /**
4213
+ * @public
3843
4214
  * <p>The number of nodes that are associated with a multi-node parallel job.</p>
3844
4215
  */
3845
4216
  numNodes?: number;
3846
4217
  /**
4218
+ * @public
3847
4219
  * <p>The node index for the node. Node index numbering begins at zero. This index is also
3848
4220
  * available on the node with the <code>AWS_BATCH_JOB_NODE_INDEX</code> environment variable.</p>
3849
4221
  */
@@ -3855,18 +4227,22 @@ export interface NodePropertiesSummary {
3855
4227
  */
3856
4228
  export interface JobSummary {
3857
4229
  /**
4230
+ * @public
3858
4231
  * <p>The Amazon Resource Name (ARN) of the job.</p>
3859
4232
  */
3860
4233
  jobArn?: string;
3861
4234
  /**
4235
+ * @public
3862
4236
  * <p>The job ID.</p>
3863
4237
  */
3864
4238
  jobId: string | undefined;
3865
4239
  /**
4240
+ * @public
3866
4241
  * <p>The job name.</p>
3867
4242
  */
3868
4243
  jobName: string | undefined;
3869
4244
  /**
4245
+ * @public
3870
4246
  * <p>The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and
3871
4247
  * parent array jobs, this is when the job entered the <code>SUBMITTED</code> state (at the time
3872
4248
  * <a>SubmitJob</a> was called). For array child jobs, this is when the child job was
@@ -3874,35 +4250,42 @@ export interface JobSummary {
3874
4250
  */
3875
4251
  createdAt?: number;
3876
4252
  /**
4253
+ * @public
3877
4254
  * <p>The current status for the job.</p>
3878
4255
  */
3879
4256
  status?: JobStatus | string;
3880
4257
  /**
4258
+ * @public
3881
4259
  * <p>A short, human-readable string to provide more details for the current status of the
3882
4260
  * job.</p>
3883
4261
  */
3884
4262
  statusReason?: string;
3885
4263
  /**
4264
+ * @public
3886
4265
  * <p>The Unix timestamp for when the job was started. More specifically, it's when the job
3887
4266
  * transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state.</p>
3888
4267
  */
3889
4268
  startedAt?: number;
3890
4269
  /**
4270
+ * @public
3891
4271
  * <p>The Unix timestamp for when the job was stopped. More specifically, it's when the job
3892
4272
  * transitioned from the <code>RUNNING</code> state to a terminal state, such as
3893
4273
  * <code>SUCCEEDED</code> or <code>FAILED</code>.</p>
3894
4274
  */
3895
4275
  stoppedAt?: number;
3896
4276
  /**
4277
+ * @public
3897
4278
  * <p>An object that represents the details of the container that's associated with the
3898
4279
  * job.</p>
3899
4280
  */
3900
4281
  container?: ContainerSummary;
3901
4282
  /**
4283
+ * @public
3902
4284
  * <p>The array properties of the job, if it's an array job.</p>
3903
4285
  */
3904
4286
  arrayProperties?: ArrayPropertiesSummary;
3905
4287
  /**
4288
+ * @public
3906
4289
  * <p>The node properties for a single node in a job summary list.</p>
3907
4290
  * <note>
3908
4291
  * <p>This isn't applicable to jobs that are running on Fargate resources.</p>
@@ -3910,6 +4293,7 @@ export interface JobSummary {
3910
4293
  */
3911
4294
  nodeProperties?: NodePropertiesSummary;
3912
4295
  /**
4296
+ * @public
3913
4297
  * <p>The Amazon Resource Name (ARN) of the job definition.</p>
3914
4298
  */
3915
4299
  jobDefinition?: string;
@@ -3919,10 +4303,12 @@ export interface JobSummary {
3919
4303
  */
3920
4304
  export interface ListJobsResponse {
3921
4305
  /**
4306
+ * @public
3922
4307
  * <p>A list of job summaries that match the request.</p>
3923
4308
  */
3924
4309
  jobSummaryList: JobSummary[] | undefined;
3925
4310
  /**
4311
+ * @public
3926
4312
  * <p>The <code>nextToken</code> value to include in a future <code>ListJobs</code> request. When the results of a
3927
4313
  * <code>ListJobs</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of
3928
4314
  * results. This value is <code>null</code> when there are no more results to return.</p>
@@ -3935,6 +4321,7 @@ export interface ListJobsResponse {
3935
4321
  */
3936
4322
  export interface ListSchedulingPoliciesRequest {
3937
4323
  /**
4324
+ * @public
3938
4325
  * <p>The maximum number of results that's returned by <code>ListSchedulingPolicies</code> in paginated output. When
3939
4326
  * this parameter is used, <code>ListSchedulingPolicies</code> only returns <code>maxResults</code> results in a single
3940
4327
  * page and a <code>nextToken</code> response element. You can see the remaining results of the initial request by
@@ -3945,6 +4332,7 @@ export interface ListSchedulingPoliciesRequest {
3945
4332
  */
3946
4333
  maxResults?: number;
3947
4334
  /**
4335
+ * @public
3948
4336
  * <p>The <code>nextToken</code> value that's returned from a previous paginated
3949
4337
  * <code>ListSchedulingPolicies</code> request where <code>maxResults</code> was used and the
3950
4338
  * results exceeded the value of that parameter. Pagination continues from the end of the
@@ -3964,6 +4352,7 @@ export interface ListSchedulingPoliciesRequest {
3964
4352
  */
3965
4353
  export interface SchedulingPolicyListingDetail {
3966
4354
  /**
4355
+ * @public
3967
4356
  * <p>Amazon Resource Name (ARN) of the scheduling policy.</p>
3968
4357
  */
3969
4358
  arn: string | undefined;
@@ -3973,10 +4362,12 @@ export interface SchedulingPolicyListingDetail {
3973
4362
  */
3974
4363
  export interface ListSchedulingPoliciesResponse {
3975
4364
  /**
4365
+ * @public
3976
4366
  * <p>A list of scheduling policies that match the request.</p>
3977
4367
  */
3978
4368
  schedulingPolicies?: SchedulingPolicyListingDetail[];
3979
4369
  /**
4370
+ * @public
3980
4371
  * <p>The <code>nextToken</code> value to include in a future <code>ListSchedulingPolicies</code> request. When the
3981
4372
  * results of a <code>ListSchedulingPolicies</code> request exceed <code>maxResults</code>, this value can be used to
3982
4373
  * retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
@@ -3989,6 +4380,7 @@ export interface ListSchedulingPoliciesResponse {
3989
4380
  */
3990
4381
  export interface ListTagsForResourceRequest {
3991
4382
  /**
4383
+ * @public
3992
4384
  * <p>The Amazon Resource Name (ARN) that identifies the resource that tags are listed for. Batch resources that support tags are compute environments, jobs, job definitions, job queues,
3993
4385
  * and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.</p>
3994
4386
  */
@@ -3999,6 +4391,7 @@ export interface ListTagsForResourceRequest {
3999
4391
  */
4000
4392
  export interface ListTagsForResourceResponse {
4001
4393
  /**
4394
+ * @public
4002
4395
  * <p>The tags for the resource.</p>
4003
4396
  */
4004
4397
  tags?: Record<string, string>;
@@ -4021,11 +4414,13 @@ export type JobDefinitionType = (typeof JobDefinitionType)[keyof typeof JobDefin
4021
4414
  */
4022
4415
  export interface RegisterJobDefinitionRequest {
4023
4416
  /**
4417
+ * @public
4024
4418
  * <p>The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and
4025
4419
  * lowercase letters, numbers, hyphens (-), and underscores (_).</p>
4026
4420
  */
4027
4421
  jobDefinitionName: string | undefined;
4028
4422
  /**
4423
+ * @public
4029
4424
  * <p>The type of job definition. For more information about multi-node parallel jobs, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html">Creating a multi-node parallel job definition</a> in the
4030
4425
  * <i>Batch User Guide</i>.</p>
4031
4426
  * <note>
@@ -4034,12 +4429,14 @@ export interface RegisterJobDefinitionRequest {
4034
4429
  */
4035
4430
  type: JobDefinitionType | string | undefined;
4036
4431
  /**
4432
+ * @public
4037
4433
  * <p>Default parameter substitution placeholders to set in the job definition. Parameters are specified as a
4038
4434
  * key-value pair mapping. Parameters in a <code>SubmitJob</code> request override any corresponding parameter defaults
4039
4435
  * from the job definition.</p>
4040
4436
  */
4041
4437
  parameters?: Record<string, string>;
4042
4438
  /**
4439
+ * @public
4043
4440
  * <p>The scheduling priority for jobs that are submitted with this job definition. This only affects jobs in job
4044
4441
  * queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
4045
4442
  * scheduling priority.</p>
@@ -4047,6 +4444,7 @@ export interface RegisterJobDefinitionRequest {
4047
4444
  */
4048
4445
  schedulingPriority?: number;
4049
4446
  /**
4447
+ * @public
4050
4448
  * <p>An object with various properties specific to Amazon ECS based single-node container-based jobs. If the job
4051
4449
  * definition's <code>type</code> parameter is <code>container</code>, then you must specify either
4052
4450
  * <code>containerProperties</code> or <code>nodeProperties</code>. This must not be specified for Amazon EKS based job
@@ -4058,6 +4456,7 @@ export interface RegisterJobDefinitionRequest {
4058
4456
  */
4059
4457
  containerProperties?: ContainerProperties;
4060
4458
  /**
4459
+ * @public
4061
4460
  * <p>An object with various properties specific to multi-node parallel jobs. If you specify node properties for a
4062
4461
  * job, it becomes a multi-node parallel job. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html">Multi-node Parallel Jobs</a> in the
4063
4462
  * <i>Batch User Guide</i>. If the job definition's <code>type</code> parameter is <code>container</code>,
@@ -4072,12 +4471,14 @@ export interface RegisterJobDefinitionRequest {
4072
4471
  */
4073
4472
  nodeProperties?: NodeProperties;
4074
4473
  /**
4474
+ * @public
4075
4475
  * <p>The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's
4076
4476
  * specified during a <a>SubmitJob</a> operation overrides the retry strategy defined here. If a job is
4077
4477
  * terminated due to a timeout, it isn't retried.</p>
4078
4478
  */
4079
4479
  retryStrategy?: RetryStrategy;
4080
4480
  /**
4481
+ * @public
4081
4482
  * <p>Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no
4082
4483
  * value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For
4083
4484
  * tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags
@@ -4088,6 +4489,7 @@ export interface RegisterJobDefinitionRequest {
4088
4489
  */
4089
4490
  propagateTags?: boolean;
4090
4491
  /**
4492
+ * @public
4091
4493
  * <p>The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates
4092
4494
  * your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for
4093
4495
  * the timeout is 60 seconds. Any timeout configuration that's specified during a <a>SubmitJob</a> operation
@@ -4095,11 +4497,13 @@ export interface RegisterJobDefinitionRequest {
4095
4497
  */
4096
4498
  timeout?: JobTimeout;
4097
4499
  /**
4500
+ * @public
4098
4501
  * <p>The tags that you apply to the job definition to help you categorize and organize your resources. Each tag
4099
4502
  * consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging Amazon Web Services Resources</a> in <i>Batch User Guide</i>.</p>
4100
4503
  */
4101
4504
  tags?: Record<string, string>;
4102
4505
  /**
4506
+ * @public
4103
4507
  * <p>The platform capabilities required by the job definition. If no value is specified, it defaults to
4104
4508
  * <code>EC2</code>. To run the job on Fargate resources, specify <code>FARGATE</code>.</p>
4105
4509
  * <note>
@@ -4108,6 +4512,7 @@ export interface RegisterJobDefinitionRequest {
4108
4512
  */
4109
4513
  platformCapabilities?: (PlatformCapability | string)[];
4110
4514
  /**
4515
+ * @public
4111
4516
  * <p>An object with various properties that are specific to Amazon EKS based jobs. This must not be specified for Amazon ECS
4112
4517
  * based job definitions.</p>
4113
4518
  */
@@ -4118,14 +4523,17 @@ export interface RegisterJobDefinitionRequest {
4118
4523
  */
4119
4524
  export interface RegisterJobDefinitionResponse {
4120
4525
  /**
4526
+ * @public
4121
4527
  * <p>The name of the job definition.</p>
4122
4528
  */
4123
4529
  jobDefinitionName: string | undefined;
4124
4530
  /**
4531
+ * @public
4125
4532
  * <p>The Amazon Resource Name (ARN) of the job definition.</p>
4126
4533
  */
4127
4534
  jobDefinitionArn: string | undefined;
4128
4535
  /**
4536
+ * @public
4129
4537
  * <p>The revision of the job definition.</p>
4130
4538
  */
4131
4539
  revision: number | undefined;
@@ -4138,6 +4546,7 @@ export interface RegisterJobDefinitionResponse {
4138
4546
  */
4139
4547
  export interface ContainerOverrides {
4140
4548
  /**
4549
+ * @public
4141
4550
  * @deprecated
4142
4551
  *
4143
4552
  * <p>This parameter is deprecated, use <code>resourceRequirements</code> to override the
@@ -4153,6 +4562,7 @@ export interface ContainerOverrides {
4153
4562
  */
4154
4563
  vcpus?: number;
4155
4564
  /**
4565
+ * @public
4156
4566
  * @deprecated
4157
4567
  *
4158
4568
  * <p>This parameter is deprecated, use <code>resourceRequirements</code> to override the memory
@@ -4168,6 +4578,7 @@ export interface ContainerOverrides {
4168
4578
  */
4169
4579
  memory?: number;
4170
4580
  /**
4581
+ * @public
4171
4582
  * <p>The command to send to the container that overrides the default command from the Docker
4172
4583
  * image or the job definition.</p>
4173
4584
  * <note>
@@ -4176,6 +4587,7 @@ export interface ContainerOverrides {
4176
4587
  */
4177
4588
  command?: string[];
4178
4589
  /**
4590
+ * @public
4179
4591
  * <p>The instance type to use for a multi-node parallel job.</p>
4180
4592
  * <note>
4181
4593
  * <p>This parameter isn't applicable to single-node container jobs or jobs that run on Fargate
@@ -4184,6 +4596,7 @@ export interface ContainerOverrides {
4184
4596
  */
4185
4597
  instanceType?: string;
4186
4598
  /**
4599
+ * @public
4187
4600
  * <p>The environment variables to send to the container. You can add new environment variables,
4188
4601
  * which are added to the container at launch, or you can override the existing environment
4189
4602
  * variables from the Docker image or the job definition.</p>
@@ -4194,6 +4607,7 @@ export interface ContainerOverrides {
4194
4607
  */
4195
4608
  environment?: KeyValuePair[];
4196
4609
  /**
4610
+ * @public
4197
4611
  * <p>The type and amount of resources to assign to a container. This overrides the settings in
4198
4612
  * the job definition. The supported resources include <code>GPU</code>, <code>MEMORY</code>, and
4199
4613
  * <code>VCPU</code>.</p>
@@ -4206,15 +4620,18 @@ export interface ContainerOverrides {
4206
4620
  */
4207
4621
  export interface EksContainerOverride {
4208
4622
  /**
4623
+ * @public
4209
4624
  * <p>The override of the Docker image that's used to start the container.</p>
4210
4625
  */
4211
4626
  image?: string;
4212
4627
  /**
4628
+ * @public
4213
4629
  * <p>The command to send to the container that overrides the default command from the Docker
4214
4630
  * image or the job definition.</p>
4215
4631
  */
4216
4632
  command?: string[];
4217
4633
  /**
4634
+ * @public
4218
4635
  * <p>The arguments to the entrypoint to send to the container that overrides the default
4219
4636
  * arguments from the Docker image or the job definition. For more information, see <a href="https://docs.docker.com/engine/reference/builder/#cmd">CMD</a> in the
4220
4637
  * <i>Dockerfile reference</i> and <a href="https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/">Define a command an arguments for a pod</a> in the <i>Kubernetes
@@ -4222,6 +4639,7 @@ export interface EksContainerOverride {
4222
4639
  */
4223
4640
  args?: string[];
4224
4641
  /**
4642
+ * @public
4225
4643
  * <p>The environment variables to send to the container. You can add new environment variables,
4226
4644
  * which are added to the container at launch. Or, you can override the existing environment
4227
4645
  * variables from the Docker image or the job definition.</p>
@@ -4232,6 +4650,7 @@ export interface EksContainerOverride {
4232
4650
  */
4233
4651
  env?: EksContainerEnvironmentVariable[];
4234
4652
  /**
4653
+ * @public
4235
4654
  * <p>The type and amount of resources to assign to a container. These override the settings in
4236
4655
  * the job definition. The supported resources include <code>memory</code>, <code>cpu</code>, and
4237
4656
  * <code>nvidia.com/gpu</code>. For more information, see <a href="https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/">Resource
@@ -4246,10 +4665,12 @@ export interface EksContainerOverride {
4246
4665
  */
4247
4666
  export interface EksPodPropertiesOverride {
4248
4667
  /**
4668
+ * @public
4249
4669
  * <p>The overrides for the container that's used on the Amazon EKS pod.</p>
4250
4670
  */
4251
4671
  containers?: EksContainerOverride[];
4252
4672
  /**
4673
+ * @public
4253
4674
  * <p>Metadata about the
4254
4675
  * overrides for the container that's used on the Amazon EKS pod.</p>
4255
4676
  */
@@ -4261,6 +4682,7 @@ export interface EksPodPropertiesOverride {
4261
4682
  */
4262
4683
  export interface EksPropertiesOverride {
4263
4684
  /**
4685
+ * @public
4264
4686
  * <p>The overrides for the Kubernetes pod resources of a job.</p>
4265
4687
  */
4266
4688
  podProperties?: EksPodPropertiesOverride;
@@ -4271,6 +4693,7 @@ export interface EksPropertiesOverride {
4271
4693
  */
4272
4694
  export interface NodePropertyOverride {
4273
4695
  /**
4696
+ * @public
4274
4697
  * <p>The range of nodes, using node index values, that's used to override. A range of
4275
4698
  * <code>0:3</code> indicates nodes with index values of <code>0</code> through <code>3</code>. If
4276
4699
  * the starting range value is omitted (<code>:n</code>), then <code>0</code> is used to start the
@@ -4279,6 +4702,7 @@ export interface NodePropertyOverride {
4279
4702
  */
4280
4703
  targetNodes: string | undefined;
4281
4704
  /**
4705
+ * @public
4282
4706
  * <p>The overrides that are sent to a node range.</p>
4283
4707
  */
4284
4708
  containerOverrides?: ContainerOverrides;
@@ -4293,6 +4717,7 @@ export interface NodePropertyOverride {
4293
4717
  */
4294
4718
  export interface NodeOverrides {
4295
4719
  /**
4720
+ * @public
4296
4721
  * <p>The number of nodes to use with a multi-node parallel job. This value overrides the number
4297
4722
  * of nodes that are specified in the job definition. To use this override, you must meet the
4298
4723
  * following conditions:</p>
@@ -4313,6 +4738,7 @@ export interface NodeOverrides {
4313
4738
  */
4314
4739
  numNodes?: number;
4315
4740
  /**
4741
+ * @public
4316
4742
  * <p>The node property overrides for the job.</p>
4317
4743
  */
4318
4744
  nodePropertyOverrides?: NodePropertyOverride[];
@@ -4323,15 +4749,18 @@ export interface NodeOverrides {
4323
4749
  */
4324
4750
  export interface SubmitJobRequest {
4325
4751
  /**
4752
+ * @public
4326
4753
  * <p>The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain
4327
4754
  * uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).</p>
4328
4755
  */
4329
4756
  jobName: string | undefined;
4330
4757
  /**
4758
+ * @public
4331
4759
  * <p>The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.</p>
4332
4760
  */
4333
4761
  jobQueue: string | undefined;
4334
4762
  /**
4763
+ * @public
4335
4764
  * <p>The share identifier for the job. Don't specify this parameter if the job queue doesn't
4336
4765
  * have a scheduling policy. If the job queue has a scheduling policy, then this parameter must
4337
4766
  * be specified.</p>
@@ -4340,6 +4769,7 @@ export interface SubmitJobRequest {
4340
4769
  */
4341
4770
  shareIdentifier?: string;
4342
4771
  /**
4772
+ * @public
4343
4773
  * <p>The scheduling priority for the job. This only affects jobs in job queues with a fair share policy. Jobs with a
4344
4774
  * higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling
4345
4775
  * priority in the job definition.</p>
@@ -4347,12 +4777,14 @@ export interface SubmitJobRequest {
4347
4777
  */
4348
4778
  schedulingPriorityOverride?: number;
4349
4779
  /**
4780
+ * @public
4350
4781
  * <p>The array properties for the submitted job, such as the size of the array. The array size can be between 2 and
4351
4782
  * 10,000. If you specify array properties for a job, it becomes an array job. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html">Array Jobs</a> in the
4352
4783
  * <i>Batch User Guide</i>.</p>
4353
4784
  */
4354
4785
  arrayProperties?: ArrayProperties;
4355
4786
  /**
4787
+ * @public
4356
4788
  * <p>A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a
4357
4789
  * <code>SEQUENTIAL</code> type dependency without specifying a job ID for array jobs so that each child array job
4358
4790
  * completes sequentially, starting at index 0. You can also specify an <code>N_TO_N</code> type dependency with a job
@@ -4361,6 +4793,7 @@ export interface SubmitJobRequest {
4361
4793
  */
4362
4794
  dependsOn?: JobDependency[];
4363
4795
  /**
4796
+ * @public
4364
4797
  * <p>The job definition used by this job. This value can be one of <code>definition-name</code>,
4365
4798
  * <code>definition-name:revision</code>, or the Amazon Resource Name (ARN) for the job definition, with or without the revision
4366
4799
  * (<code>arn:aws:batch:<i>region</i>:<i>account</i>:job-definition/<i>definition-name</i>:<i>revision</i>
@@ -4372,12 +4805,14 @@ export interface SubmitJobRequest {
4372
4805
  */
4373
4806
  jobDefinition: string | undefined;
4374
4807
  /**
4808
+ * @public
4375
4809
  * <p>Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job
4376
4810
  * definition. Parameters are specified as a key and value pair mapping. Parameters in a <code>SubmitJob</code> request
4377
4811
  * override any corresponding parameter defaults from the job definition.</p>
4378
4812
  */
4379
4813
  parameters?: Record<string, string>;
4380
4814
  /**
4815
+ * @public
4381
4816
  * <p>An object with various properties that override the defaults for the job definition that specify the name of a
4382
4817
  * container in the specified job definition and the overrides it should receive. You can override the default command
4383
4818
  * for a container, which is specified in the job definition or the Docker image, with a <code>command</code> override.
@@ -4386,6 +4821,7 @@ export interface SubmitJobRequest {
4386
4821
  */
4387
4822
  containerOverrides?: ContainerOverrides;
4388
4823
  /**
4824
+ * @public
4389
4825
  * <p>A list of node overrides in JSON format that specify the node range to target and the container overrides for
4390
4826
  * that node range.</p>
4391
4827
  * <note>
@@ -4395,11 +4831,13 @@ export interface SubmitJobRequest {
4395
4831
  */
4396
4832
  nodeOverrides?: NodeOverrides;
4397
4833
  /**
4834
+ * @public
4398
4835
  * <p>The retry strategy to use for failed jobs from this <a>SubmitJob</a> operation. When a retry strategy
4399
4836
  * is specified here, it overrides the retry strategy defined in the job definition.</p>
4400
4837
  */
4401
4838
  retryStrategy?: RetryStrategy;
4402
4839
  /**
4840
+ * @public
4403
4841
  * <p>Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no
4404
4842
  * value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For
4405
4843
  * tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags
@@ -4408,6 +4846,7 @@ export interface SubmitJobRequest {
4408
4846
  */
4409
4847
  propagateTags?: boolean;
4410
4848
  /**
4849
+ * @public
4411
4850
  * <p>The timeout configuration for this <a>SubmitJob</a> operation. You can specify a timeout duration
4412
4851
  * after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't
4413
4852
  * retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration
@@ -4417,12 +4856,14 @@ export interface SubmitJobRequest {
4417
4856
  */
4418
4857
  timeout?: JobTimeout;
4419
4858
  /**
4859
+ * @public
4420
4860
  * <p>The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists
4421
4861
  * of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in <i>Amazon Web Services General
4422
4862
  * Reference</i>.</p>
4423
4863
  */
4424
4864
  tags?: Record<string, string>;
4425
4865
  /**
4866
+ * @public
4426
4867
  * <p>An object that can only be specified for jobs that are run on Amazon EKS resources with various properties that
4427
4868
  * override defaults for the job definition.</p>
4428
4869
  */
@@ -4433,14 +4874,17 @@ export interface SubmitJobRequest {
4433
4874
  */
4434
4875
  export interface SubmitJobResponse {
4435
4876
  /**
4877
+ * @public
4436
4878
  * <p>The Amazon Resource Name (ARN) for the job.</p>
4437
4879
  */
4438
4880
  jobArn?: string;
4439
4881
  /**
4882
+ * @public
4440
4883
  * <p>The name of the job.</p>
4441
4884
  */
4442
4885
  jobName: string | undefined;
4443
4886
  /**
4887
+ * @public
4444
4888
  * <p>The unique identifier for the job.</p>
4445
4889
  */
4446
4890
  jobId: string | undefined;
@@ -4451,11 +4895,13 @@ export interface SubmitJobResponse {
4451
4895
  */
4452
4896
  export interface TagResourceRequest {
4453
4897
  /**
4898
+ * @public
4454
4899
  * <p>The Amazon Resource Name (ARN) of the resource that tags are added to. Batch resources that support tags are compute environments, jobs, job definitions, job queues,
4455
4900
  * and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.</p>
4456
4901
  */
4457
4902
  resourceArn: string | undefined;
4458
4903
  /**
4904
+ * @public
4459
4905
  * <p>The tags that you apply to the resource to help you categorize and organize your resources. Each tag consists of
4460
4906
  * a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in <i>Amazon Web Services General
4461
4907
  * Reference</i>.</p>
@@ -4473,10 +4919,12 @@ export interface TagResourceResponse {
4473
4919
  */
4474
4920
  export interface TerminateJobRequest {
4475
4921
  /**
4922
+ * @public
4476
4923
  * <p>The Batch job ID of the job to terminate.</p>
4477
4924
  */
4478
4925
  jobId: string | undefined;
4479
4926
  /**
4927
+ * @public
4480
4928
  * <p>A message to attach to the job that explains the reason for canceling it. This message is returned by future
4481
4929
  * <a>DescribeJobs</a> operations on the job. This message is also recorded in the Batch activity
4482
4930
  * logs.</p>
@@ -4494,11 +4942,13 @@ export interface TerminateJobResponse {
4494
4942
  */
4495
4943
  export interface UntagResourceRequest {
4496
4944
  /**
4945
+ * @public
4497
4946
  * <p>The Amazon Resource Name (ARN) of the resource from which to delete tags. Batch resources that support tags are compute environments, jobs, job definitions, job queues,
4498
4947
  * and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.</p>
4499
4948
  */
4500
4949
  resourceArn: string | undefined;
4501
4950
  /**
4951
+ * @public
4502
4952
  * <p>The keys of the tags to be removed.</p>
4503
4953
  */
4504
4954
  tagKeys: string[] | undefined;
@@ -4515,6 +4965,7 @@ export interface UntagResourceResponse {
4515
4965
  export declare const CRUpdateAllocationStrategy: {
4516
4966
  readonly BEST_FIT_PROGRESSIVE: "BEST_FIT_PROGRESSIVE";
4517
4967
  readonly SPOT_CAPACITY_OPTIMIZED: "SPOT_CAPACITY_OPTIMIZED";
4968
+ readonly SPOT_PRICE_CAPACITY_OPTIMIZED: "SPOT_PRICE_CAPACITY_OPTIMIZED";
4518
4969
  };
4519
4970
  /**
4520
4971
  * @public
@@ -4528,6 +4979,7 @@ export type CRUpdateAllocationStrategy = (typeof CRUpdateAllocationStrategy)[key
4528
4979
  */
4529
4980
  export interface ComputeResourceUpdate {
4530
4981
  /**
4982
+ * @public
4531
4983
  * <p>The minimum number of
4532
4984
  * vCPUs that
4533
4985
  * an environment should maintain (even if the compute environment is <code>DISABLED</code>).</p>
@@ -4537,9 +4989,10 @@ export interface ComputeResourceUpdate {
4537
4989
  */
4538
4990
  minvCpus?: number;
4539
4991
  /**
4992
+ * @public
4540
4993
  * <p>The maximum number of Amazon EC2 vCPUs that an environment can reach.</p>
4541
4994
  * <note>
4542
- * <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code>
4995
+ * <p>With <code>BEST_FIT_PROGRESSIVE</code>, <code>SPOT_CAPACITY_OPTIMIZED</code>, and <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
4543
4996
  * allocation strategies using On-Demand or Spot Instances, and the <code>BEST_FIT</code> strategy
4544
4997
  * using Spot Instances, Batch might need to exceed <code>maxvCpus</code> to meet your capacity
4545
4998
  * requirements. In this event, Batch never exceeds <code>maxvCpus</code> by more than a single
@@ -4549,6 +5002,7 @@ export interface ComputeResourceUpdate {
4549
5002
  */
4550
5003
  maxvCpus?: number;
4551
5004
  /**
5005
+ * @public
4552
5006
  * <p>The desired number of
4553
5007
  * vCPUS in the
4554
5008
  * compute environment. Batch modifies this value between the minimum and maximum values based on
@@ -4570,6 +5024,7 @@ export interface ComputeResourceUpdate {
4570
5024
  */
4571
5025
  desiredvCpus?: number;
4572
5026
  /**
5027
+ * @public
4573
5028
  * <p>The VPC subnets where the compute resources are launched. Fargate compute resources can
4574
5029
  * contain up to 16 subnets. For Fargate compute resources, providing an empty list will be
4575
5030
  * handled as if this parameter wasn't specified and no change is made. For EC2 compute resources,
@@ -4590,6 +5045,7 @@ export interface ComputeResourceUpdate {
4590
5045
  */
4591
5046
  subnets?: string[];
4592
5047
  /**
5048
+ * @public
4593
5049
  * <p>The Amazon EC2 security groups that are associated with instances launched in the compute
4594
5050
  * environment. This parameter is required for Fargate compute resources, where it can contain up
4595
5051
  * to 5 security groups. For Fargate compute resources, providing an empty list is handled as if
@@ -4601,6 +5057,7 @@ export interface ComputeResourceUpdate {
4601
5057
  */
4602
5058
  securityGroupIds?: string[];
4603
5059
  /**
5060
+ * @public
4604
5061
  * <p>The allocation strategy to use for the compute resource if there's not enough instances of
4605
5062
  * the best fitting instance type that can be allocated. This might be because of availability of
4606
5063
  * the instance type in the Region or <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html">Amazon EC2 service limits</a>. For more
@@ -4627,14 +5084,22 @@ export interface ComputeResourceUpdate {
4627
5084
  * interrupted. This allocation strategy is only available for Spot Instance compute
4628
5085
  * resources.</p>
4629
5086
  * </dd>
5087
+ * <dt>SPOT_PRICE_CAPACITY_OPTIMIZED</dt>
5088
+ * <dd>
5089
+ * <p>The price and capacity optimized allocation strategy looks at both price and capacity to
5090
+ * select the Spot Instance pools that are the least likely to be interrupted and have the lowest
5091
+ * possible price. This allocation strategy is only available for Spot Instance compute
5092
+ * resources.</p>
5093
+ * </dd>
4630
5094
  * </dl>
4631
- * <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code>
5095
+ * <p>With both <code>BEST_FIT_PROGRESSIVE</code>, <code>SPOT_CAPACITY_OPTIMIZED</code>, and <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
4632
5096
  * strategies using On-Demand or Spot Instances, and the <code>BEST_FIT</code> strategy using Spot
4633
5097
  * Instances, Batch might need to exceed <code>maxvCpus</code> to meet your capacity requirements.
4634
5098
  * In this event, Batch never exceeds <code>maxvCpus</code> by more than a single instance.</p>
4635
5099
  */
4636
5100
  allocationStrategy?: CRUpdateAllocationStrategy | string;
4637
5101
  /**
5102
+ * @public
4638
5103
  * <p>The instances types that can be launched. You can specify instance families to launch any
4639
5104
  * instance type within those families (for example, <code>c5</code> or <code>p3</code>), or you can
4640
5105
  * specify specific sizes within a family (such as <code>c5.8xlarge</code>). You can also choose
@@ -4659,6 +5124,7 @@ export interface ComputeResourceUpdate {
4659
5124
  */
4660
5125
  instanceTypes?: string[];
4661
5126
  /**
5127
+ * @public
4662
5128
  * <p>The Amazon EC2 key pair that's used for instances launched in the compute environment. You can
4663
5129
  * use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this
4664
5130
  * value to an empty string.</p>
@@ -4671,6 +5137,7 @@ export interface ComputeResourceUpdate {
4671
5137
  */
4672
5138
  ec2KeyPair?: string;
4673
5139
  /**
5140
+ * @public
4674
5141
  * <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can
4675
5142
  * specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example,
4676
5143
  * <code>
@@ -4688,6 +5155,7 @@ export interface ComputeResourceUpdate {
4688
5155
  */
4689
5156
  instanceRole?: string;
4690
5157
  /**
5158
+ * @public
4691
5159
  * <p>Key-value pair tags to be applied to EC2 resources that are launched in the compute
4692
5160
  * environment. For Batch, these take the form of <code>"String1": "String2"</code>, where
4693
5161
  * <code>String1</code> is the tag key and <code>String2</code> is the tag value-for example,
@@ -4703,6 +5171,7 @@ export interface ComputeResourceUpdate {
4703
5171
  */
4704
5172
  tags?: Record<string, string>;
4705
5173
  /**
5174
+ * @public
4706
5175
  * <p>The Amazon EC2 placement group to associate with your compute resources. If you intend to submit
4707
5176
  * multi-node parallel jobs to your compute environment, you should consider creating a cluster
4708
5177
  * placement group and associate it with your compute resources. This keeps your multi-node parallel
@@ -4718,6 +5187,7 @@ export interface ComputeResourceUpdate {
4718
5187
  */
4719
5188
  placementGroup?: string;
4720
5189
  /**
5190
+ * @public
4721
5191
  * <p>The maximum percentage that a Spot Instance price can be when compared with the On-Demand
4722
5192
  * price for that instance type before instances are launched. For example, if your maximum
4723
5193
  * percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that
@@ -4733,6 +5203,7 @@ export interface ComputeResourceUpdate {
4733
5203
  */
4734
5204
  bidPercentage?: number;
4735
5205
  /**
5206
+ * @public
4736
5207
  * <p>The updated launch template to use for your compute resources. You must specify either the
4737
5208
  * launch template ID or launch template name in the request, but not both. For more information,
4738
5209
  * see <a href="https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html">Launch template
@@ -4751,6 +5222,7 @@ export interface ComputeResourceUpdate {
4751
5222
  */
4752
5223
  launchTemplate?: LaunchTemplateSpecification;
4753
5224
  /**
5225
+ * @public
4754
5226
  * <p>Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the
4755
5227
  * compute environment. If <code>Ec2Configuration</code> isn't specified, the default is
4756
5228
  * <code>ECS_AL2</code>.</p>
@@ -4765,6 +5237,7 @@ export interface ComputeResourceUpdate {
4765
5237
  */
4766
5238
  ec2Configuration?: Ec2Configuration[];
4767
5239
  /**
5240
+ * @public
4768
5241
  * <p>Specifies whether the AMI ID is updated to the latest one that's supported by Batch when
4769
5242
  * the compute environment has an infrastructure update. The default value is
4770
5243
  * <code>false</code>.</p>
@@ -4782,6 +5255,7 @@ export interface ComputeResourceUpdate {
4782
5255
  */
4783
5256
  updateToLatestImageVersion?: boolean;
4784
5257
  /**
5258
+ * @public
4785
5259
  * <p>The type of compute environment: <code>EC2</code>, <code>SPOT</code>, <code>FARGATE</code>,
4786
5260
  * or <code>FARGATE_SPOT</code>. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute environments</a> in the
4787
5261
  * <i>Batch User Guide</i>.</p>
@@ -4794,6 +5268,7 @@ export interface ComputeResourceUpdate {
4794
5268
  */
4795
5269
  type?: CRType | string;
4796
5270
  /**
5271
+ * @public
4797
5272
  * <p>The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
4798
5273
  * This parameter is overridden by the <code>imageIdOverride</code> member of the
4799
5274
  * <code>Ec2Configuration</code> structure. To remove the custom AMI ID and use the default AMI ID,
@@ -4821,10 +5296,12 @@ export interface ComputeResourceUpdate {
4821
5296
  */
4822
5297
  export interface UpdateComputeEnvironmentRequest {
4823
5298
  /**
5299
+ * @public
4824
5300
  * <p>The name or full Amazon Resource Name (ARN) of the compute environment to update.</p>
4825
5301
  */
4826
5302
  computeEnvironment: string | undefined;
4827
5303
  /**
5304
+ * @public
4828
5305
  * <p>The state of the compute environment. Compute environments in the <code>ENABLED</code>
4829
5306
  * state can accept jobs from a queue and scale in or out automatically based on the workload
4830
5307
  * demand of its associated queues.</p>
@@ -4849,6 +5326,7 @@ export interface UpdateComputeEnvironmentRequest {
4849
5326
  */
4850
5327
  state?: CEState | string;
4851
5328
  /**
5329
+ * @public
4852
5330
  * <p>The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this
4853
5331
  * parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU
4854
5332
  * capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is
@@ -4856,12 +5334,14 @@ export interface UpdateComputeEnvironmentRequest {
4856
5334
  */
4857
5335
  unmanagedvCpus?: number;
4858
5336
  /**
5337
+ * @public
4859
5338
  * <p>Details of the compute resources managed by the compute environment. Required for a managed compute environment.
4860
5339
  * For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute
4861
5340
  * Environments</a> in the <i>Batch User Guide</i>.</p>
4862
5341
  */
4863
5342
  computeResources?: ComputeResourceUpdate;
4864
5343
  /**
5344
+ * @public
4865
5345
  * <p>The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf.
4866
5346
  * For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM
4867
5347
  * role</a> in the <i>Batch User Guide</i>.</p>
@@ -4883,6 +5363,7 @@ export interface UpdateComputeEnvironmentRequest {
4883
5363
  */
4884
5364
  serviceRole?: string;
4885
5365
  /**
5366
+ * @public
4886
5367
  * <p>Specifies the updated infrastructure update policy for the compute environment. For more information about
4887
5368
  * infrastructure updates, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating
4888
5369
  * compute environments</a> in the <i>Batch User Guide</i>.</p>
@@ -4894,11 +5375,13 @@ export interface UpdateComputeEnvironmentRequest {
4894
5375
  */
4895
5376
  export interface UpdateComputeEnvironmentResponse {
4896
5377
  /**
5378
+ * @public
4897
5379
  * <p>The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and
4898
5380
  * lowercase letters, numbers, hyphens (-), and underscores (_).</p>
4899
5381
  */
4900
5382
  computeEnvironmentName?: string;
4901
5383
  /**
5384
+ * @public
4902
5385
  * <p>The Amazon Resource Name (ARN) of the compute environment.</p>
4903
5386
  */
4904
5387
  computeEnvironmentArn?: string;
@@ -4909,16 +5392,19 @@ export interface UpdateComputeEnvironmentResponse {
4909
5392
  */
4910
5393
  export interface UpdateJobQueueRequest {
4911
5394
  /**
5395
+ * @public
4912
5396
  * <p>The name or the Amazon Resource Name (ARN) of the job queue.</p>
4913
5397
  */
4914
5398
  jobQueue: string | undefined;
4915
5399
  /**
5400
+ * @public
4916
5401
  * <p>Describes the queue's ability to accept new jobs. If the job queue state is <code>ENABLED</code>, it can accept
4917
5402
  * jobs. If the job queue state is <code>DISABLED</code>, new jobs can't be added to the queue, but jobs already in the
4918
5403
  * queue can finish.</p>
4919
5404
  */
4920
5405
  state?: JQState | string;
4921
5406
  /**
5407
+ * @public
4922
5408
  * <p>Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can
4923
5409
  * be replaced but not removed. The format is
4924
5410
  * <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
@@ -4928,6 +5414,7 @@ export interface UpdateJobQueueRequest {
4928
5414
  */
4929
5415
  schedulingPolicyArn?: string;
4930
5416
  /**
5417
+ * @public
4931
5418
  * <p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the
4932
5419
  * <code>priority</code> parameter) are evaluated first when associated with the same compute environment. Priority is
4933
5420
  * determined in descending order. For example, a job queue with a priority value of <code>10</code> is given scheduling
@@ -4937,6 +5424,7 @@ export interface UpdateJobQueueRequest {
4937
5424
  */
4938
5425
  priority?: number;
4939
5426
  /**
5427
+ * @public
4940
5428
  * <p>Details the set of compute environments mapped to a job queue and their order relative to each other. This is
4941
5429
  * one of the parameters used by the job scheduler to determine which compute environment runs a given job. Compute
4942
5430
  * environments must be in the <code>VALID</code> state before you can associate them with a job queue. All of
@@ -4954,10 +5442,12 @@ export interface UpdateJobQueueRequest {
4954
5442
  */
4955
5443
  export interface UpdateJobQueueResponse {
4956
5444
  /**
5445
+ * @public
4957
5446
  * <p>The name of the job queue.</p>
4958
5447
  */
4959
5448
  jobQueueName?: string;
4960
5449
  /**
5450
+ * @public
4961
5451
  * <p>The Amazon Resource Name (ARN) of the job queue.</p>
4962
5452
  */
4963
5453
  jobQueueArn?: string;
@@ -4968,10 +5458,12 @@ export interface UpdateJobQueueResponse {
4968
5458
  */
4969
5459
  export interface UpdateSchedulingPolicyRequest {
4970
5460
  /**
5461
+ * @public
4971
5462
  * <p>The Amazon Resource Name (ARN) of the scheduling policy to update.</p>
4972
5463
  */
4973
5464
  arn: string | undefined;
4974
5465
  /**
5466
+ * @public
4975
5467
  * <p>The fair share policy.</p>
4976
5468
  */
4977
5469
  fairsharePolicy?: FairsharePolicy;