docs(client-batch): Documentation updates for AWS Batch.

Author: awstools

clients/client-batch/src/Batch.ts

@@ -170,10 +170,11 @@ export class Batch extends BatchClient {
    *    your container instances into that Amazon ECS cluster. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html">Launching an Amazon ECS container instance</a> in the
    *     <i>Amazon Elastic Container Service Developer Guide</i>.</p>
    *          <note>
-   *             <p>Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it
-   *     doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible
-   *     for managing the guest operating system (including its updates and security patches) and any additional application
-   *     software or utilities that you install on the compute resources. To use a new AMI for your Batch jobs, complete
+   *             <p>Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it
+   *     also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is
+   *     available. You're responsible for the management of the guest operating system. This includes any updates and
+   *     security patches. You're also responsible for any additional application software or utilities that you install on
+   *     the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete
    *     these steps:</p>
    *             <ol>
    *                <li>
@@ -189,6 +190,41 @@ export class Batch extends BatchClient {
    *                   <p>Delete the earlier compute environment.</p>
    *                </li>
    *             </ol>
+   *             <p>In April 2022, Batch added enhanced support for updating compute environments. For more information, see
+   *      <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute
+   *      environments</a>. To use the enhanced updating of compute environments to update AMIs, follow these
+   *     rules:</p>
+   *             <ul>
+   *                <li>
+   *                   <p>Either do not set the service role (<code>serviceRole</code>) parameter or set it to the <b>AWSBatchServiceRole</b> service-linked role.</p>
+   *                </li>
+   *                <li>
+   *                   <p>Set the allocation strategy (<code>allocationStrategy</code>) parameter to <code>BEST_FIT_PROGRESSIVE</code>
+   *       or <code>SPOT_CAPACITY_OPTIMIZED</code>.</p>
+   *                </li>
+   *                <li>
+   *                   <p>Set the update to latest image version (<code>updateToLatestImageVersion</code>) parameter to
+   *        <code>true</code>.</p>
+   *                </li>
+   *                <li>
+   *                   <p>Do not specify an AMI ID in <code>imageId</code>, <code>imageIdOverride</code> (in <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_Ec2Configuration.html">
+   *                         <code>ec2Configuration</code>
+   *                      </a>), or in the launch template (<code>launchTemplate</code>). In that case
+   *       Batch will select the latest Amazon ECS optimized AMI supported by Batch at the time the infrastructure update is
+   *       initiated. Alternatively you can specify the AMI ID in the <code>imageId</code> or <code>imageIdOverride</code>
+   *       parameters, or the launch template identified by the <code>LaunchTemplate</code> properties. Changing any of these
+   *       properties will trigger an infrastructure update. If the AMI ID is specified in the launch template, it can not be
+   *       replaced by specifying an AMI ID in either the <code>imageId</code> or <code>imageIdOverride</code> parameters. It
+   *       can only be replaced by specifying a different launch template, or if the launch template version is set to
+   *        <code>$Default</code> or <code>$Latest</code>, by setting either a new default version for the launch template
+   *       (if <code>$Default</code>)or by adding a new version to the launch template (if <code>$Latest</code>).</p>
+   *                </li>
+   *             </ul>
+   *             <p>If these rules are followed, any update that triggers an infrastructure update will cause the AMI ID to be
+   *     re-selected. If the <code>version</code> setting in the launch template (<code>launchTemplate</code>) is set to
+   *      <code>$Latest</code> or <code>$Default</code>, the latest or default version of the launch template will be
+   *     evaluated up at the time of the infrastructure update, even if the <code>launchTemplate</code> was not
+   *     updated.</p>
    *          </note>
    */
   public createComputeEnvironment(

clients/client-batch/src/commands/CreateComputeEnvironmentCommand.ts

@@ -42,10 +42,11 @@ export interface CreateComputeEnvironmentCommandOutput extends CreateComputeEnvi
  *    your container instances into that Amazon ECS cluster. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html">Launching an Amazon ECS container instance</a> in the
  *     <i>Amazon Elastic Container Service Developer Guide</i>.</p>
  *          <note>
- *             <p>Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it
- *     doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible
- *     for managing the guest operating system (including its updates and security patches) and any additional application
- *     software or utilities that you install on the compute resources. To use a new AMI for your Batch jobs, complete
+ *             <p>Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it
+ *     also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is
+ *     available. You're responsible for the management of the guest operating system. This includes any updates and
+ *     security patches. You're also responsible for any additional application software or utilities that you install on
+ *     the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete
  *     these steps:</p>
  *             <ol>
  *                <li>
@@ -61,6 +62,41 @@ export interface CreateComputeEnvironmentCommandOutput extends CreateComputeEnvi
  *                   <p>Delete the earlier compute environment.</p>
  *                </li>
  *             </ol>
+ *             <p>In April 2022, Batch added enhanced support for updating compute environments. For more information, see
+ *      <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute
+ *      environments</a>. To use the enhanced updating of compute environments to update AMIs, follow these
+ *     rules:</p>
+ *             <ul>
+ *                <li>
+ *                   <p>Either do not set the service role (<code>serviceRole</code>) parameter or set it to the <b>AWSBatchServiceRole</b> service-linked role.</p>
+ *                </li>
+ *                <li>
+ *                   <p>Set the allocation strategy (<code>allocationStrategy</code>) parameter to <code>BEST_FIT_PROGRESSIVE</code>
+ *       or <code>SPOT_CAPACITY_OPTIMIZED</code>.</p>
+ *                </li>
+ *                <li>
+ *                   <p>Set the update to latest image version (<code>updateToLatestImageVersion</code>) parameter to
+ *        <code>true</code>.</p>
+ *                </li>
+ *                <li>
+ *                   <p>Do not specify an AMI ID in <code>imageId</code>, <code>imageIdOverride</code> (in <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_Ec2Configuration.html">
+ *                         <code>ec2Configuration</code>
+ *                      </a>), or in the launch template (<code>launchTemplate</code>). In that case
+ *       Batch will select the latest Amazon ECS optimized AMI supported by Batch at the time the infrastructure update is
+ *       initiated. Alternatively you can specify the AMI ID in the <code>imageId</code> or <code>imageIdOverride</code>
+ *       parameters, or the launch template identified by the <code>LaunchTemplate</code> properties. Changing any of these
+ *       properties will trigger an infrastructure update. If the AMI ID is specified in the launch template, it can not be
+ *       replaced by specifying an AMI ID in either the <code>imageId</code> or <code>imageIdOverride</code> parameters. It
+ *       can only be replaced by specifying a different launch template, or if the launch template version is set to
+ *        <code>$Default</code> or <code>$Latest</code>, by setting either a new default version for the launch template
+ *       (if <code>$Default</code>)or by adding a new version to the launch template (if <code>$Latest</code>).</p>
+ *                </li>
+ *             </ul>
+ *             <p>If these rules are followed, any update that triggers an infrastructure update will cause the AMI ID to be
+ *     re-selected. If the <code>version</code> setting in the launch template (<code>launchTemplate</code>) is set to
+ *      <code>$Latest</code> or <code>$Default</code>, the latest or default version of the launch template will be
+ *     evaluated up at the time of the infrastructure update, even if the <code>launchTemplate</code> was not
+ *     updated.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -578,9 +578,10 @@ export interface ComputeResource {
    * <p>Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,
    *    these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value−for
    *    example, <code>{ "Name": "Batch Instance - C4OnDemand" }</code>. This is helpful for recognizing your Batch
-   *    instances in the Amazon EC2 console. These tags can't be updated or removed after the compute environment is created. Any
-   *    changes to these tags require that you create a new compute environment and remove the old compute environment. These
-   *    tags aren't seen when using the Batch <code>ListTagsForResource</code> API operation.</p>
+   *    instances in the Amazon EC2 console. Updating these tags requires an infrastructure update to 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 <i>Batch User Guide</i>. These tags aren't seen when using the Batch
+   *     <code>ListTagsForResource</code> API operation.</p>
    *          <note>
    *             <p>This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be
    *    specified.</p>
@@ -4073,7 +4074,8 @@ export interface SubmitJobRequest {
   jobQueue: string | undefined;
 
   /**
-   * <p>The share identifier for the job.</p>
+   * <p>The share identifier for the job. If the job queue does not have a scheduling policy, then this parameter must
+   *    not be specified. If the job queue has a scheduling policy, then this parameter must be specified.</p>
    */
   shareIdentifier?: string;