@aws-sdk/client-batch 3.363.0 → 3.365.0

package/dist-types/commands/CancelJobCommand.d.ts

@@ -32,6 +32,14 @@ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBea
  *         in<code>RUNNABLE</code> remains in <code>RUNNABLE</code> until it reaches the head of the
  *       job queue. Then the job status is updated to
  *       <code>FAILED</code>.</p>
+ *          <note>
+ *             <p>A <code>PENDING</code> job is canceled after all dependency jobs are completed.
+ *         Therefore, it may take longer than expected to cancel a job in <code>PENDING</code>
+ *         status.</p>
+ *             <p>When you try to cancel an array parent job in <code>PENDING</code>, Batch  attempts to
+ *         cancel all child jobs. The array parent job is canceled when all child jobs are
+ *         completed.</p>
+ *          </note>
  *          <p>Jobs that progressed to the <code>STARTING</code> or
  *         <code>RUNNING</code> state aren't canceled. However, the API operation still succeeds, even
  *       if no job is canceled. These jobs must be terminated with the <a>TerminateJob</a>

package/dist-types/commands/CreateComputeEnvironmentCommand.d.ts

@@ -79,8 +79,12 @@ export interface CreateComputeEnvironmentCommandOutput extends CreateComputeEnvi
  *       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>
+ *                   <p>Set the update to latest image version (<code>updateToLatestImageVersion</code>)
+ *             parameter to
+ *             <code>true</code>.
+ *             The <code>updateToLatestImageVersion</code> parameter is used when you update a compute
+ *             environment. This parameter is ignored when you create a compute
+ *             environment.</p>
  *                </li>
  *                <li>
  *                   <p>Don't 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">

package/dist-types/commands/DescribeJobDefinitionsCommand.d.ts

@@ -173,6 +173,10 @@ export interface DescribeJobDefinitionsCommandOutput extends DescribeJobDefiniti
  * //         ephemeralStorage: { // EphemeralStorage
  * //           sizeInGiB: Number("int"), // required
  * //         },
+ * //         runtimePlatform: { // RuntimePlatform
+ * //           operatingSystemFamily: "STRING_VALUE",
+ * //           cpuArchitecture: "STRING_VALUE",
+ * //         },
  * //       },
  * //       timeout: { // JobTimeout
  * //         attemptDurationSeconds: Number("int"),
@@ -279,6 +283,10 @@ export interface DescribeJobDefinitionsCommandOutput extends DescribeJobDefiniti
  * //               ephemeralStorage: {
  * //                 sizeInGiB: Number("int"), // required
  * //               },
+ * //               runtimePlatform: {
+ * //                 operatingSystemFamily: "STRING_VALUE",
+ * //                 cpuArchitecture: "STRING_VALUE",
+ * //               },
  * //             },
  * //           },
  * //         ],

package/dist-types/commands/DescribeJobsCommand.d.ts

@@ -213,6 +213,10 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad
  * //         ephemeralStorage: { // EphemeralStorage
  * //           sizeInGiB: Number("int"), // required
  * //         },
+ * //         runtimePlatform: { // RuntimePlatform
+ * //           operatingSystemFamily: "STRING_VALUE",
+ * //           cpuArchitecture: "STRING_VALUE",
+ * //         },
  * //       },
  * //       nodeDetails: { // NodeDetails
  * //         nodeIndex: Number("int"),
@@ -320,6 +324,10 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad
  * //               ephemeralStorage: {
  * //                 sizeInGiB: Number("int"), // required
  * //               },
+ * //               runtimePlatform: {
+ * //                 operatingSystemFamily: "STRING_VALUE",
+ * //                 cpuArchitecture: "STRING_VALUE",
+ * //               },
  * //             },
  * //           },
  * //         ],

package/dist-types/commands/RegisterJobDefinitionCommand.d.ts

@@ -145,6 +145,10 @@ export interface RegisterJobDefinitionCommandOutput extends RegisterJobDefinitio
  *     ephemeralStorage: { // EphemeralStorage
  *       sizeInGiB: Number("int"), // required
  *     },
