feat(client-batch): This feature allows AWS Batch on Amazon EKS to su…

…pport configuration of Pod Annotations, overriding Namespace on which the Batch job's Pod runs on, and allows Subpath and Persistent Volume claim to be set for AWS Batch on Amazon EKS jobs.
aws · Dec 17, 2024 · 00737e5 · 00737e5
1 parent 5e299dd
commit 00737e5
Show file tree

Hide file tree

Showing 8 changed files with 300 additions and 115 deletions.
diff --git a/clients/client-batch/src/commands/CreateComputeEnvironmentCommand.ts b/clients/client-batch/src/commands/CreateComputeEnvironmentCommand.ts
@@ -94,11 +94,9 @@ export interface CreateComputeEnvironmentCommandOutput extends CreateComputeEnvi
  *                </li>
  *                <li>
  *                   <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>
+ *             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

diff --git a/clients/client-batch/src/commands/DescribeJobDefinitionsCommand.ts b/clients/client-batch/src/commands/DescribeJobDefinitionsCommand.ts
@@ -375,6 +375,7 @@ export interface DescribeJobDefinitionsCommandOutput extends DescribeJobDefiniti
  * //                       { // EksContainerVolumeMount
  * //                         name: "STRING_VALUE",
  * //                         mountPath: "STRING_VALUE",
+ * //                         subPath: "STRING_VALUE",
  * //                         readOnly: true || false,
  * //                       },
  * //                     ],
@@ -413,6 +414,7 @@ export interface DescribeJobDefinitionsCommandOutput extends DescribeJobDefiniti
  * //                       {
  * //                         name: "STRING_VALUE",
  * //                         mountPath: "STRING_VALUE",
+ * //                         subPath: "STRING_VALUE",
  * //                         readOnly: true || false,
  * //                       },
  * //                     ],
@@ -440,12 +442,20 @@ export interface DescribeJobDefinitionsCommandOutput extends DescribeJobDefiniti
  * //                       secretName: "STRING_VALUE", // required
  * //                       optional: true || false,
  * //                     },
+ * //                     persistentVolumeClaim: { // EksPersistentVolumeClaim
+ * //                       claimName: "STRING_VALUE", // required
+ * //                       readOnly: true || false,
+ * //                     },
  * //                   },
  * //                 ],
  * //                 metadata: { // EksMetadata
  * //                   labels: { // EksLabelsMap
  * //                     "<keys>": "STRING_VALUE",
  * //                   },
+ * //                   annotations: { // EksAnnotationsMap
+ * //                     "<keys>": "STRING_VALUE",
+ * //                   },
+ * //                   namespace: "STRING_VALUE",
  * //                 },
  * //                 shareProcessNamespace: true || false,
  * //               },
@@ -535,6 +545,7 @@ export interface DescribeJobDefinitionsCommandOutput extends DescribeJobDefiniti
  * //                 {
  * //                   name: "STRING_VALUE",
  * //                   mountPath: "STRING_VALUE",
+ * //                   subPath: "STRING_VALUE",
  * //                   readOnly: true || false,
  * //                 },
  * //               ],
@@ -573,6 +584,7 @@ export interface DescribeJobDefinitionsCommandOutput extends DescribeJobDefiniti
  * //                 {
  * //                   name: "STRING_VALUE",
  * //                   mountPath: "STRING_VALUE",
+ * //                   subPath: "STRING_VALUE",
  * //                   readOnly: true || false,
  * //                 },
  * //               ],
@@ -600,12 +612,20 @@ export interface DescribeJobDefinitionsCommandOutput extends DescribeJobDefiniti
  * //                 secretName: "STRING_VALUE", // required
  * //                 optional: true || false,
  * //               },
+ * //               persistentVolumeClaim: {
+ * //                 claimName: "STRING_VALUE", // required
+ * //                 readOnly: true || false,
+ * //               },
  * //             },
  * //           ],
  * //           metadata: {
  * //             labels: {
  * //               "<keys>": "STRING_VALUE",
  * //             },
+ * //             annotations: {
+ * //               "<keys>": "STRING_VALUE",
+ * //             },
+ * //             namespace: "STRING_VALUE",
  * //           },
  * //           shareProcessNamespace: true || false,
  * //         },

diff --git a/clients/client-batch/src/commands/DescribeJobsCommand.ts b/clients/client-batch/src/commands/DescribeJobsCommand.ts
@@ -431,6 +431,7 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad
  * //                       { // EksContainerVolumeMount
  * //                         name: "STRING_VALUE",
  * //                         mountPath: "STRING_VALUE",
+ * //                         subPath: "STRING_VALUE",
  * //                         readOnly: true || false,
  * //                       },
  * //                     ],
@@ -469,6 +470,7 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad
  * //                       {
  * //                         name: "STRING_VALUE",
  * //                         mountPath: "STRING_VALUE",
+ * //                         subPath: "STRING_VALUE",
  * //                         readOnly: true || false,
  * //                       },
  * //                     ],
@@ -496,12 +498,20 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad
  * //                       secretName: "STRING_VALUE", // required
  * //                       optional: true || false,
  * //                     },
+ * //                     persistentVolumeClaim: { // EksPersistentVolumeClaim
+ * //                       claimName: "STRING_VALUE", // required
+ * //                       readOnly: true || false,
+ * //                     },
  * //                   },
  * //                 ],
  * //                 metadata: { // EksMetadata
  * //                   labels: { // EksLabelsMap
  * //                     "<keys>": "STRING_VALUE",
  * //                   },
