Skip to content

Commit 5abc5ce

Browse files
author
awstools
committed
docs(client-batch): Added default_x86_64 and default_arm64 as values to the instanceTypes field.
1 parent cc94520 commit 5abc5ce

File tree

2 files changed

+132
-43
lines changed

2 files changed

+132
-43
lines changed

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

Lines changed: 127 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -545,8 +545,7 @@ export interface LaunchTemplateSpecificationOverride {
545545
* <p>Must be a valid Amazon EC2 instance type or family.</p>
546546
* </li>
547547
* <li>
548-
* <p>
549-
* <code>optimal</code> isn't allowed.</p>
548+
* <p>The following Batch <code>InstanceTypes</code> are not allowed: <code>optimal</code>, <code>default_x86_64</code>, and <code>default_arm64</code>.</p>
550549
* </li>
551550
* <li>
552551
* <p>
@@ -765,9 +764,55 @@ export interface ComputeResource {
765764
/**
766765
* <p>The instances types that can be launched. You can specify instance families to launch any
767766
* instance type within those families (for example, <code>c5</code> or <code>p3</code>), or you can
768-
* specify specific sizes within a family (such as <code>c5.8xlarge</code>). You can also choose
769-
* <code>optimal</code> to select instance types (from the C4, M4, and R4 instance families) that
770-
* match the demand of your job queues.</p>
767+
* specify specific sizes within a family (such as <code>c5.8xlarge</code>). </p>
768+
* <p>Batch can select the instance type for you if you choose one of the following:</p>
769+
* <ul>
770+
* <li>
771+
* <p>
772+
* <code>optimal</code> to select instance types (from the <code>c4</code>, <code>m4</code>,
773+
* <code>r4</code>, <code>c5</code>, <code>m5</code>, and <code>r5</code>
774+
* instance families) that match the demand of your job queues. </p>
775+
* </li>
776+
* <li>
777+
* <p>
778+
* <code>default_x86_64</code> to choose x86 based instance types (from the <code>m6i</code>,
779+
* <code>c6i</code>, <code>r6i</code>, and <code>c7i</code> instance families) that matches the resource demands of the job queue.</p>
780+
* </li>
781+
* <li>
782+
* <p>
783+
* <code>default_arm64</code> to choose x86 based instance types (from the <code>m6g</code>,
784+
* <code>c6g</code>, <code>r6g</code>, and <code>c7g</code> instance families) that matches the resource demands of the job queue.</p>
785+
* </li>
786+
* </ul>
787+
* <note>
788+
* <p>Starting on 11/01/2025 the behavior of <code>optimal</code> is going to be changed to
789+
* match <code>default_x86_64</code>.
790+
*
791+
* During the change your instance families could be updated to a newer
792+
* generation.
793+
* You do not need to perform any actions for the upgrade to
794+
* 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
795+
* receive automatic instance family updates</a>.</p>
796+
* </note>
797+
* <note>
798+
* <p>Instance family availability varies by
799+
* Amazon Web Services Region.
800+
* For example, some Amazon Web Services Regions may not have any fourth generation instance families
801+
* but have fifth and sixth generation instance families.</p>
802+
* <p>When using <code>default_x86_64</code> or <code>default_arm64</code>
803+
* instance bundles, Batch selects instance families based on a balance of
804+
* cost-effectiveness and performance. While newer generation instances often provide
805+
* better price-performance, Batch may choose an earlier generation instance family
806+
* if it provides the optimal combination of availability, cost, and performance for
807+
* your workload. For example, in an
808+
* Amazon Web Services Region
809+
* where both c6i and c7i instances are available, Batch might select c6i instances
810+
* 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>Batch periodically updates your instances in default bundles to newer,
812+
* more cost-effective options. Updates happen automatically without requiring any
813+
* action from you. Your workloads continue running during updates with no interruption
814+
* </p>
815+
* </note>
771816
* <note>
772817
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
773818
* </note>
@@ -776,11 +821,6 @@ export interface ComputeResource {
776821
* share the same architecture. For example, you can't mix x86 and ARM instances in the same compute
777822
* environment.</p>
778823
* </note>
779-
* <note>
780-
* <p>Currently, <code>optimal</code> uses instance types from the C4, M4, and R4 instance
781-
* families. In Regions that don't have instance types from those instance families, instance types
782-
* from the C5, M5, and R5 instance families are used.</p>
783-
* </note>
784824
* @public
785825
*/
786826
instanceTypes?: string[] | undefined;
@@ -7527,20 +7567,33 @@ export interface ListServiceJobsRequest {
75277567
nextToken?: string | undefined;
75287568

75297569
/**
7530-
* <p>The filters to apply to the service job list query. The filter names and values can be:</p>
7531-
* <ul>
7532-
* <li>
7533-
* <p>name: <code>JOB_STATUS</code>
7534-
* </p>
7535-
* <p>values: <code>SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED | SCHEDULED</code>
7536-
* </p>
7537-
* </li>
7538-
* <li>
7539-
* <p>name: <code>JOB_NAME</code>
7540-
* </p>
7541-
* <p>values: case-insensitive matches for the job name. If a filter value ends with an asterisk (*), it matches any job name that begins with the string before the '*'.</p>
7542-
* </li>
7543-
* </ul>
7570+
* <p>The filter to apply to the query. Only one filter can be used at a time. When the filter
7571+
* is used, <code>jobStatus</code> is ignored. The results are sorted by the <code>createdAt</code> field,
7572+
* with the most recent jobs being first.</p>
7573+
* <dl>
7574+
* <dt>JOB_NAME</dt>
7575+
* <dd>
7576+
* <p>The value of the filter is a case-insensitive match for the job name. If the value
7577+
* ends with an asterisk (*), the filter matches any job name that begins with the string
7578+
* before the '*'. This corresponds to the <code>jobName</code> value. For example,
7579+
* <code>test1</code> matches both <code>Test1</code> and <code>test1</code>, and
7580+
* <code>test1*</code> matches both <code>test1</code> and <code>Test10</code>. When the
7581+
* <code>JOB_NAME</code> filter is used, the results are grouped by the job name and
7582+
* version.</p>
7583+
* </dd>
7584+
* <dt>BEFORE_CREATED_AT</dt>
7585+
* <dd>
7586+
* <p>The value for the filter is the time that's before the job was created. This
7587+
* corresponds to the <code>createdAt</code> value. The value is a string representation of
7588+
* the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.</p>
7589+
* </dd>
7590+
* <dt>AFTER_CREATED_AT</dt>
7591+
* <dd>
7592+
* <p>The value for the filter is the time that's after the job was created. This
7593+
* corresponds to the <code>createdAt</code> value. The value is a string representation of
7594+
* the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.</p>
7595+
* </dd>
7596+
* </dl>
75447597
* @public
75457598
*/
75467599
filters?: KeyValuesPair[] | undefined;
@@ -8708,12 +8761,55 @@ export interface ComputeResourceUpdate {
87088761
/**
87098762
* <p>The instances types that can be launched. You can specify instance families to launch any
87108763
* instance type within those families (for example, <code>c5</code> or <code>p3</code>), or you can
8711-
* specify specific sizes within a family (such as <code>c5.8xlarge</code>). You can also choose
8712-
* <code>optimal</code> to select instance types (from the C4, M4, and R4 instance families) that
8713-
* match the demand of your job queues.</p>
8714-
* <p>When updating a compute environment, changing this setting requires an infrastructure update
8715-
* of the compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the
8716-
* <i>Batch User Guide</i>.</p>
8764+
* specify specific sizes within a family (such as <code>c5.8xlarge</code>). </p>
8765+
* <p>Batch can select the instance type for you if you choose one of the following:</p>
8766+
* <ul>
8767+
* <li>
8768+
* <p>
8769+
* <code>optimal</code> to select instance types (from the <code>c4</code>, <code>m4</code>,
8770+
* <code>r4</code>, <code>c5</code>, <code>m5</code>, and <code>r5</code>
8771+
* instance families) that match the demand of your job queues. </p>
8772+
* </li>
8773+
* <li>
8774+
* <p>
8775+
* <code>default_x86_64</code> to choose x86 based instance types (from the <code>m6i</code>,
8776+
* <code>c6i</code>, <code>r6i</code>, and <code>c7i</code> instance families) that matches the resource demands of the job queue.</p>
8777+
* </li>
8778+
* <li>
8779+
* <p>
8780+
* <code>default_arm64</code> to choose x86 based instance types (from the <code>m6g</code>,
8781+
* <code>c6g</code>, <code>r6g</code>, and <code>c7g</code> instance families) that matches the resource demands of the job queue.</p>
8782+
* </li>
8783+
* </ul>
8784+
* <note>
8785+
* <p>Starting on 11/01/2025 the behavior of <code>optimal</code> is going to be changed to
8786+
* match <code>default_x86_64</code>.
8787+
*
8788+
* During the change your instance families could be updated to a newer
8789+
* generation.
8790+
* You do not need to perform any actions for the upgrade to
8791+
* 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
8792+
* receive automatic instance family updates</a>.</p>
8793+
* </note>
8794+
* <note>
8795+
* <p>Instance family availability varies by
8796+
* Amazon Web Services Region.
8797+
* For example, some Amazon Web Services Regions may not have any fourth generation instance families
8798+
* but have fifth and sixth generation instance families.</p>
8799+
* <p>When using <code>default_x86_64</code> or <code>default_arm64</code>
8800+
* instance bundles, Batch selects instance families based on a balance of
8801+
* cost-effectiveness and performance. While newer generation instances often provide
8802+
* better price-performance, Batch may choose an earlier generation instance family
8803+
* if it provides the optimal combination of availability, cost, and performance for
8804+
* your workload. For example, in an
8805+
* Amazon Web Services Region
8806+
* where both c6i and c7i instances are available, Batch might select c6i instances
8807+
* 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>
8808+
* <p>Batch periodically updates your instances in default bundles to newer,
8809+
* more cost-effective options. Updates happen automatically without requiring any
8810+
* action from you. Your workloads continue running during updates with no interruption
8811+
* </p>
8812+
* </note>
87178813
* <note>
87188814
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
87198815
* </note>
@@ -8722,11 +8818,6 @@ export interface ComputeResourceUpdate {
87228818
* share the same architecture. For example, you can't mix x86 and ARM instances in the same compute
87238819
* environment.</p>
87248820
* </note>
8725-
* <note>
8726-
* <p>Currently, <code>optimal</code> uses instance types from the C4, M4, and R4 instance
8727-
* families. In Regions that don't have instance types from those instance families, instance types
8728-
* from the C5, M5, and R5 instance families are used.</p>
8729-
* </note>
87308821
* @public
87318822
*/
87328823
instanceTypes?: string[] | undefined;
@@ -9069,9 +9160,7 @@ export interface UpdateConsumableResourceRequest {
90699160

90709161
/**
90719162
* <p>If this parameter is specified and two update requests with identical payloads and
9072-
* <code>clientToken</code>s are received, these requests are considered the same request and
9073-
* the second request is rejected. A <code>clientToken</code> is valid for 8 hours or until
9074-
* one hour after the consumable resource is deleted, whichever is less.</p>
9163+
* <code>clientToken</code>s are received, these requests are considered the same request. Both requests will succeed, but the update will only happen once. A <code>clientToken</code> is valid for 8 hours.</p>
90759164
* @public
90769165
*/
90779166
clientToken?: string | undefined;

0 commit comments

Comments
 (0)