+ *     runtimePlatform: { // RuntimePlatform
+ *       operatingSystemFamily: "STRING_VALUE",
+ *       cpuArchitecture: "STRING_VALUE",
+ *     },
  *   },
  *   nodeProperties: { // NodeProperties
  *     numNodes: Number("int"), // required
@@ -248,6 +252,10 @@ export interface RegisterJobDefinitionCommandOutput extends RegisterJobDefinitio
  *           ephemeralStorage: {
  *             sizeInGiB: Number("int"), // required
  *           },
+ *           runtimePlatform: {
+ *             operatingSystemFamily: "STRING_VALUE",
+ *             cpuArchitecture: "STRING_VALUE",
+ *           },
  *         },
  *       },
  *     ],

package/dist-types/models/models_0.d.ts

@@ -412,15 +412,21 @@ export interface ComputeResource {
      */
     allocationStrategy?: CRAllocationStrategy | string;
     /**
-     * <p>The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute
-     *    environment is <code>DISABLED</code>).</p>
+     * <p>The minimum number of
+     *     vCPUs that
+     *    a
+     *    compute
+     *    environment should maintain (even if the compute environment is <code>DISABLED</code>).</p>
      *          <note>
      *             <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
      *          </note>
      */
     minvCpus?: number;
     /**
-     * <p>The maximum number of Amazon EC2 vCPUs that a compute environment can reach.</p>
+     * <p>The maximum number of
+     *    vCPUs that a
+     *    compute environment can
+     *    support.</p>
      *          <note>
      *             <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code>
      *     allocation strategies using On-Demand or Spot Instances, and the <code>BEST_FIT</code> strategy
@@ -432,8 +438,10 @@ export interface ComputeResource {
      */
     maxvCpus: number | undefined;
     /**
-     * <p>The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value
-     *    between the minimum and maximum values based on job queue demand.</p>
+     * <p>The desired number of
+     *     vCPUS in the
+     *    compute environment. Batch modifies this value between the minimum and maximum values based on
+     *    job queue demand.</p>
      *          <note>
      *             <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
      *          </note>
@@ -1827,6 +1835,50 @@ export interface ResourceRequirement {
      */
     type: ResourceType | string | undefined;
 }
+/**
+ * @public
+ * <p>An object that represents the compute environment architecture for Batch jobs on Fargate.</p>
+ */
+export interface RuntimePlatform {
+    /**
+     * <p>The operating system for the compute environment.
+     *    Valid values are:
+     *     <code>LINUX</code> (default), <code>WINDOWS_SERVER_2019_CORE</code>,
+     *     <code>WINDOWS_SERVER_2019_FULL</code>, <code>WINDOWS_SERVER_2022_CORE</code>, and
+     *     <code>WINDOWS_SERVER_2022_FULL</code>.</p>
+     *          <note>
+     *             <p>The following parameters can’t be set for Windows containers: <code>linuxParameters</code>,
+     *      <code>privileged</code>, <code>user</code>, <code>ulimits</code>,
+     *      <code>readonlyRootFilesystem</code>,
+     *     and <code>efsVolumeConfiguration</code>.</p>
+     *          </note>
+     *          <note>
+     *             <p>The Batch Scheduler checks before registering a task definition with Fargate. If the job
+     *     requires a Windows container and the first compute environment is <code>LINUX</code>, the
+     *     compute environment is skipped and the next is checked until a Windows-based compute environment
+     *     is found.</p>
+     *          </note>
+     *          <note>
+     *             <p>Fargate Spot is not supported for Windows-based containers on Fargate. A job
+     *     queue will be blocked if a Fargate Windows job is submitted to a job queue with only Fargate
+     *     Spot compute environments.
+     *     However, you can attach both <code>FARGATE</code> and <code>FARGATE_SPOT</code>
+     *   compute environments to the same job
+     *     queue.</p>
+     *          </note>
+     */
+    operatingSystemFamily?: string;
+    /**
+     * <p>The vCPU architecture. The default value is <code>X86_64</code>. Valid values are <code>X86_64</code> and
+     *   <code> ARM64</code>.</p>
+     *          <note>
+     *             <p>This parameter must be set to
+     *     <code>X86_64</code>
+     *     for Windows containers.</p>
+     *          </note>
+     */
+    cpuArchitecture?: string;
+}
 /**
  * @public
  * <p>The <code>ulimit</code> settings to pass to the container.</p>
@@ -2209,6 +2261,10 @@ export interface ContainerProperties {
      *    Fargate.</p>
      */
     ephemeralStorage?: EphemeralStorage;
