There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo. # Actions for AWS Batch using AWS SDKs The following code examples demonstrate how to perform individual AWS Batch actions with AWS SDKs. Each example includes a link to GitHub, where you can find instructions for setting up and running the code. These excerpts call the AWS Batch API and are code excerpts from larger programs that must be run in context. You can see actions in context in [Scenarios for AWS Batch using AWS SDKs](batch_code_examples_scenarios.md). The following examples include only the most commonly used actions. For a complete list, see the [AWS Batch API Reference](https://docs.aws.amazon.com/batch/latest/APIReference/Welcome.html). **Topics** + [`CreateComputeEnvironment`](batch_example_batch_CreateComputeEnvironment_section.md) + [`CreateJobQueue`](batch_example_batch_CreateJobQueue_section.md) + [`DeleteComputeEnvironment`](batch_example_batch_DeleteComputeEnvironment_section.md) + [`DeleteJobQueue`](batch_example_batch_DeleteJobQueue_section.md) + [`DeregisterJobDefinition`](batch_example_batch_DeregisterJobDefinition_section.md) + [`DescribeComputeEnvironments`](batch_example_batch_DescribeComputeEnvironments_section.md) + [`DescribeJobQueues`](batch_example_batch_DescribeJobQueues_section.md) + [`DescribeJobs`](batch_example_batch_DescribeJobs_section.md) + [`ListJobsPaginator`](batch_example_batch_ListJobsPaginator_section.md) + [`RegisterJobDefinition`](batch_example_batch_RegisterJobDefinition_section.md) + [`SubmitJob`](batch_example_batch_SubmitJob_section.md) + [`UpdateComputeEnvironment`](batch_example_batch_UpdateComputeEnvironment_section.md) + [`UpdateJobQueue`](batch_example_batch_UpdateJobQueue_section.md) # Use `CreateComputeEnvironment` with an AWS SDK or CLI The following code examples show how to use `CreateComputeEnvironment`. Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples: + [Learn the basics](batch_example_batch_Scenario_section.md) + [Getting started with Batch and Fargate](batch_example_fargate_GettingStarted_section.md) ------ #### [ CLI ] **AWS CLI** **To create a managed compute environment with On-Demand instances** This example creates a managed compute environment with specific C4 instance types that are launched on demand. The compute environment is called C4OnDemand. Command: ``` aws batch create-compute-environment --cli-input-json file:///C4OnDemand.json ``` JSON file format: ``` { "computeEnvironmentName": "C4OnDemand", "type": "MANAGED", "state": "ENABLED", "computeResources": { "type": "EC2", "minvCpus": 0, "maxvCpus": 128, "desiredvCpus": 48, "instanceTypes": [ "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge" ], "subnets": [ "subnet-220c0e0a", "subnet-1a95556d", "subnet-978f6dce" ], "securityGroupIds": [ "sg-cf5093b2" ], "ec2KeyPair": "id_rsa", "instanceRole": "ecsInstanceRole", "tags": { "Name": "Batch Instance - C4OnDemand" } }, "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole" } ``` Output: ``` { "computeEnvironmentName": "C4OnDemand", "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand" } ``` **To create a managed compute environment with Spot Instances** 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. Command: ``` aws batch create-compute-environment --cli-input-json file:///M4Spot.json ``` JSON file format: ``` { "computeEnvironmentName": "M4Spot", "type": "MANAGED", "state": "ENABLED", "computeResources": { "type": "SPOT", "spotIamFleetRole": "arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role", "minvCpus": 0, "maxvCpus": 128, "desiredvCpus": 4, "instanceTypes": [ "m4" ], "bidPercentage": 20, "subnets": [ "subnet-220c0e0a", "subnet-1a95556d", "subnet-978f6dce" ], "securityGroupIds": [ "sg-cf5093b2" ], "ec2KeyPair": "id_rsa", "instanceRole": "ecsInstanceRole", "tags": { "Name": "Batch Instance - M4Spot" } }, "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole" } ``` Output: ``` { "computeEnvironmentName": "M4Spot", "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot" } ``` + For API details, see [CreateComputeEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/create-compute-environment.html) in *AWS CLI Command Reference*. ------ #### [ Java ] **SDK for Java 2.x** There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/batch#code-examples). ``` /** * Asynchronously creates a new compute environment in AWS Batch. * * @param computeEnvironmentName the name of the compute environment to create * @param batchIAMRole the IAM role to be used by the compute environment * @param subnet the subnet ID to be used for the compute environment * @param secGroup the security group ID to be used for the compute environment * @return a {@link CompletableFuture} representing the asynchronous operation, which will complete with the * {@link CreateComputeEnvironmentResponse} when the compute environment has been created * @throws BatchException if there is an error creating the compute environment * @throws RuntimeException if there is an unexpected error during the operation */ public CompletableFuture createComputeEnvironmentAsync( String computeEnvironmentName, String batchIAMRole, String subnet, String secGroup) { CreateComputeEnvironmentRequest environmentRequest = CreateComputeEnvironmentRequest.builder() .computeEnvironmentName(computeEnvironmentName) .type(CEType.MANAGED) .state(CEState.ENABLED) .computeResources(ComputeResource.builder() .type(CRType.FARGATE) .maxvCpus(256) .subnets(Collections.singletonList(subnet)) .securityGroupIds(Collections.singletonList(secGroup)) .build()) .serviceRole(batchIAMRole) .build(); CompletableFuture response = getAsyncClient().createComputeEnvironment(environmentRequest); response.whenComplete((resp, ex) -> { if (ex != null) { String errorMessage = "Unexpected error occurred: " + ex.getMessage(); throw new RuntimeException(errorMessage, ex); } }); return response; } ``` + For API details, see [CreateComputeEnvironment](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/CreateComputeEnvironment) in *AWS SDK for Java 2.x API Reference*. ------ # Use `CreateJobQueue` with an AWS SDK or CLI The following code examples show how to use `CreateJobQueue`. Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples: + [Learn the basics](batch_example_batch_Scenario_section.md) + [Getting started with Batch and Fargate](batch_example_fargate_GettingStarted_section.md) ------ #### [ CLI ] **AWS CLI** **To create a low priority job queue with a single compute environment** This example creates a job queue called LowPriority that uses the M4Spot compute environment. Command: ``` aws batch create-job-queue --cli-input-json file:///LowPriority.json ``` JSON file format: ``` { "jobQueueName": "LowPriority", "state": "ENABLED", "priority": 10, "computeEnvironmentOrder": [ { "order": 1, "computeEnvironment": "M4Spot" } ] } ``` Output: ``` { "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority", "jobQueueName": "LowPriority" } ``` **To create a high priority job queue with two compute environments** 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. The scheduler will attempt to place jobs on the C4OnDemand compute environment first. Command: ``` aws batch create-job-queue --cli-input-json file:///HighPriority.json ``` JSON file format: ``` { "jobQueueName": "HighPriority", "state": "ENABLED", "priority": 1, "computeEnvironmentOrder": [ { "order": 1, "computeEnvironment": "C4OnDemand" }, { "order": 2, "computeEnvironment": "M4Spot" } ] } ``` Output: ``` { "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", "jobQueueName": "HighPriority" } ``` + For API details, see [CreateJobQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/create-job-queue.html) in *AWS CLI Command Reference*. ------ #### [ Java ] **SDK for Java 2.x** There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/batch#code-examples). ``` /** * Creates a job queue asynchronously. * * @param jobQueueName the name of the job queue to create * @param computeEnvironmentName the name of the compute environment to associate with the job queue * @return a CompletableFuture that completes with the Amazon Resource Name (ARN) of the job queue */ public CompletableFuture createJobQueueAsync(String jobQueueName, String computeEnvironmentName) { if (jobQueueName == null || jobQueueName.isEmpty()) { throw new IllegalArgumentException("Job queue name cannot be null or empty"); } if (computeEnvironmentName == null || computeEnvironmentName.isEmpty()) { throw new IllegalArgumentException("Compute environment name cannot be null or empty"); } CreateJobQueueRequest request = CreateJobQueueRequest.builder() .jobQueueName(jobQueueName) .priority(1) .computeEnvironmentOrder(ComputeEnvironmentOrder.builder() .computeEnvironment(computeEnvironmentName) .order(1) .build()) .build(); CompletableFuture response = getAsyncClient().createJobQueue(request); response.whenComplete((resp, ex) -> { if (ex != null) { String errorMessage = "Unexpected error occurred: " + ex.getMessage(); throw new RuntimeException(errorMessage, ex); } }); return response.thenApply(CreateJobQueueResponse::jobQueueArn); } ``` + For API details, see [CreateJobQueue](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/CreateJobQueue) in *AWS SDK for Java 2.x API Reference*. ------ # Use `DeleteComputeEnvironment` with an AWS SDK or CLI The following code examples show how to use `DeleteComputeEnvironment`. Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples: + [Learn the basics](batch_example_batch_Scenario_section.md) + [Getting started with Batch and Fargate](batch_example_fargate_GettingStarted_section.md) ------ #### [ CLI ] **AWS CLI** **To delete a compute environment** This example deletes the P2OnDemand compute environment. Command: ``` aws batch delete-compute-environment --compute-environment P2OnDemand ``` + For API details, see [DeleteComputeEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/delete-compute-environment.html) in *AWS CLI Command Reference*. ------ #### [ Java ] **SDK for Java 2.x** There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/batch#code-examples). ``` public CompletableFuture deleteComputeEnvironmentAsync(String computeEnvironmentName) { DeleteComputeEnvironmentRequest deleteComputeEnvironment = DeleteComputeEnvironmentRequest.builder() .computeEnvironment(computeEnvironmentName) .build(); return getAsyncClient().deleteComputeEnvironment(deleteComputeEnvironment) .whenComplete((response, ex) -> { if (ex != null) { Throwable cause = ex.getCause(); if (cause instanceof BatchException) { throw new RuntimeException(cause); } else { throw new RuntimeException("Unexpected error: " + cause.getMessage(), cause); } } }); } ``` + For API details, see [DeleteComputeEnvironment](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DeleteComputeEnvironment) in *AWS SDK for Java 2.x API Reference*. ------ # Use `DeleteJobQueue` with an AWS SDK or CLI The following code examples show how to use `DeleteJobQueue`. Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples: + [Learn the basics](batch_example_batch_Scenario_section.md) + [Getting started with Batch and Fargate](batch_example_fargate_GettingStarted_section.md) ------ #### [ CLI ] **AWS CLI** **To delete a job queue** This example deletes the GPGPU job queue. Command: ``` aws batch delete-job-queue --job-queue GPGPU ``` + For API details, see [DeleteJobQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/delete-job-queue.html) in *AWS CLI Command Reference*. ------ #### [ Java ] **SDK for Java 2.x** There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/batch#code-examples). ``` /** * Deletes a Batch job queue asynchronously. * * @param jobQueueArn The Amazon Resource Name (ARN) of the job queue to delete. * @return A CompletableFuture that represents the asynchronous deletion of the job queue. * The future completes when the job queue has been successfully deleted or if an error occurs. * If successful, the future will be completed with a {@code Void} value. * If an error occurs, the future will be completed exceptionally with the thrown exception. */ public CompletableFuture deleteJobQueueAsync(String jobQueueArn) { DeleteJobQueueRequest deleteRequest = DeleteJobQueueRequest.builder() .jobQueue(jobQueueArn) .build(); CompletableFuture responseFuture = getAsyncClient().deleteJobQueue(deleteRequest); return responseFuture.whenComplete((deleteResponse, ex) -> { if (ex != null) { throw new RuntimeException("Failed to delete job queue: " + ex.getMessage(), ex); } }).thenApply(deleteResponse -> null); } ``` + For API details, see [DeleteJobQueue](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DeleteJobQueue) in *AWS SDK for Java 2.x API Reference*. ------ # Use `DeregisterJobDefinition` with an AWS SDK or CLI The following code examples show how to use `DeregisterJobDefinition`. Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example: + [Learn the basics](batch_example_batch_Scenario_section.md) ------ #### [ CLI ] **AWS CLI** **To deregister a job definition** This example deregisters a job definition called sleep10. Command: ``` aws batch deregister-job-definition --job-definition sleep10 ``` + For API details, see [DeregisterJobDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/deregister-job-definition.html) in *AWS CLI Command Reference*. ------ #### [ Java ] **SDK for Java 2.x** There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/batch#code-examples). ``` /** * Deregisters a job definition asynchronously. * * @param jobDefinition the name of the job definition to be deregistered * @return a CompletableFuture that completes when the job definition has been deregistered * or an exception has occurred */ public CompletableFuture deregisterJobDefinitionAsync(String jobDefinition) { DeregisterJobDefinitionRequest jobDefinitionRequest = DeregisterJobDefinitionRequest.builder() .jobDefinition(jobDefinition) .build(); CompletableFuture responseFuture = getAsyncClient().deregisterJobDefinition(jobDefinitionRequest); responseFuture.whenComplete((response, ex) -> { if (ex != null) { throw new RuntimeException("Unexpected error occurred: " + ex.getMessage(), ex); } }); return responseFuture; } ``` + For API details, see [DeregisterJobDefinition](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DeregisterJobDefinition) in *AWS SDK for Java 2.x API Reference*. ------ # Use `DescribeComputeEnvironments` with an AWS SDK or CLI The following code examples show how to use `DescribeComputeEnvironments`. Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples: + [Learn the basics](batch_example_batch_Scenario_section.md) + [Getting started with Batch and Fargate](batch_example_fargate_GettingStarted_section.md) ------ #### [ CLI ] **AWS CLI** **To describe a compute environment** This example describes the P2OnDemand compute environment. Command: ``` aws batch describe-compute-environments --compute-environments P2OnDemand ``` Output: ``` { "computeEnvironments": [ { "status": "VALID", "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole", "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand", "computeResources": { "subnets": [ "subnet-220c0e0a", "subnet-1a95556d", "subnet-978f6dce" ], "tags": { "Name": "Batch Instance - P2OnDemand" }, "desiredvCpus": 48, "minvCpus": 0, "instanceTypes": [ "p2" ], "securityGroupIds": [ "sg-cf5093b2" ], "instanceRole": "ecsInstanceRole", "maxvCpus": 128, "type": "EC2", "ec2KeyPair": "id_rsa" }, "statusReason": "ComputeEnvironment Healthy", "ecsClusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/P2OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc", "state": "ENABLED", "computeEnvironmentName": "P2OnDemand", "type": "MANAGED" } ] } ``` + For API details, see [DescribeComputeEnvironments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/describe-compute-environments.html) in *AWS CLI Command Reference*. ------ #### [ Java ] **SDK for Java 2.x** There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/batch#code-examples). ``` /** * Checks the status of the specified compute environment. * * @param computeEnvironmentName the name of the compute environment to check * @return a CompletableFuture containing the status of the compute environment, or "ERROR" if an exception occurs */ public CompletableFuture checkComputeEnvironmentsStatus(String computeEnvironmentName) { if (computeEnvironmentName == null || computeEnvironmentName.isEmpty()) { throw new IllegalArgumentException("Compute environment name cannot be null or empty"); } DescribeComputeEnvironmentsRequest environmentsRequest = DescribeComputeEnvironmentsRequest.builder() .computeEnvironments(computeEnvironmentName) .build(); CompletableFuture response = getAsyncClient().describeComputeEnvironments(environmentsRequest); response.whenComplete((resp, ex) -> { if (ex != null) { String errorMessage = "Unexpected error occurred: " + ex.getMessage(); throw new RuntimeException(errorMessage, ex); } }); return response.thenApply(resp -> resp.computeEnvironments().stream() .map(env -> env.statusAsString()) .findFirst() .orElse("UNKNOWN")); } ``` + For API details, see [DescribeComputeEnvironments](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DescribeComputeEnvironments) in *AWS SDK for Java 2.x API Reference*. ------ # Use `DescribeJobQueues` with an AWS SDK or CLI The following code examples show how to use `DescribeJobQueues`. Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples: + [Learn the basics](batch_example_batch_Scenario_section.md) + [Getting started with Batch and Fargate](batch_example_fargate_GettingStarted_section.md) ------ #### [ CLI ] **AWS CLI** **To describe a job queue** This example describes the HighPriority job queue. Command: ``` aws batch describe-job-queues --job-queues HighPriority ``` Output: ``` { "jobQueues": [ { "status": "VALID", "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", "computeEnvironmentOrder": [ { "computeEnvironment": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand", "order": 1 } ], "statusReason": "JobQueue Healthy", "priority": 1, "state": "ENABLED", "jobQueueName": "HighPriority" } ] } ``` + For API details, see [DescribeJobQueues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/describe-job-queues.html) in *AWS CLI Command Reference*. ------ #### [ Java ] **SDK for Java 2.x** There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/batch#code-examples). ``` /** * Asynchronously describes the job queue associated with the specified compute environment. * * @param computeEnvironmentName the name of the compute environment to find the associated job queue for * @return a {@link CompletableFuture} that, when completed, contains the job queue ARN associated with the specified compute environment * @throws RuntimeException if the job queue description fails */ public CompletableFuture describeJobQueueAsync(String computeEnvironmentName) { DescribeJobQueuesRequest describeJobQueuesRequest = DescribeJobQueuesRequest.builder() .build(); CompletableFuture responseFuture = getAsyncClient().describeJobQueues(describeJobQueuesRequest); return responseFuture.whenComplete((describeJobQueuesResponse, ex) -> { if (describeJobQueuesResponse != null) { String jobQueueARN; for (JobQueueDetail jobQueueDetail : describeJobQueuesResponse.jobQueues()) { for (ComputeEnvironmentOrder computeEnvironmentOrder : jobQueueDetail.computeEnvironmentOrder()) { String computeEnvironment = computeEnvironmentOrder.computeEnvironment(); String name = getComputeEnvironmentName(computeEnvironment); if (name.equals(computeEnvironmentName)) { jobQueueARN = jobQueueDetail.jobQueueArn(); logger.info("Job queue ARN associated with the compute environment: " + jobQueueARN); } } } } else { throw new RuntimeException("Failed to describe job queue: " + ex.getMessage(), ex); } }).thenApply(describeJobQueuesResponse -> { String jobQueueARN = ""; for (JobQueueDetail jobQueueDetail : describeJobQueuesResponse.jobQueues()) { for (ComputeEnvironmentOrder computeEnvironmentOrder : jobQueueDetail.computeEnvironmentOrder()) { String computeEnvironment = computeEnvironmentOrder.computeEnvironment(); String name = getComputeEnvironmentName(computeEnvironment); if (name.equals(computeEnvironmentName)) { jobQueueARN = jobQueueDetail.jobQueueArn(); } } } return jobQueueARN; }); } ``` + For API details, see [DescribeJobQueues](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DescribeJobQueues) in *AWS SDK for Java 2.x API Reference*. ------ # Use `DescribeJobs` with an AWS SDK or CLI The following code examples show how to use `DescribeJobs`. Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples: + [Learn the basics](batch_example_batch_Scenario_section.md) + [Getting started with Batch and Fargate](batch_example_fargate_GettingStarted_section.md) ------ #### [ CLI ] **AWS CLI** **To describe a job** The following `describe-jobs` example describes a job with the specified job ID. ``` aws batch describe-jobs \ --jobs bcf0b186-a532-4122-842e-2ccab8d54efb ``` Output: ``` { "jobs": [ { "status": "SUBMITTED", "container": { "mountPoints": [], "image": "busybox", "environment": [], "vcpus": 1, "command": [ "sleep", "60" ], "volumes": [], "memory": 128, "ulimits": [] }, "parameters": {}, "jobDefinition": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1", "jobQueue": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", "jobId": "bcf0b186-a532-4122-842e-2ccab8d54efb", "dependsOn": [], "jobName": "example", "createdAt": 1480483387803 } ] } ``` + For API details, see [DescribeJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/describe-jobs.html) in *AWS CLI Command Reference*. ------ #### [ Java ] **SDK for Java 2.x** There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/batch#code-examples). ``` /** * Asynchronously retrieves the status of a specific job. * * @param jobId the ID of the job to retrieve the status for * @return a CompletableFuture that completes with the job status */ public CompletableFuture describeJobAsync(String jobId) { DescribeJobsRequest describeJobsRequest = DescribeJobsRequest.builder() .jobs(jobId) .build(); CompletableFuture responseFuture = getAsyncClient().describeJobs(describeJobsRequest); return responseFuture.whenComplete((response, ex) -> { if (ex != null) { throw new RuntimeException("Unexpected error occurred: " + ex.getMessage(), ex); } }).thenApply(response -> response.jobs().get(0).status().toString()); } ``` + For API details, see [DescribeJobs](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DescribeJobs) in *AWS SDK for Java 2.x API Reference*. ------ # Use `ListJobsPaginator` with an AWS SDK The following code example shows how to use `ListJobsPaginator`. Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example: + [Learn the basics](batch_example_batch_Scenario_section.md) ------ #### [ Java ] **SDK for Java 2.x** There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/batch#code-examples). ``` /** * Asynchronously lists the jobs in the specified job queue with the given job status. * * @param jobQueue the name of the job queue to list jobs from * @return a List that contains the jobs that succeeded */ public List listJobsAsync(String jobQueue) { if (jobQueue == null || jobQueue.isEmpty()) { throw new IllegalArgumentException("Job queue cannot be null or empty"); } ListJobsRequest listJobsRequest = ListJobsRequest.builder() .jobQueue(jobQueue) .jobStatus(JobStatus.SUCCEEDED) // Filter jobs by status. .build(); List jobSummaries = new ArrayList<>(); ListJobsPublisher listJobsPaginator = getAsyncClient().listJobsPaginator(listJobsRequest); CompletableFuture future = listJobsPaginator.subscribe(response -> { jobSummaries.addAll(response.jobSummaryList()); }); future.join(); return jobSummaries; } ``` + For API details, see [ListJobsPaginator](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/ListJobsPaginator) in *AWS SDK for Java 2.x API Reference*. ------ # Use `RegisterJobDefinition` with an AWS SDK or CLI The following code examples show how to use `RegisterJobDefinition`. Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples: + [Learn the basics](batch_example_batch_Scenario_section.md) + [Getting started with Batch and Fargate](batch_example_fargate_GettingStarted_section.md) ------ #### [ CLI ] **AWS CLI** **To register a job definition** This example registers a job definition for a simple container job. Command: ``` aws batch register-job-definition --job-definition-name sleep30 --type container --container-properties '{ "image": "busybox", "vcpus": 1, "memory": 128, "command": [ "sleep", "30"]}' ``` Output: ``` { "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1", "jobDefinitionName": "sleep30", "revision": 1 } ``` + For API details, see [RegisterJobDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/register-job-definition.html) in *AWS CLI Command Reference*. ------ #### [ Java ] **SDK for Java 2.x** There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/batch#code-examples). ``` /** * Registers a new job definition asynchronously in AWS Batch. *

