@aws-sdk/client-batch 3.774.0 → 3.777.0

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

@@ -115,50 +115,49 @@ declare const ListJobsCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To list running jobs
  * ```javascript
  * // This example lists the running jobs in the HighPriority job queue.
  * const input = {
- *   "jobQueue": "HighPriority"
+ *   jobQueue: "HighPriority"
  * };
  * const command = new ListJobsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "jobSummaryList": [
+ *   jobSummaryList: [
  *     {
- *       "jobId": "e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb",
- *       "jobName": "example"
+ *       jobId: "e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb",
+ *       jobName: "example"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-list-running-jobs-1481154202164
  * ```
  *
  * @example To list submitted jobs
  * ```javascript
  * // This example lists jobs in the HighPriority job queue that are in the SUBMITTED job status.
  * const input = {
- *   "jobQueue": "HighPriority",
- *   "jobStatus": "SUBMITTED"
+ *   jobQueue: "HighPriority",
+ *   jobStatus: "SUBMITTED"
  * };
  * const command = new ListJobsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "jobSummaryList": [
+ *   jobSummaryList: [
  *     {
- *       "jobId": "68f0c163-fbd4-44e6-9fd1-25b14a434786",
- *       "jobName": "example"
+ *       jobId: "68f0c163-fbd4-44e6-9fd1-25b14a434786",
+ *       jobName: "example"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-list-submitted-jobs-1481154251623
  * ```
  *
+ * @public
  */
 export declare class ListJobsCommand extends ListJobsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -68,6 +68,7 @@ declare const ListSchedulingPoliciesCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