+ * //                   annotations: { // EksAnnotationsMap
+ * //                     "<keys>": "STRING_VALUE",
+ * //                   },
+ * //                   namespace: "STRING_VALUE",
  * //                 },
  * //                 shareProcessNamespace: true || false,
  * //               },
@@ -563,6 +573,7 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad
  * //                 {
  * //                   name: "STRING_VALUE",
  * //                   mountPath: "STRING_VALUE",
+ * //                   subPath: "STRING_VALUE",
  * //                   readOnly: true || false,
  * //                 },
  * //               ],
@@ -603,6 +614,7 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad
  * //                 {
  * //                   name: "STRING_VALUE",
  * //                   mountPath: "STRING_VALUE",
+ * //                   subPath: "STRING_VALUE",
  * //                   readOnly: true || false,
  * //                 },
  * //               ],
@@ -630,6 +642,10 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad
  * //                 secretName: "STRING_VALUE", // required
  * //                 optional: true || false,
  * //               },
+ * //               persistentVolumeClaim: {
+ * //                 claimName: "STRING_VALUE", // required
+ * //                 readOnly: true || false,
+ * //               },
  * //             },
  * //           ],
  * //           podName: "STRING_VALUE",
@@ -638,6 +654,10 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad
  * //             labels: {
  * //               "<keys>": "STRING_VALUE",
  * //             },
+ * //             annotations: {
+ * //               "<keys>": "STRING_VALUE",
+ * //             },
+ * //             namespace: "STRING_VALUE",
  * //           },
  * //           shareProcessNamespace: true || false,
  * //         },

diff --git a/clients/client-batch/src/commands/RegisterJobDefinitionCommand.ts b/clients/client-batch/src/commands/RegisterJobDefinitionCommand.ts
@@ -344,6 +344,7 @@ export interface RegisterJobDefinitionCommandOutput extends RegisterJobDefinitio
  *                   { // EksContainerVolumeMount
  *                     name: "STRING_VALUE",
  *                     mountPath: "STRING_VALUE",
+ *                     subPath: "STRING_VALUE",
  *                     readOnly: true || false,
  *                   },
  *                 ],
@@ -382,6 +383,7 @@ export interface RegisterJobDefinitionCommandOutput extends RegisterJobDefinitio
  *                   {
  *                     name: "STRING_VALUE",
  *                     mountPath: "STRING_VALUE",
+ *                     subPath: "STRING_VALUE",
  *                     readOnly: true || false,
  *                   },
  *                 ],
@@ -409,12 +411,20 @@ export interface RegisterJobDefinitionCommandOutput extends RegisterJobDefinitio
  *                   secretName: "STRING_VALUE", // required
  *                   optional: true || false,
  *                 },
+ *                 persistentVolumeClaim: { // EksPersistentVolumeClaim
+ *                   claimName: "STRING_VALUE", // required
+ *                   readOnly: true || false,
+ *                 },
  *               },
  *             ],
  *             metadata: { // EksMetadata
  *               labels: { // EksLabelsMap
  *                 "<keys>": "STRING_VALUE",
  *               },
+ *               annotations: { // EksAnnotationsMap
+ *                 "<keys>": "STRING_VALUE",
+ *               },
+ *               namespace: "STRING_VALUE",
  *             },
  *             shareProcessNamespace: true || false,
  *           },
@@ -478,6 +488,7 @@ export interface RegisterJobDefinitionCommandOutput extends RegisterJobDefinitio
  *             {
  *               name: "STRING_VALUE",
  *               mountPath: "STRING_VALUE",
+ *               subPath: "STRING_VALUE",
  *               readOnly: true || false,
  *             },
  *           ],
@@ -516,6 +527,7 @@ export interface RegisterJobDefinitionCommandOutput extends RegisterJobDefinitio
  *             {
  *               name: "STRING_VALUE",
  *               mountPath: "STRING_VALUE",
+ *               subPath: "STRING_VALUE",
  *               readOnly: true || false,
  *             },
  *           ],
@@ -543,12 +555,20 @@ export interface RegisterJobDefinitionCommandOutput extends RegisterJobDefinitio
  *             secretName: "STRING_VALUE", // required
  *             optional: true || false,
  *           },
+ *           persistentVolumeClaim: {
+ *             claimName: "STRING_VALUE", // required
+ *             readOnly: true || false,
+ *           },
  *         },
  *       ],
  *       metadata: {
  *         labels: {
  *           "<keys>": "STRING_VALUE",
  *         },
+ *         annotations: {
+ *           "<keys>": "STRING_VALUE",
+ *         },
+ *         namespace: "STRING_VALUE",
  *       },
  *       shareProcessNamespace: true || false,
  *     },

diff --git a/clients/client-batch/src/commands/SubmitJobCommand.ts b/clients/client-batch/src/commands/SubmitJobCommand.ts
@@ -177,6 +177,10 @@ export interface SubmitJobCommandOutput extends SubmitJobResponse, __MetadataBea
  *               labels: { // EksLabelsMap
  *                 "<keys>": "STRING_VALUE",
  *               },
+ *               annotations: { // EksAnnotationsMap
+ *                 "<keys>": "STRING_VALUE",
+ *               },
+ *               namespace: "STRING_VALUE",
  *             },
  *           },
  *         },
@@ -251,6 +255,10 @@ export interface SubmitJobCommandOutput extends SubmitJobResponse, __MetadataBea
  *         labels: {
  *           "<keys>": "STRING_VALUE",
  *         },
+ *         annotations: {
+ *           "<keys>": "STRING_VALUE",
+ *         },
+ *         namespace: "STRING_VALUE",
  *       },
  *     },
  *   },