* When using Fargate as the compute environment, it is crucial to set the * {@link NetworkConfiguration} with {@link AssignPublicIp#ENABLED} to * ensure proper networking configuration for the Fargate tasks. This * allows the tasks to communicate with external services, access the * internet, or communicate within a VPC. * * @param jobDefinitionName the name of the job definition to be registered * @param executionRoleARN the ARN (Amazon Resource Name) of the execution role * that provides permissions for the containers in the job * @param cpuArch a value of either X86_64 or ARM64 required for the service call * @return a CompletableFuture that completes with the ARN of the registered * job definition upon successful execution, or completes exceptionally with * an error if the registration fails */ public CompletableFuture registerJobDefinitionAsync(String jobDefinitionName, String executionRoleARN, String image, String cpuArch) { NetworkConfiguration networkConfiguration = NetworkConfiguration.builder() .assignPublicIp(AssignPublicIp.ENABLED) .build(); ContainerProperties containerProperties = ContainerProperties.builder() .image(image) .executionRoleArn(executionRoleARN) .resourceRequirements( Arrays.asList( ResourceRequirement.builder() .type(ResourceType.VCPU) .value("1") .build(), ResourceRequirement.builder() .type(ResourceType.MEMORY) .value("2048") .build() ) ) .networkConfiguration(networkConfiguration) .runtimePlatform(b -> b .cpuArchitecture(cpuArch) .operatingSystemFamily("LINUX")) .build(); RegisterJobDefinitionRequest request = RegisterJobDefinitionRequest.builder() .jobDefinitionName(jobDefinitionName) .type(JobDefinitionType.CONTAINER) .containerProperties(containerProperties) .platformCapabilities(PlatformCapability.FARGATE) .build(); CompletableFuture future = new CompletableFuture<>(); getAsyncClient().registerJobDefinition(request) .thenApply(RegisterJobDefinitionResponse::jobDefinitionArn) .whenComplete((result, ex) -> { if (ex != null) { future.completeExceptionally(ex); } else { future.complete(result); } }); return future; } ``` + For API details, see [RegisterJobDefinition](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/RegisterJobDefinition) in *AWS SDK for Java 2.x API Reference*. ------ # Use `SubmitJob` with an AWS SDK or CLI The following code examples show how to use `SubmitJob`. Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples: + [Learn the basics](batch_example_batch_Scenario_section.md) + [Getting started with Batch and Fargate](batch_example_fargate_GettingStarted_section.md) ------ #### [ CLI ] **AWS CLI** **To submit a job** This example submits a simple container job called example to the HighPriority job queue. Command: ``` aws batch submit-job --job-name example --job-queue HighPriority --job-definition sleep60 ``` Output: ``` { "jobName": "example", "jobId": "876da822-4198-45f2-a252-6cea32512ea8" } ``` + For API details, see [SubmitJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/submit-job.html) in *AWS CLI Command Reference*. ------ #### [ Java ] **SDK for Java 2.x** There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/batch#code-examples). ``` /** * Submits a job asynchronously to the AWS Batch service. * * @param jobDefinitionName the name of the job definition to use * @param jobQueueName the name of the job queue to submit the job to * @param jobARN the Amazon Resource Name (ARN) of the job definition * @return a CompletableFuture that, when completed, contains the job ID of the submitted job */ public CompletableFuture submitJobAsync(String jobDefinitionName, String jobQueueName, String jobARN) { SubmitJobRequest jobRequest = SubmitJobRequest.builder() .jobDefinition(jobARN) .jobName(jobDefinitionName) .jobQueue(jobQueueName) .build(); CompletableFuture responseFuture = getAsyncClient().submitJob(jobRequest); responseFuture.whenComplete((response, ex) -> { if (ex != null) { throw new RuntimeException("Unexpected error occurred: " + ex.getMessage(), ex); } }); return responseFuture.thenApply(SubmitJobResponse::jobId); } ``` + For API details, see [SubmitJob](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/SubmitJob) in *AWS SDK for Java 2.x API Reference*. ------ # Use `UpdateComputeEnvironment` with an AWS SDK or CLI The following code examples show how to use `UpdateComputeEnvironment`. Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples: + [Learn the basics](batch_example_batch_Scenario_section.md) + [Getting started with Batch and Fargate](batch_example_fargate_GettingStarted_section.md) ------ #### [ CLI ] **AWS CLI** **To update a compute environment** This example disables the P2OnDemand compute environment so it can be deleted. Command: ``` aws batch update-compute-environment --compute-environment P2OnDemand --state DISABLED ``` Output: ``` { "computeEnvironmentName": "P2OnDemand", "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand" } ``` + For API details, see [UpdateComputeEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/update-compute-environment.html) in *AWS CLI Command Reference*. ------ #### [ Java ] **SDK for Java 2.x** There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/batch#code-examples). ``` /** * Disables the specified compute environment asynchronously. * * @param computeEnvironmentName the name of the compute environment to disable * @return a CompletableFuture that completes when the compute environment is disabled */ public CompletableFuture disableComputeEnvironmentAsync(String computeEnvironmentName) { UpdateComputeEnvironmentRequest updateRequest = UpdateComputeEnvironmentRequest.builder() .computeEnvironment(computeEnvironmentName) .state(CEState.DISABLED) .build(); CompletableFuture responseFuture = getAsyncClient().updateComputeEnvironment(updateRequest); responseFuture.whenComplete((response, ex) -> { if (ex != null) { throw new RuntimeException("Failed to disable compute environment: " + ex.getMessage(), ex); } }); return responseFuture; } ``` + For API details, see [UpdateComputeEnvironment](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/UpdateComputeEnvironment) in *AWS SDK for Java 2.x API Reference*. ------ # Use `UpdateJobQueue` with an AWS SDK or CLI The following code examples show how to use `UpdateJobQueue`. Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples: + [Learn the basics](batch_example_batch_Scenario_section.md) + [Getting started with Batch and Fargate](batch_example_fargate_GettingStarted_section.md) ------ #### [ CLI ] **AWS CLI** **To update a job queue** This example disables a job queue so that it can be deleted. Command: ``` aws batch update-job-queue --job-queue GPGPU --state DISABLED ``` Output: ``` { "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU", "jobQueueName": "GPGPU" } ``` + For API details, see [UpdateJobQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/update-job-queue.html) in *AWS CLI Command Reference*. ------ #### [ Java ] **SDK for Java 2.x** There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/batch#code-examples). ``` /** * Disables the specified job queue asynchronously. * * @param jobQueueArn the Amazon Resource Name (ARN) of the job queue to be disabled * @return a {@link CompletableFuture} that completes when the job queue update operation is complete, * or completes exceptionally if an error occurs during the operation */ public CompletableFuture disableJobQueueAsync(String jobQueueArn) { UpdateJobQueueRequest updateRequest = UpdateJobQueueRequest.builder() .jobQueue(jobQueueArn) .state(JQState.DISABLED) .build(); CompletableFuture responseFuture = getAsyncClient().updateJobQueue(updateRequest); return responseFuture.whenComplete((updateResponse, ex) -> { if (ex != null) { throw new RuntimeException("Failed to update job queue: " + ex.getMessage(), ex); } }).thenApply(updateResponse -> null); } ``` + For API details, see [UpdateJobQueue](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/UpdateJobQueue) in *AWS SDK for Java 2.x API Reference*. ------