+ *
  * @public
  */
 export declare class ListSchedulingPoliciesCommand extends ListSchedulingPoliciesCommand_base {

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

@@ -65,27 +65,27 @@ declare const ListTagsForResourceCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example ListTagsForResource Example
  * ```javascript
  * // This demonstrates calling the ListTagsForResource action.
  * const input = {
- *   "resourceArn": "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1"
+ *   resourceArn: "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1"
  * };
  * const command = new ListTagsForResourceCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "tags": {
- *     "Department": "Engineering",
- *     "Stage": "Alpha",
- *     "User": "JaneDoe"
+ *   tags: {
+ *     Department: "Engineering",
+ *     Stage: "Alpha",
+ *     User: "JaneDoe"
  *   }
  * }
  * *\/
- * // example id: listtagsforresource-example-1591293003710
  * ```
  *
+ * @public
  */
 export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -123,7 +123,7 @@ declare const RegisterJobDefinitionCommand_base: {
  *       swappiness: Number("int"),
  *     },
  *     logConfiguration: { // LogConfiguration
- *       logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk", // required
+ *       logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk" || "awsfirelens", // required
  *       options: { // LogConfigurationOptionsMap
  *         "<keys>": "STRING_VALUE",
  *       },
@@ -146,6 +146,7 @@ declare const RegisterJobDefinitionCommand_base: {
  *     fargatePlatformConfiguration: { // FargatePlatformConfiguration
  *       platformVersion: "STRING_VALUE",
  *     },
+ *     enableExecuteCommand: true || false,
  *     ephemeralStorage: { // EphemeralStorage
  *       sizeInGiB: Number("int"), // required
  *     },
@@ -243,7 +244,7 @@ declare const RegisterJobDefinitionCommand_base: {
  *             swappiness: Number("int"),
  *           },
  *           logConfiguration: {
- *             logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk", // required
+ *             logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk" || "awsfirelens", // required
  *             options: {
  *               "<keys>": "STRING_VALUE",
  *             },
@@ -256,6 +257,7 @@ declare const RegisterJobDefinitionCommand_base: {
  *           fargatePlatformConfiguration: {
  *             platformVersion: "STRING_VALUE",
  *           },
+ *           enableExecuteCommand: true || false,
  *           ephemeralStorage: {
  *             sizeInGiB: Number("int"), // required
  *           },
@@ -282,6 +284,12 @@ declare const RegisterJobDefinitionCommand_base: {
  *                   ],
  *                   environment: "<EnvironmentVariables>",
  *                   essential: true || false,
+ *                   firelensConfiguration: { // FirelensConfiguration
+ *                     type: "fluentd" || "fluentbit", // required
+ *                     options: { // FirelensConfigurationOptionsMap
+ *                       "<keys>": "STRING_VALUE",
+ *                     },
+ *                   },
  *                   image: "STRING_VALUE", // required
  *                   linuxParameters: "<LinuxParameters>",
  *                   logConfiguration: "<LogConfiguration>",
@@ -305,6 +313,7 @@ declare const RegisterJobDefinitionCommand_base: {
  *               networkConfiguration: "<NetworkConfiguration>",
  *               runtimePlatform: "<RuntimePlatform>",
  *               volumes: "<Volumes>",
+ *               enableExecuteCommand: true || false,
  *             },
  *           ],
  *         },
@@ -594,6 +603,12 @@ declare const RegisterJobDefinitionCommand_base: {
  *             ],
  *             environment: "<EnvironmentVariables>",
  *             essential: true || false,
+ *             firelensConfiguration: {
+ *               type: "fluentd" || "fluentbit", // required
+ *               options: {
+ *                 "<keys>": "STRING_VALUE",
+ *               },
+ *             },
  *             image: "STRING_VALUE", // required
  *             linuxParameters: "<LinuxParameters>",
  *             logConfiguration: "<LogConfiguration>",
@@ -617,6 +632,7 @@ declare const RegisterJobDefinitionCommand_base: {
  *         networkConfiguration: "<NetworkConfiguration>",
  *         runtimePlatform: "<RuntimePlatform>",
  *         volumes: "<Volumes>",
+ *         enableExecuteCommand: true || false,
  *       },
  *     ],
  *   },
@@ -656,83 +672,82 @@ declare const RegisterJobDefinitionCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
- * @example To register a job definition
+ *
+ * @example RegisterJobDefinition with tags
  * ```javascript
- * // This example registers a job definition for a simple container job.
+ * // This demonstrates calling the RegisterJobDefinition action, including tags.
  * const input = {
- *   "type": "container",
- *   "containerProperties": {
- *     "command": [
+ *   containerProperties: {
+ *     command: [
  *       "sleep",
- *       "10"
+ *       "30"
  *     ],
- *     "image": "busybox",
- *     "resourceRequirements": [
+ *     image: "busybox",
+ *     resourceRequirements: [
  *       {
- *         "type": "MEMORY",
- *         "value": "128"
+ *         type: "MEMORY",
+ *         value: "128"
  *       },
  *       {
- *         "type": "VCPU",
- *         "value": "1"
+ *         type: "VCPU",
+ *         value: "1"
  *       }
  *     ]
  *   },
- *   "jobDefinitionName": "sleep10"
+ *   jobDefinitionName: "sleep30",
+ *   tags: {
+ *     Department: "Engineering",
+ *     User: "JaneDoe"
+ *   },
+ *   type: "container"
  * };
  * const command = new RegisterJobDefinitionCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep10:1",
- *   "jobDefinitionName": "sleep10",
- *   "revision": 1
+ *   jobDefinitionArn: "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1",
+ *   jobDefinitionName: "sleep30",
+ *   revision: 1
  * }
  * *\/
- * // example id: to-register-a-job-definition-1481154325325
  * ```
  *
- * @example RegisterJobDefinition with tags
+ * @example To register a job definition
  * ```javascript
- * // This demonstrates calling the RegisterJobDefinition action, including tags.
+ * // This example registers a job definition for a simple container job.
  * const input = {
- *   "type": "container",
- *   "containerProperties": {
- *     "command": [
+ *   containerProperties: {
+ *     command: [
  *       "sleep",
- *       "30"
+ *       "10"
  *     ],
- *     "image": "busybox",
- *     "resourceRequirements": [
+ *     image: "busybox",
+ *     resourceRequirements: [
  *       {
- *         "type": "MEMORY",
- *         "value": "128"
+ *         type: "MEMORY",
+ *         value: "128"
  *       },
  *       {
- *         "type": "VCPU",
- *         "value": "1"
+ *         type: "VCPU",
+ *         value: "1"
  *       }
  *     ]
  *   },
- *   "jobDefinitionName": "sleep30",
- *   "tags": {
- *     "Department": "Engineering",
- *     "User": "JaneDoe"
- *   }
+ *   jobDefinitionName: "sleep10",
+ *   type: "container"
  * };
  * const command = new RegisterJobDefinitionCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1",
- *   "jobDefinitionName": "sleep30",
- *   "revision": 1
+ *   jobDefinitionArn: "arn:aws:batch:us-east-1:012345678910:job-definition/sleep10:1",
+ *   jobDefinitionName: "sleep10",
+ *   revision: 1
  * }
  * *\/
- * // example id: registerjobdefinition-with-tags-1591290509028
  * ```
  *
+ * @public
  */
 export declare class RegisterJobDefinitionCommand extends RegisterJobDefinitionCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -34,7 +34,7 @@ declare const SubmitJobCommand_base: {
  *       parameters in a <code>resourceRequirements</code> object that's included in the
  *         <code>containerOverrides</code> parameter.</p>
  *          <note>
- *             <p>Job queues with a scheduling policy are limited to 500 active fair share identifiers at
+ *             <p>Job queues with a scheduling policy are limited to 500 active share identifiers at
  *         a time. </p>
  *          </note>
  *          <important>
@@ -319,26 +319,26 @@ declare const SubmitJobCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To submit a job to a queue
  * ```javascript
  * // This example submits a simple container job called example to the HighPriority job queue.
  * const input = {
- *   "jobDefinition": "sleep60",
- *   "jobName": "example",
- *   "jobQueue": "HighPriority"
+ *   jobDefinition: "sleep60",
+ *   jobName: "example",
+ *   jobQueue: "HighPriority"
  * };
  * const command = new SubmitJobCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "jobId": "876da822-4198-45f2-a252-6cea32512ea8",
- *   "jobName": "example"
+ *   jobId: "876da822-4198-45f2-a252-6cea32512ea8",
+ *   jobName: "example"
  * }
  * *\/
- * // example id: to-submit-a-job-to-a-queue-1481154481673
  * ```
  *
+ * @public
  */
 export declare class SubmitJobCommand extends SubmitJobCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -67,21 +67,24 @@ declare const TagResourceCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example TagResource Example
  * ```javascript
  * // This demonstrates calling the TagResource action.
  * const input = {
- *   "resourceArn": "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1",
- *   "tags": {
- *     "Stage": "Alpha"
+ *   resourceArn: "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1",
+ *   tags: {
+ *     Stage: "Alpha"
  *   }
  * };
  * const command = new TagResourceCommand(input);
- * await client.send(command);
- * // example id: tagresource-example-1591291959952
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class TagResourceCommand extends TagResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -64,19 +64,22 @@ declare const TerminateJobCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To terminate a job
  * ```javascript
  * // This example terminates a job with the specified job ID.
  * const input = {
- *   "jobId": "61e743ed-35e4-48da-b2de-5c8333821c84",
- *   "reason": "Terminating job."
+ *   jobId: "61e743ed-35e4-48da-b2de-5c8333821c84",
+ *   reason: "Terminating job."
  * };
  * const command = new TerminateJobCommand(input);
- * await client.send(command);
- * // example id: to-terminate-a-job-1481154558276
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class TerminateJobCommand extends TerminateJobCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -63,21 +63,24 @@ declare const UntagResourceCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example UntagResource Example
  * ```javascript
  * // This demonstrates calling the UntagResource action.
  * const input = {
- *   "resourceArn": "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1",
- *   "tagKeys": [
+ *   resourceArn: "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1",
+ *   tagKeys: [
  *     "Stage"
  *   ]
  * };
  * const command = new UntagResourceCommand(input);
- * await client.send(command);
- * // example id: untagresource-example-1591292811042
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class UntagResourceCommand extends UntagResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -118,25 +118,25 @@ declare const UpdateComputeEnvironmentCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To update a compute environment
  * ```javascript
  * // This example disables the P2OnDemand compute environment so it can be deleted.
  * const input = {
- *   "computeEnvironment": "P2OnDemand",
- *   "state": "DISABLED"
+ *   computeEnvironment: "P2OnDemand",
+ *   state: "DISABLED"
  * };
  * const command = new UpdateComputeEnvironmentCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand",
- *   "computeEnvironmentName": "P2OnDemand"
+ *   computeEnvironmentArn: "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand",
+ *   computeEnvironmentName: "P2OnDemand"
  * }
  * *\/
- * // example id: to-update-a-compute-environment-1481154702731
  * ```
  *
+ * @public
  */
 export declare class UpdateComputeEnvironmentCommand extends UpdateComputeEnvironmentCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -67,27 +67,27 @@ declare const UpdateConsumableResourceCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To update a consumable resource
  * ```javascript
  * // Updates a consumable resource.
  * const input = {
- *   "consumableResource": "myConsumableResource",
- *   "operation": "ADD",
- *   "quantity": 12
+ *   consumableResource: "myConsumableResource",
+ *   operation: "ADD",
+ *   quantity: 12
  * };
  * const command = new UpdateConsumableResourceCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "consumableResourceArn": "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
- *   "consumableResourceName": "myConsumableResource",
- *   "totalQuantity": 135
+ *   consumableResourceArn: "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
+ *   consumableResourceName: "myConsumableResource",
+ *   totalQuantity: 135
  * }
  * *\/
- * // example id: to-update-a-consumable-resource-1739497761692
  * ```
  *
+ * @public
  */
 export declare class UpdateConsumableResourceCommand extends UpdateConsumableResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -80,25 +80,25 @@ declare const UpdateJobQueueCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To update a job queue
  * ```javascript
  * // This example disables a job queue so that it can be deleted.
  * const input = {
- *   "jobQueue": "GPGPU",
- *   "state": "DISABLED"
+ *   jobQueue: "GPGPU",
+ *   state: "DISABLED"
  * };
  * const command = new UpdateJobQueueCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU",
- *   "jobQueueName": "GPGPU"
+ *   jobQueueArn: "arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU",
+ *   jobQueueName: "GPGPU"
  * }
  * *\/
- * // example id: to-update-a-job-queue-1481154806981
  * ```
  *
+ * @public
  */
 export declare class UpdateJobQueueCommand extends UpdateJobQueueCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -70,6 +70,7 @@ declare const UpdateSchedulingPolicyCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
+ *
  * @public
  */
 export declare class UpdateSchedulingPolicyCommand extends UpdateSchedulingPolicyCommand_base {