@aws-sdk/client-batch 3.775.0 → 3.777.0

package/dist-cjs/index.js

@@ -52,6 +52,7 @@ __export(index_exports, {
   DeviceCgroupPermission: () => DeviceCgroupPermission,
   EFSAuthorizationConfigIAM: () => EFSAuthorizationConfigIAM,
   EFSTransitEncryption: () => EFSTransitEncryption,
+  FirelensConfigurationType: () => FirelensConfigurationType,
   GetJobQueueSnapshotCommand: () => GetJobQueueSnapshotCommand,
   JQState: () => JQState,
   JQStatus: () => JQStatus,
@@ -353,6 +354,7 @@ var DeviceCgroupPermission = {
   WRITE: "WRITE"
 };
 var LogDriver = {
+  AWSFIRELENS: "awsfirelens",
   AWSLOGS: "awslogs",
   FLUENTD: "fluentd",
   GELF: "gelf",
@@ -374,6 +376,10 @@ var EFSTransitEncryption = {
   DISABLED: "DISABLED",
   ENABLED: "ENABLED"
 };
+var FirelensConfigurationType = {
+  FLUENTBIT: "fluentbit",
+  FLUENTD: "fluentd"
+};
 var PlatformCapability = {
   EC2: "EC2",
   FARGATE: "FARGATE"
@@ -2167,6 +2173,7 @@ var paginateListSchedulingPolicies = (0, import_core.createPaginator)(BatchClien
   ResourceType,
   EFSAuthorizationConfigIAM,
   EFSTransitEncryption,
+  FirelensConfigurationType,
   PlatformCapability,
   RetryAction,
   JQStatus,

package/dist-es/models/models_0.js

@@ -79,6 +79,7 @@ export const DeviceCgroupPermission = {
     WRITE: "WRITE",
 };
 export const LogDriver = {
+    AWSFIRELENS: "awsfirelens",
     AWSLOGS: "awslogs",
     FLUENTD: "fluentd",
     GELF: "gelf",
@@ -100,6 +101,10 @@ export const EFSTransitEncryption = {
     DISABLED: "DISABLED",
     ENABLED: "ENABLED",
 };
+export const FirelensConfigurationType = {
+    FLUENTBIT: "fluentbit",
+    FLUENTD: "fluentd",
+};
 export const PlatformCapability = {
     EC2: "EC2",
     FARGATE: "FARGATE",

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

@@ -73,19 +73,22 @@ declare const CancelJobCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To cancel a job
  * ```javascript
  * // This example cancels a job with the specified job ID.
  * const input = {
- *   "jobId": "1d828f65-7a4d-42e8-996d-3b900ed59dc4",
- *   "reason": "Cancelling job."
+ *   jobId: "1d828f65-7a4d-42e8-996d-3b900ed59dc4",
+ *   reason: "Cancelling job."
  * };
  * const command = new CancelJobCommand(input);
- * await client.send(command);
- * // example id: to-cancel-a-job-1481152314733
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class CancelJobCommand extends CancelJobCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -216,97 +216,96 @@ declare const CreateComputeEnvironmentCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To create a managed EC2 compute environment
  * ```javascript
  * // This example creates a managed compute environment with specific C4 instance types that are launched on demand. The compute environment is called C4OnDemand.
  * const input = {
- *   "type": "MANAGED",
- *   "computeEnvironmentName": "C4OnDemand",
- *   "computeResources": {
- *     "type": "EC2",
- *     "desiredvCpus": 48,
- *     "ec2KeyPair": "id_rsa",
- *     "instanceRole": "ecsInstanceRole",
- *     "instanceTypes": [
+ *   computeEnvironmentName: "C4OnDemand",
+ *   computeResources: {
+ *     desiredvCpus: 48,
+ *     ec2KeyPair: "id_rsa",
+ *     instanceRole: "ecsInstanceRole",
+ *     instanceTypes: [
  *       "c4.large",
  *       "c4.xlarge",
  *       "c4.2xlarge",
  *       "c4.4xlarge",
  *       "c4.8xlarge"
  *     ],
- *     "maxvCpus": 128,
- *     "minvCpus": 0,
- *     "securityGroupIds": [
+ *     maxvCpus: 128,
+ *     minvCpus: 0,
+ *     securityGroupIds: [
  *       "sg-cf5093b2"
  *     ],
- *     "subnets": [
+ *     subnets: [
  *       "subnet-220c0e0a",
  *       "subnet-1a95556d",
  *       "subnet-978f6dce"
  *     ],
- *     "tags": {
- *       "Name": "Batch Instance - C4OnDemand"
- *     }
+ *     tags: {
+ *       Name: "Batch Instance - C4OnDemand"
+ *     },
+ *     type: "EC2"
  *   },
- *   "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
- *   "state": "ENABLED"
+ *   serviceRole: "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
+ *   state: "ENABLED",
+ *   type: "MANAGED"
  * };
  * const command = new CreateComputeEnvironmentCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand",
- *   "computeEnvironmentName": "C4OnDemand"
+ *   computeEnvironmentArn: "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand",
+ *   computeEnvironmentName: "C4OnDemand"
  * }
  * *\/
- * // example id: to-create-a-managed-ec2-compute-environment-1481152600017
  * ```
  *
  * @example To create a managed EC2 Spot compute environment
  * ```javascript
  * // This example creates a managed compute environment with the M4 instance type that is launched when the Spot bid price is at or below 20% of the On-Demand price for the instance type. The compute environment is called M4Spot.
  * const input = {
- *   "type": "MANAGED",
- *   "computeEnvironmentName": "M4Spot",
- *   "computeResources": {
- *     "type": "SPOT",
- *     "bidPercentage": 20,
- *     "desiredvCpus": 4,
- *     "ec2KeyPair": "id_rsa",
- *     "instanceRole": "ecsInstanceRole",
- *     "instanceTypes": [
+ *   computeEnvironmentName: "M4Spot",
+ *   computeResources: {
+ *     bidPercentage: 20,
+ *     desiredvCpus: 4,
+ *     ec2KeyPair: "id_rsa",
+ *     instanceRole: "ecsInstanceRole",
+ *     instanceTypes: [
  *       "m4"
  *     ],
- *     "maxvCpus": 128,
- *     "minvCpus": 0,
- *     "securityGroupIds": [
+ *     maxvCpus: 128,
+ *     minvCpus: 0,
+ *     securityGroupIds: [
  *       "sg-cf5093b2"
  *     ],
- *     "spotIamFleetRole": "arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role",
- *     "subnets": [
+ *     spotIamFleetRole: "arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role",
+ *     subnets: [
  *       "subnet-220c0e0a",
  *       "subnet-1a95556d",
  *       "subnet-978f6dce"
  *     ],
- *     "tags": {
- *       "Name": "Batch Instance - M4Spot"
- *     }
+ *     tags: {
+ *       Name: "Batch Instance - M4Spot"
+ *     },
+ *     type: "SPOT"
  *   },
- *   "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
- *   "state": "ENABLED"
+ *   serviceRole: "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
+ *   state: "ENABLED",
+ *   type: "MANAGED"
  * };
  * const command = new CreateComputeEnvironmentCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot",
- *   "computeEnvironmentName": "M4Spot"
+ *   computeEnvironmentArn: "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot",
+ *   computeEnvironmentName: "M4Spot"
  * }
  * *\/
- * // example id: to-create-a-managed-ec2-spot-compute-environment-1481152844190
  * ```
  *
+ * @public
  */
 export declare class CreateComputeEnvironmentCommand extends CreateComputeEnvironmentCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -68,30 +68,30 @@ declare const CreateConsumableResourceCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To create a consumable resource
  * ```javascript
  * // Creates a Batch consumable resource.
  * const input = {
- *   "consumableResourceName": "myConsumableResource",
- *   "resourceType": "REPLENISHABLE",
- *   "tags": {
- *     "Department": "Engineering",
- *     "User": "JaneDoe"
+ *   consumableResourceName: "myConsumableResource",
+ *   resourceType: "REPLENISHABLE",
+ *   tags: {
+ *     Department: "Engineering",
+ *     User: "JaneDoe"
  *   },
- *   "totalQuantity": 123
+ *   totalQuantity: 123
  * };
  * const command = new CreateConsumableResourceCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "consumableResourceArn": "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
- *   "consumableResourceName": "myConsumableResource"
+ *   consumableResourceArn: "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
+ *   consumableResourceName: "myConsumableResource"
  * }
  * *\/
- * // example id: to-create-a-consumable-resource-1739494856623
  * ```
  *
+ * @public
  */
 export declare class CreateConsumableResourceCommand extends CreateConsumableResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -89,61 +89,60 @@ declare const CreateJobQueueCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To create a job queue with a single compute environment
  * ```javascript
  * // This example creates a job queue called LowPriority that uses the M4Spot compute environment.
  * const input = {
- *   "computeEnvironmentOrder": [
+ *   computeEnvironmentOrder: [
  *     {
- *       "computeEnvironment": "M4Spot",
- *       "order": 1
+ *       computeEnvironment: "M4Spot",
+ *       order: 1
  *     }
  *   ],
- *   "jobQueueName": "LowPriority",
- *   "priority": 1,
- *   "state": "ENABLED"
+ *   jobQueueName: "LowPriority",
+ *   priority: 1,
+ *   state: "ENABLED"
  * };
  * const command = new CreateJobQueueCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority",
- *   "jobQueueName": "LowPriority"
+ *   jobQueueArn: "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority",
+ *   jobQueueName: "LowPriority"
  * }
  * *\/
- * // example id: to-create-a-job-queue-with-a-single-compute-environment-1481152967946
  * ```
  *
  * @example To create a job queue with multiple compute environments
  * ```javascript
  * // This example creates a job queue called HighPriority that uses the C4OnDemand compute environment with an order of 1 and the M4Spot compute environment with an order of 2.
  * const input = {
- *   "computeEnvironmentOrder": [
+ *   computeEnvironmentOrder: [
  *     {
- *       "computeEnvironment": "C4OnDemand",
- *       "order": 1
+ *       computeEnvironment: "C4OnDemand",
+ *       order: 1
  *     },
  *     {
- *       "computeEnvironment": "M4Spot",
- *       "order": 2
+ *       computeEnvironment: "M4Spot",
+ *       order: 2
  *     }
  *   ],
- *   "jobQueueName": "HighPriority",
- *   "priority": 10,
- *   "state": "ENABLED"
+ *   jobQueueName: "HighPriority",
+ *   priority: 10,
+ *   state: "ENABLED"
  * };
  * const command = new CreateJobQueueCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
- *   "jobQueueName": "HighPriority"
+ *   jobQueueArn: "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
+ *   jobQueueName: "HighPriority"
  * }
  * *\/
- * // example id: to-create-a-job-queue-with-multiple-compute-environments-1481153027051
  * ```
  *
+ * @public
  */
 export declare class CreateJobQueueCommand extends CreateJobQueueCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

@@ -66,18 +66,21 @@ declare const DeleteComputeEnvironmentCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To delete a compute environment
  * ```javascript
  * // This example deletes the P2OnDemand compute environment.
  * const input = {
- *   "computeEnvironment": "P2OnDemand"
+ *   computeEnvironment: "P2OnDemand"
  * };
  * const command = new DeleteComputeEnvironmentCommand(input);
- * await client.send(command);
- * // example id: to-delete-a-compute-environment-1481153105644
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteComputeEnvironmentCommand extends DeleteComputeEnvironmentCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -60,18 +60,21 @@ declare const DeleteConsumableResourceCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To delete a consumable resource
  * ```javascript
  * // Deletes the specified consumable resource.
  * const input = {
- *   "consumableResource": "myConsumableResource"
+ *   consumableResource: "myConsumableResource"
  * };
  * const command = new DeleteConsumableResourceCommand(input);
- * await client.send(command);
- * // example id: to-delete-a-consumable-resource-1739495667751
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteConsumableResourceCommand extends DeleteConsumableResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -65,18 +65,21 @@ declare const DeleteJobQueueCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To delete a job queue
  * ```javascript
  * // This example deletes the GPGPU job queue.
  * const input = {
- *   "jobQueue": "GPGPU"
+ *   jobQueue: "GPGPU"
  * };
  * const command = new DeleteJobQueueCommand(input);
- * await client.send(command);
- * // example id: to-delete-a-job-queue-1481153508134
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteJobQueueCommand extends DeleteJobQueueCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

@@ -61,18 +61,21 @@ declare const DeregisterJobDefinitionCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To deregister a job definition
  * ```javascript
  * // This example deregisters a job definition called sleep10.
  * const input = {
- *   "jobDefinition": "sleep10"
+ *   jobDefinition: "sleep10"
  * };
  * const command = new DeregisterJobDefinitionCommand(input);
- * await client.send(command);
- * // example id: to-deregister-a-job-definition-1481153579565
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeregisterJobDefinitionCommand extends DeregisterJobDefinitionCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -143,58 +143,58 @@ declare const DescribeComputeEnvironmentsCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To describe a compute environment
  * ```javascript
  * // This example describes the P2OnDemand compute environment.
  * const input = {
- *   "computeEnvironments": [
+ *   computeEnvironments: [
  *     "P2OnDemand"
  *   ]
  * };
  * const command = new DescribeComputeEnvironmentsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "computeEnvironments": [
+ *   computeEnvironments: [
  *     {
- *       "type": "MANAGED",
- *       "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand",
- *       "computeEnvironmentName": "P2OnDemand",
- *       "computeResources": {
- *         "type": "EC2",
- *         "desiredvCpus": 48,
- *         "ec2KeyPair": "id_rsa",
- *         "instanceRole": "ecsInstanceRole",
- *         "instanceTypes": [
+ *       computeEnvironmentArn: "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand",
+ *       computeEnvironmentName: "P2OnDemand",
+ *       computeResources: {
+ *         desiredvCpus: 48,
+ *         ec2KeyPair: "id_rsa",
+ *         instanceRole: "ecsInstanceRole",
+ *         instanceTypes: [
  *           "p2"
  *         ],
- *         "maxvCpus": 128,
- *         "minvCpus": 0,
- *         "securityGroupIds": [
+ *         maxvCpus: 128,
+ *         minvCpus: 0,
+ *         securityGroupIds: [
  *           "sg-cf5093b2"
  *         ],
- *         "subnets": [
+ *         subnets: [
  *           "subnet-220c0e0a",
  *           "subnet-1a95556d",
  *           "subnet-978f6dce"
  *         ],
- *         "tags": {
- *           "Name": "Batch Instance - P2OnDemand"
- *         }
+ *         tags: {
+ *           Name: "Batch Instance - P2OnDemand"
+ *         },
+ *         type: "EC2"
  *       },
- *       "ecsClusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/P2OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc",
- *       "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
- *       "state": "ENABLED",
- *       "status": "VALID",
- *       "statusReason": "ComputeEnvironment Healthy"
+ *       ecsClusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/P2OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc",
+ *       serviceRole: "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
+ *       state: "ENABLED",
+ *       status: "VALID",
+ *       statusReason: "ComputeEnvironment Healthy",
+ *       type: "MANAGED"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-describe-a-compute-environment-1481153713334
  * ```
  *
+ * @public
  */
 export declare class DescribeComputeEnvironmentsCommand extends DescribeComputeEnvironmentsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -71,33 +71,33 @@ declare const DescribeConsumableResourceCommand_base: {
  * @throws {@link BatchServiceException}
  * <p>Base exception class for all service exceptions from Batch service.</p>
  *
- * @public
+ *
  * @example To get a description of a consumable resource
  * ```javascript
  * // Returns a description of the specified consumable resource.
  * const input = {
- *   "consumableResource": "myConsumableResource"
+ *   consumableResource: "myConsumableResource"
  * };
  * const command = new DescribeConsumableResourceCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "availableQuantity": 123,
- *   "consumableResourceArn": "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
- *   "consumableResourceName": "myConsumableResource",
- *   "createdAt": 123,
- *   "inUseQuantity": 123,
- *   "resourceType": "REPLENISHABLE",
- *   "tags": {
- *     "Department": "Engineering",
- *     "User": "JaneDoe"
+ *   availableQuantity: 123,
+ *   consumableResourceArn: "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
+ *   consumableResourceName: "myConsumableResource",
+ *   createdAt: 123,
+ *   inUseQuantity: 123,
+ *   resourceType: "REPLENISHABLE",
+ *   tags: {
+ *     Department: "Engineering",
+ *     User: "JaneDoe"
  *   },
- *   "totalQuantity": 123
+ *   totalQuantity: 123
  * }
  * *\/
- * // example id: to-get-a-description-of-a-consumable-resource-1739495864808
  * ```
  *
+ * @public
  */
 export declare class DescribeConsumableResourceCommand extends DescribeConsumableResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */