@aws-sdk/client-batch 3.775.0 → 3.782.0

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

@@ -151,7 +151,7 @@ declare const DescribeJobDefinitionsCommand_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",
  * //           },
@@ -174,6 +174,7 @@ declare const DescribeJobDefinitionsCommand_base: {
  * //         fargatePlatformConfiguration: { // FargatePlatformConfiguration
  * //           platformVersion: "STRING_VALUE",
  * //         },
+ * //         enableExecuteCommand: true || false,
  * //         ephemeralStorage: { // EphemeralStorage
  * //           sizeInGiB: Number("int"), // required
  * //         },
@@ -274,7 +275,7 @@ declare const DescribeJobDefinitionsCommand_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",
  * //                 },
@@ -287,6 +288,7 @@ declare const DescribeJobDefinitionsCommand_base: {
  * //               fargatePlatformConfiguration: {
  * //                 platformVersion: "STRING_VALUE",
  * //               },
+ * //               enableExecuteCommand: true || false,
  * //               ephemeralStorage: {
  * //                 sizeInGiB: Number("int"), // required
  * //               },
@@ -313,6 +315,12 @@ declare const DescribeJobDefinitionsCommand_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>",
@@ -336,6 +344,7 @@ declare const DescribeJobDefinitionsCommand_base: {
  * //                   networkConfiguration: "<NetworkConfiguration>",
  * //                   runtimePlatform: "<RuntimePlatform>",
  * //                   volumes: "<Volumes>",
+ * //                   enableExecuteCommand: true || false,
  * //                 },
  * //               ],
  * //             },
@@ -491,6 +500,12 @@ declare const DescribeJobDefinitionsCommand_base: {
  * //                 ],
  * //                 environment: "<EnvironmentVariables>",
  * //                 essential: true || false,
+ * //                 firelensConfiguration: {
+ * //                   type: "fluentd" || "fluentbit", // required
+ * //                   options: {
+ * //                     "<keys>": "STRING_VALUE",
+ * //                   },
+ * //                 },
  * //                 image: "STRING_VALUE", // required
  * //                 linuxParameters: "<LinuxParameters>",
  * //                 logConfiguration: "<LogConfiguration>",
@@ -514,6 +529,7 @@ declare const DescribeJobDefinitionsCommand_base: {
  * //             networkConfiguration: "<NetworkConfiguration>",
  * //             runtimePlatform: "<RuntimePlatform>",
  * //             volumes: "<Volumes>",
+ * //             enableExecuteCommand: true || false,
  * //           },
  * //         ],
  * //       },
@@ -670,52 +686,52 @@ declare const DescribeJobDefinitionsCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To describe active job definitions
  * ```javascript
  * // This example describes all of your active job definitions.
  * const input = {
- *   "status": "ACTIVE"
+ *   status: "ACTIVE"
  * };
  * const command = new DescribeJobDefinitionsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "jobDefinitions": [
+ *   jobDefinitions: [
  *     {
- *       "type": "container",
- *       "containerProperties": {
- *         "command": [
+ *       containerProperties: {
+ *         command: [
  *           "sleep",
  *           "60"
  *         ],
- *         "environment": [],
- *         "image": "busybox",
- *         "mountPoints": [],
- *         "resourceRequirements": [
+ *         environment:         [],
+ *         image: "busybox",
+ *         mountPoints:         [],
+ *         resourceRequirements: [
  *           {
- *             "type": "MEMORY",
- *             "value": "128"
+ *             type: "MEMORY",
+ *             value: "128"
  *           },
  *           {
- *             "type": "VCPU",
- *             "value": "1"
+ *             type: "VCPU",
+ *             value: "1"
  *           }
  *         ],
- *         "ulimits": [],
- *         "volumes": []
+ *         ulimits:         [],
+ *         volumes:         []
  *       },
- *       "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1",
- *       "jobDefinitionName": "sleep60",
- *       "revision": 1,
- *       "status": "ACTIVE"
+ *       jobDefinitionArn: "arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1",
+ *       jobDefinitionName: "sleep60",
+ *       revision: 1,
+ *       status: "ACTIVE",
+ *       type: "container"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-describe-active-job-definitions-1481153895831
  * ```
  *
+ * @public
  */
 export declare class DescribeJobDefinitionsCommand extends DescribeJobDefinitionsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -94,40 +94,40 @@ declare const DescribeJobQueuesCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To describe a job queue
  * ```javascript
  * // This example describes the HighPriority job queue.
  * const input = {
- *   "jobQueues": [
+ *   jobQueues: [
  *     "HighPriority"
  *   ]
  * };
  * const command = new DescribeJobQueuesCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "jobQueues": [
+ *   jobQueues: [
  *     {
- *       "computeEnvironmentOrder": [
+ *       computeEnvironmentOrder: [
  *         {
- *           "computeEnvironment": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand",
- *           "order": 1
+ *           computeEnvironment: "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand",
+ *           order: 1
  *         }
  *       ],
- *       "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
- *       "jobQueueName": "HighPriority",
- *       "priority": 1,
- *       "state": "ENABLED",
- *       "status": "VALID",
- *       "statusReason": "JobQueue Healthy"
+ *       jobQueueArn: "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
+ *       jobQueueName: "HighPriority",
+ *       priority: 1,
+ *       state: "ENABLED",
+ *       status: "VALID",
+ *       statusReason: "JobQueue Healthy"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-describe-a-job-queue-1481153995804
  * ```
  *
+ * @public
  */
 export declare class DescribeJobQueuesCommand extends DescribeJobQueuesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -206,7 +206,7 @@ declare const DescribeJobsCommand_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",
  * //           },
@@ -239,6 +239,7 @@ declare const DescribeJobsCommand_base: {
  * //         repositoryCredentials: { // RepositoryCredentials
  * //           credentialsParameter: "STRING_VALUE", // required
  * //         },
+ * //         enableExecuteCommand: true || false,
  * //       },
  * //       nodeDetails: { // NodeDetails
  * //         nodeIndex: Number("int"),
@@ -330,7 +331,7 @@ declare const DescribeJobsCommand_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",
  * //                 },
@@ -343,6 +344,7 @@ declare const DescribeJobsCommand_base: {
  * //               fargatePlatformConfiguration: {
  * //                 platformVersion: "STRING_VALUE",
  * //               },
+ * //               enableExecuteCommand: true || false,
  * //               ephemeralStorage: {
  * //                 sizeInGiB: Number("int"), // required
  * //               },
@@ -369,6 +371,12 @@ declare const DescribeJobsCommand_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>",
@@ -392,6 +400,7 @@ declare const DescribeJobsCommand_base: {
  * //                   networkConfiguration: "<NetworkConfiguration>",
  * //                   runtimePlatform: "<RuntimePlatform>",
  * //                   volumes: "<Volumes>",
+ * //                   enableExecuteCommand: true || false,
  * //                 },
  * //               ],
  * //             },
@@ -710,6 +719,12 @@ declare const DescribeJobsCommand_base: {
  * //                 ],
  * //                 environment: "<EnvironmentVariables>",
  * //                 essential: true || false,
+ * //                 firelensConfiguration: {
+ * //                   type: "fluentd" || "fluentbit", // required
+ * //                   options: {
+ * //                     "<keys>": "STRING_VALUE",
+ * //                   },
+ * //                 },
  * //                 image: "STRING_VALUE",
  * //                 linuxParameters: "<LinuxParameters>",
  * //                 logConfiguration: "<LogConfiguration>",
@@ -739,6 +754,7 @@ declare const DescribeJobsCommand_base: {
  * //             networkConfiguration: "<NetworkConfiguration>",
  * //             runtimePlatform: "<RuntimePlatform>",
  * //             volumes: "<Volumes>",
+ * //             enableExecuteCommand: true || false,
  * //           },
  * //         ],
  * //       },
@@ -775,53 +791,53 @@ declare const DescribeJobsCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To describe a specific job
  * ```javascript
  * // This example describes a job with the specified job ID.
  * const input = {
- *   "jobs": [
+ *   jobs: [
  *     "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9"
  *   ]
  * };
  * const command = new DescribeJobsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "jobs": [
+ *   jobs: [
  *     {
- *       "container": {
- *         "command": [
+ *       container: {
+ *         command: [
  *           "sleep",
  *           "60"
  *         ],
- *         "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/5406d7cd-58bd-4b8f-9936-48d7c6b1526c",
- *         "environment": [],
- *         "exitCode": 0,
- *         "image": "busybox",
- *         "memory": 128,
- *         "mountPoints": [],
- *         "ulimits": [],
- *         "vcpus": 1,
- *         "volumes": []
+ *         containerInstanceArn: "arn:aws:ecs:us-east-1:012345678910:container-instance/5406d7cd-58bd-4b8f-9936-48d7c6b1526c",
+ *         environment:         [],
+ *         exitCode: 0,
+ *         image: "busybox",
+ *         memory: 128,
+ *         mountPoints:         [],
+ *         ulimits:         [],
+ *         vcpus: 1,
+ *         volumes:         []
  *       },
- *       "createdAt": 1480460782010,
- *       "dependsOn": [],
- *       "jobDefinition": "sleep60",
- *       "jobId": "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9",
- *       "jobName": "example",
- *       "jobQueue": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
- *       "parameters": {},
- *       "startedAt": 1480460816500,
- *       "status": "SUCCEEDED",
- *       "stoppedAt": 1480460880699
+ *       createdAt: 1480460782010,
+ *       dependsOn:       [],
+ *       jobDefinition: "sleep60",
+ *       jobId: "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9",
+ *       jobName: "example",
+ *       jobQueue: "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
+ *       parameters:       { /* empty *\/ },
+ *       startedAt: 1480460816500,
+ *       status: "SUCCEEDED",
+ *       stoppedAt: 1480460880699
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-describe-a-specific-job-1481154090490
  * ```
  *
+ * @public
  */
 export declare class DescribeJobsCommand extends DescribeJobsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

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

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

@@ -80,39 +80,39 @@ declare const ListConsumableResourcesCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To get a list of a consumable resources
  * ```javascript
  * // Returns a list of the consumable resources for your account.
  * const input = {
- *   "filters": [
+ *   filters: [
  *     {
- *       "name": "CONSUMABLE_RESOURCE_NAME",
- *       "values": [
+ *       name: "CONSUMABLE_RESOURCE_NAME",
+ *       values: [
  *         "my*"
  *       ]
  *     }
  *   ],
- *   "maxResults": 123
+ *   maxResults: 123
  * };
  * const command = new ListConsumableResourcesCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "consumableResources": [
+ *   consumableResources: [
  *     {
- *       "consumableResourceArn": "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
- *       "consumableResourceName": "myConsumableResource",
- *       "inUseQuantity": 12,
- *       "resourceType": "REPLENISHABLE",
- *       "totalQuantity": 123
+ *       consumableResourceArn: "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
+ *       consumableResourceName: "myConsumableResource",
+ *       inUseQuantity: 12,
+ *       resourceType: "REPLENISHABLE",
+ *       totalQuantity: 123
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-get-a-list-of-a-consumable-resources-1739496071960
  * ```
  *
+ * @public
  */
 export declare class ListConsumableResourcesCommand extends ListConsumableResourcesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -94,50 +94,50 @@ declare const ListJobsByConsumableResourceCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To get a list of Batch jobs by consumable resource
  * ```javascript
  * // Returns a list of Batch jobs that require a specific consumable resource.
  * const input = {
- *   "consumableResource": "myConsumableResource",
- *   "filters": [
+ *   consumableResource: "myConsumableResource",
+ *   filters: [
  *     {
- *       "name": "CONSUMABLE_RESOURCE_NAME",
- *       "values": [
+ *       name: "CONSUMABLE_RESOURCE_NAME",
+ *       values: [
  *         "my*"
  *       ]
  *     }
  *   ],
- *   "maxResults": 123
+ *   maxResults: 123
  * };
  * const command = new ListJobsByConsumableResourceCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "jobs": [
+ *   jobs: [
  *     {
- *       "consumableResourceProperties": {
- *         "consumableResourceList": [
+ *       consumableResourceProperties: {
+ *         consumableResourceList: [
  *           {
- *             "consumableResource": "myConsumableResource",
- *             "quantity": 123
+ *             consumableResource: "myConsumableResource",
+ *             quantity: 123
  *           }
  *         ]
  *       },
- *       "createdAt": 1480460782010,
- *       "jobArn": "arn:aws:batch:us-east-1:012345678910:job/myJob",
- *       "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/myJobDef",
- *       "jobName": "myJob",
- *       "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/myJobQueue",
- *       "jobStatus": "PENDING",
- *       "quantity": 123
+ *       createdAt: 1480460782010,
+ *       jobArn: "arn:aws:batch:us-east-1:012345678910:job/myJob",
+ *       jobDefinitionArn: "arn:aws:batch:us-east-1:012345678910:job-definition/myJobDef",
+ *       jobName: "myJob",
+ *       jobQueueArn: "arn:aws:batch:us-east-1:012345678910:job-queue/myJobQueue",
+ *       jobStatus: "PENDING",
+ *       quantity: 123
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-get-a-list-of-batch-jobs-by-consumable-resource-1739496640347
  * ```
  *
+ * @public
  */
 export declare class ListJobsByConsumableResourceCommand extends ListJobsByConsumableResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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. */