Skip to content

Commit 42db21d

Browse files
author
awstools
committed
docs(client-batch): Documentation-only update: update API and doc descriptions per EKS ImageType default value switch from AL2 to AL2023.
1 parent 8e8ee4a commit 42db21d

File tree

2 files changed

+48
-60
lines changed

2 files changed

+48
-60
lines changed

clients/client-batch/src/models/models_0.ts

Lines changed: 45 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -410,15 +410,13 @@ export interface Ec2Configuration {
410410
* </dd>
411411
* <dt>EKS</dt>
412412
* <dd>
413-
* <p>If the <code>imageIdOverride</code> parameter isn't specified, then a recent <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html">Amazon EKS-optimized Amazon Linux
414-
* AMI</a> (<code>EKS_AL2</code>) is used. If a new image type is specified in an update,
413+
* <p>If the <code>imageIdOverride</code> parameter isn't specified, then a recent <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html">Amazon EKS-optimized Amazon Linux 2023
414+
* AMI</a> (<code>EKS_AL2023</code>) is used. If a new image type is specified in an update,
415415
* but neither an <code>imageId</code> nor a <code>imageIdOverride</code> parameter is specified,
416416
* then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.</p>
417417
* <important>
418-
* <p>Starting end of October 2025 Amazon EKS optimized Amazon Linux 2023 AMIs will be the
419-
* default on Batch for EKS versions prior to 1.33. Starting from Kubernetes version 1.33,
420-
* EKS optimized Amazon Linux 2023 AMIs will be the default when it becomes supported on
421-
* Batch.</p>
418+
* <p>Amazon Linux 2023 AMIs are the
419+
* default on Batch for Amazon EKS.</p>
422420
* <p>Amazon Web Services will end
423421
* support for Amazon EKS AL2-optimized and AL2-accelerated AMIs, starting 11/26/25. You can continue
424422
* using Batch-provided Amazon EKS optimized Amazon Linux 2 AMIs on your Amazon EKS compute
@@ -431,21 +429,21 @@ export interface Ec2Configuration {
431429
* <dd>
432430
* <p>
433431
* <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html">Amazon
434-
* Linux 2</a>: Default for all non-GPU instance families.</p>
432+
* Linux 2</a>: Used for non-GPU instance families.</p>
435433
* </dd>
436434
* <dt>EKS_AL2_NVIDIA</dt>
437435
* <dd>
438436
* <p>
439437
* <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html">Amazon
440-
* Linux 2 (accelerated)</a>: Default for all GPU instance families (for example,
438+
* Linux 2 (accelerated)</a>: Used for GPU instance families (for example,
441439
* <code>P4</code> and <code>G4</code>) and can be used for all non Amazon Web Services Graviton-based
442440
* instance types.</p>
443441
* </dd>
444442
* <dt>EKS_AL2023</dt>
445443
* <dd>
446444
* <p>
447445
* <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html">Amazon
448-
* Linux 2023</a>: Batch supports Amazon Linux 2023.</p>
446+
* Linux 2023</a>: Default for non-GPU instance families.</p>
449447
* <note>
450448
* <p>Amazon Linux 2023 does not support <code>A1</code> instances.</p>
451449
* </note>
@@ -454,7 +452,7 @@ export interface Ec2Configuration {
454452
* <dd>
455453
* <p>
456454
* <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html">Amazon
457-
* Linux 2023 (accelerated)</a>: GPU instance families and can be used for all non Amazon Web Services
455+
* Linux 2023 (accelerated)</a>: Default for GPU instance families and can be used for all non Amazon Web Services
458456
* Graviton-based instance types.</p>
459457
* </dd>
460458
* </dl>
@@ -805,34 +803,29 @@ export interface ComputeResource {
805803
* </li>
806804
* <li>
807805
* <p>
808-
* <code>default_arm64</code> to choose x86 based instance types (from the <code>m6g</code>,
806+
* <code>default_arm64</code> to choose ARM based instance types (from the <code>m6g</code>,
809807
* <code>c6g</code>, <code>r6g</code>, and <code>c7g</code> instance families) that matches the resource demands of the job queue.</p>
810808
* </li>
811809
* </ul>
812810
* <note>
813-
* <p>Starting on 11/01/2025 the behavior of <code>optimal</code> is going to be changed to
814-
* match <code>default_x86_64</code>.
815-
*
816-
* During the change your instance families could be updated to a newer
817-
* generation.
818-
* You do not need to perform any actions for the upgrade to
819-
* happen. For more information about change, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/optimal-default-instance-troubleshooting.html">Optimal instance type configuration to
820-
* receive automatic instance family updates</a>.</p>
821-
* </note>
822-
* <note>
823-
* <p>Instance family availability varies by
824-
* Amazon Web Services Region.
825-
* For example, some Amazon Web Services Regions may not have any fourth generation instance families
826-
* but have fifth and sixth generation instance families.</p>
827-
* <p>When using <code>default_x86_64</code> or <code>default_arm64</code>
828-
* instance bundles, Batch selects instance families based on a balance of
829-
* cost-effectiveness and performance. While newer generation instances often provide
830-
* better price-performance, Batch may choose an earlier generation instance family
831-
* if it provides the optimal combination of availability, cost, and performance for
832-
* your workload. For example, in an
833-
* Amazon Web Services Region
834-
* where both c6i and c7i instances are available, Batch might select c6i instances
835-
* if they offer better cost-effectiveness for your specific job requirements. For more information on Batch instance types and Amazon Web Services Region availability, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/instance-type-compute-table.html">Instance type compute table</a> in the <i>Batch User Guide</i>.</p>
811+
* <p>Starting on 11/01/2025 the behavior of <code>optimal</code> is going to be changed to match
812+
* <code>default_x86_64</code>. During the change your instance families could be updated to a
813+
* newer generation. You do not need to perform any actions for the upgrade to happen. For more
814+
* information about change, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/optimal-default-instance-troubleshooting.html">Optimal instance type configuration to receive automatic instance family
815+
* updates</a>.</p>
816+
* </note>
817+
* <note>
818+
* <p>Instance family availability varies by Amazon Web Services Region. For example, some Amazon Web Services Regions may not have any fourth generation instance families but have fifth and
819+
* sixth generation instance families.</p>
820+
* <p>When using <code>default_x86_64</code> or <code>default_arm64</code> instance bundles,
821+
* Batch selects instance families based on a balance of cost-effectiveness and performance.
822+
* While newer generation instances often provide better price-performance, Batch may choose an
823+
* earlier generation instance family if it provides the optimal combination of availability, cost,
824+
* and performance for your workload. For example, in an Amazon Web Services Region where both c6i
825+
* and c7i instances are available, Batch might select c6i instances if they offer better
826+
* cost-effectiveness for your specific job requirements. For more information on Batch instance
827+
* types and Amazon Web Services Region availability, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/instance-type-compute-table.html">Instance
828+
* type compute table</a> in the <i>Batch User Guide</i>.</p>
836829
* <p>Batch periodically updates your instances in default bundles to newer,
837830
* more cost-effective options. Updates happen automatically without requiring any
838831
* action from you. Your workloads continue running during updates with no interruption
@@ -8813,29 +8806,24 @@ export interface ComputeResourceUpdate {
88138806
* </li>
88148807
* </ul>
88158808
* <note>
8816-
* <p>Starting on 11/01/2025 the behavior of <code>optimal</code> is going to be changed to
8817-
* match <code>default_x86_64</code>.
8818-
*
8819-
* During the change your instance families could be updated to a newer
8820-
* generation.
8821-
* You do not need to perform any actions for the upgrade to
8822-
* happen. For more information about change, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/optimal-default-instance-troubleshooting.html">Optimal instance type configuration to
8823-
* receive automatic instance family updates</a>.</p>
8824-
* </note>
8825-
* <note>
8826-
* <p>Instance family availability varies by
8827-
* Amazon Web Services Region.
8828-
* For example, some Amazon Web Services Regions may not have any fourth generation instance families
8829-
* but have fifth and sixth generation instance families.</p>
8830-
* <p>When using <code>default_x86_64</code> or <code>default_arm64</code>
8831-
* instance bundles, Batch selects instance families based on a balance of
8832-
* cost-effectiveness and performance. While newer generation instances often provide
8833-
* better price-performance, Batch may choose an earlier generation instance family
8834-
* if it provides the optimal combination of availability, cost, and performance for
8835-
* your workload. For example, in an
8836-
* Amazon Web Services Region
8837-
* where both c6i and c7i instances are available, Batch might select c6i instances
8838-
* if they offer better cost-effectiveness for your specific job requirements. For more information on Batch instance types and Amazon Web Services Region availability, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/instance-type-compute-table.html">Instance type compute table</a> in the <i>Batch User Guide</i>.</p>
8809+
* <p>Starting on 11/01/2025 the behavior of <code>optimal</code> is going to be changed to match
8810+
* <code>default_x86_64</code>. During the change your instance families could be updated to a
8811+
* newer generation. You do not need to perform any actions for the upgrade to happen. For more
8812+
* information about change, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/optimal-default-instance-troubleshooting.html">Optimal instance type configuration to receive automatic instance family
8813+
* updates</a>.</p>
8814+
* </note>
8815+
* <note>
8816+
* <p>Instance family availability varies by Amazon Web Services Region. For example, some Amazon Web Services Regions may not have any fourth generation instance families but have fifth and
8817+
* sixth generation instance families.</p>
8818+
* <p>When using <code>default_x86_64</code> or <code>default_arm64</code> instance bundles,
8819+
* Batch selects instance families based on a balance of cost-effectiveness and performance.
8820+
* While newer generation instances often provide better price-performance, Batch may choose an
8821+
* earlier generation instance family if it provides the optimal combination of availability, cost,
8822+
* and performance for your workload. For example, in an Amazon Web Services Region where both c6i
8823+
* and c7i instances are available, Batch might select c6i instances if they offer better
8824+
* cost-effectiveness for your specific job requirements. For more information on Batch instance
8825+
* types and Amazon Web Services Region availability, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/instance-type-compute-table.html">Instance
8826+
* type compute table</a> in the <i>Batch User Guide</i>.</p>
88398827
* <p>Batch periodically updates your instances in default bundles to newer,
88408828
* more cost-effective options. Updates happen automatically without requiring any
88418829
* action from you. Your workloads continue running during updates with no interruption

0 commit comments

Comments
 (0)