+    /**
+     * <p>An object that represents the compute environment architecture for Batch jobs on Fargate.</p>
+     */
+    runtimePlatform?: RuntimePlatform;
 }
 /**
  * @public
@@ -3204,6 +3260,10 @@ export interface ContainerDetail {
      *    Fargate.</p>
      */
     ephemeralStorage?: EphemeralStorage;
+    /**
+     * <p>An object that represents the compute environment architecture for Batch jobs on Fargate.</p>
+     */
+    runtimePlatform?: RuntimePlatform;
 }
 /**
  * @public
@@ -4073,6 +4133,8 @@ export interface RegisterJobDefinitionResponse {
 /**
  * @public
  * <p>The overrides that should be sent to a container.</p>
+ *          <p>For information about using Batch overrides when you connect event sources to targets, see
+ *    <a href="https://docs.aws.amazon.com/eventbridge/latest/pipes-reference/API_BatchContainerOverrides.html">BatchContainerOverrides</a>.</p>
  */
 export interface ContainerOverrides {
     /**
@@ -4108,6 +4170,9 @@ export interface ContainerOverrides {
     /**
      * <p>The command to send to the container that overrides the default command from the Docker
      *    image or the job definition.</p>
+     *          <note>
+     *             <p>This parameter can't contain an empty string.</p>
+     *          </note>
      */
     command?: string[];
     /**
@@ -4267,8 +4332,11 @@ export interface SubmitJobRequest {
      */
     jobQueue: string | undefined;
     /**
-     * <p>The share identifier for the job. If the job queue doesn't 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>
+     * <p>The share identifier for the job. Don't specify this parameter if the job queue doesn't
+     *       have a scheduling policy. If the job queue has a scheduling policy, then this parameter must
+     *       be specified.</p>
+     *          <p>This string is limited to 255 alphanumeric characters, and can be followed by an asterisk
+     *       (*).</p>
      */
     shareIdentifier?: string;
     /**
@@ -4460,8 +4528,9 @@ export type CRUpdateAllocationStrategy = (typeof CRUpdateAllocationStrategy)[key
  */
 export interface ComputeResourceUpdate {
     /**
-     * <p>The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute
-     *    environment is <code>DISABLED</code>).</p>
+     * <p>The minimum number of
+     *    vCPUs that
+     *    an environment should maintain (even if the compute environment is <code>DISABLED</code>).</p>
      *          <note>
      *             <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
      *          </note>
@@ -4480,8 +4549,10 @@ export interface ComputeResourceUpdate {
      */
     maxvCpus?: number;
     /**
-     * <p>The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value
-     *    between the minimum and maximum values based on job queue demand.</p>
+     * <p>The desired number of
+     *    vCPUS in the
+     *    compute environment. Batch modifies this value between the minimum and maximum values based on
+     *    job queue demand.</p>
      *          <note>
      *             <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
      *          </note>

package/dist-types/ts3.4/models/models_0.d.ts

@@ -308,6 +308,10 @@ export interface ResourceRequirement {
   value: string | undefined;
   type: ResourceType | string | undefined;
 }
+export interface RuntimePlatform {
+  operatingSystemFamily?: string;
+  cpuArchitecture?: string;
+}
 export interface Ulimit {
   hardLimit: number | undefined;
   name: string | undefined;
@@ -366,6 +370,7 @@ export interface ContainerProperties {
   networkConfiguration?: NetworkConfiguration;
   fargatePlatformConfiguration?: FargatePlatformConfiguration;
   ephemeralStorage?: EphemeralStorage;
+  runtimePlatform?: RuntimePlatform;
 }
 export interface EksContainerEnvironmentVariable {
   name: string | undefined;
@@ -544,6 +549,7 @@ export interface ContainerDetail {
   networkConfiguration?: NetworkConfiguration;
   fargatePlatformConfiguration?: FargatePlatformConfiguration;
   ephemeralStorage?: EphemeralStorage;
+  runtimePlatform?: RuntimePlatform;
 }
 export interface JobDependency {
   jobId?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-batch",
   "description": "AWS SDK for JavaScript Batch Client for Node.js, Browser and React Native",
-  "version": "3.363.0",
+  "version": "3.365.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",