future = listJobsPaginator.subscribe(response -> {
jobSummaries.addAll(response.jobSummaryList());
});
future.join();
return jobSummaries;
}
/**
* 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;
}
/**
* 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;
}
/**
* 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);
}
/**
* 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);
}
/**
* 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;
});
}
/**
* 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;
}
/**
* 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);
}
/**
* 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());
}
/**
* Disables the specific job queue using the asynchronous Java client.
*
* @param jobQueueArn the Amazon Resource Name (ARN) of the job queue to wait for
* @return a {@link CompletableFuture} that completes when the job queue is disabled
*/
public CompletableFuture waitForJobQueueToBeDisabledAsync(String jobQueueArn) {
AtomicBoolean isDisabled = new AtomicBoolean(false);
return CompletableFuture.runAsync(() -> {
while (!isDisabled.get()) {
DescribeJobQueuesRequest describeRequest = DescribeJobQueuesRequest.builder()
.jobQueues(jobQueueArn)
.build();
CompletableFuture responseFuture = getAsyncClient().describeJobQueues(describeRequest);
responseFuture.whenComplete((describeResponse, ex) -> {
if (describeResponse != null) {
for (JobQueueDetail jobQueue : describeResponse.jobQueues()) {
if (jobQueue.jobQueueArn().equals(jobQueueArn) && jobQueue.state() == JQState.DISABLED) {
isDisabled.set(true);
break;
}
}
} else {
throw new RuntimeException("Error describing job queues", ex);
}
}).join();
if (!isDisabled.get()) {
try {
logger.info("Waiting for job queue to be disabled...");
Thread.sleep(5000);
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new RuntimeException("Thread interrupted while waiting for job queue to be disabled", e);
}
}
}
}).whenComplete((result, throwable) -> {
if (throwable != null) {
throw new RuntimeException("Error while waiting for job queue to be disabled", throwable);
}
});
}
public CompletableFuture getJobQueueARN(String jobQueueName) {
// Describe the job queue asynchronously
CompletableFuture describeJobQueuesFuture = batchClient.describeJobQueues(
DescribeJobQueuesRequest.builder()
.jobQueues(jobQueueName)
.build()
);
// Handle the asynchronous response and return the Job Queue ARN in the CompletableFuture
CompletableFuture jobQueueArnFuture = new CompletableFuture<>();
describeJobQueuesFuture.whenComplete((response, error) -> {
if (error != null) {
if (error instanceof BatchException) {
logger.info("Batch error: " + ((BatchException) error).awsErrorDetails().errorMessage());
} else {
logger.info("Error describing job queue: " + error.getMessage());
}
jobQueueArnFuture.completeExceptionally(new RuntimeException("Failed to retrieve Job Queue ARN", error));
} else {
if (response.jobQueues().isEmpty()) {
jobQueueArnFuture.completeExceptionally(new RuntimeException("Job queue not found: " + jobQueueName));
} else {
// Assuming only one job queue is returned for the given name
String jobQueueArn = response.jobQueues().get(0).jobQueueArn();
jobQueueArnFuture.complete(jobQueueArn);
}
}
});
return jobQueueArnFuture;
}
private static String getComputeEnvironmentName(String computeEnvironment) {
String[] parts = computeEnvironment.split("/");
if (parts.length == 2) {
return parts[1];
}
return null;
}
public CompletableFuture getAccountId() {
StsAsyncClient stsAsyncClient = StsAsyncClient.builder()
.region(Region.US_EAST_1)
.build();
return stsAsyncClient.getCallerIdentity()
.thenApply(GetCallerIdentityResponse::account);
}
}
```
+ 如需 API 詳細資訊，請參閱《*AWS SDK for Java 2.x API 參考*》中的下列主題。
+ [CreateComputeEnvironment](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/CreateComputeEnvironment)
+ [CreateJobQueue](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/CreateJobQueue)
+ [DeleteComputeEnvironment](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DeleteComputeEnvironment)
+ [DeleteJobQueue](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DeleteJobQueue)
+ [DeregisterJobDefinition](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DeregisterJobDefinition)
+ [DescribeComputeEnvironments](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DescribeComputeEnvironments)
+ [DescribeJobQueues](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DescribeJobQueues)
+ [DescribeJobs](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DescribeJobs)
+ [ListJobsPaginator](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/ListJobsPaginator)
+ [RegisterJobDefinition](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/RegisterJobDefinition)
+ [SubmitJob](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/SubmitJob)
+ [UpdateComputeEnvironment](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/UpdateComputeEnvironment)
+ [UpdateJobQueue](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/UpdateJobQueue)
------
# AWS Batch 使用 AWS SDKs的動作
下列程式碼範例示範如何使用 AWS SDKs執行個別 AWS Batch 動作。每個範例均包含 GitHub 的連結，您可以在連結中找到設定和執行程式碼的相關說明。
這些摘錄會呼叫 AWS Batch API，是必須在內容中執行之大型程式的程式碼摘錄。您可以在 [AWS Batch 使用 AWS SDKs案例](batch_code_examples_scenarios.md) 中查看內容中的動作。
下列範例僅包含最常使用的動作。如需完整清單，請參閱《[AWS Batch API 參考](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)
# `CreateComputeEnvironment` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `CreateComputeEnvironment`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](batch_example_batch_Scenario_section.md)
+ [開始使用 Batch 和 Fargate](batch_example_fargate_GettingStarted_section.md)
------
#### [ CLI ]
**AWS CLI**
**使用隨需執行個體建立受管運算環境**
此範例建立受管運算環境，其中包含隨需啟動的特定 C4 執行個體類型。運算環境稱為 C4OnDemand。
命令：
```
aws batch create-compute-environment --cli-input-json file:///C4OnDemand.json
```
JSON 檔案格式：
```
{
"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"
}
```
輸出：
```
{
"computeEnvironmentName": "C4OnDemand",
"computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand"
}
```
**使用 Spot 執行個體建立受管運算環境**
此範例建立一個具有 M4 執行個體類型的託管運算環境，當 Spot 出價等於或低於該執行個體類型的隨選價格的 20% 時啟動該環境。運算環境稱為 M4Spot。
命令：
```
aws batch create-compute-environment --cli-input-json file:///M4Spot.json
```
JSON 檔案格式：
```
{
"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"
}
```
輸出：
```
{
"computeEnvironmentName": "M4Spot",
"computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot"
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateComputeEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/create-compute-environment.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](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;
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [CreateComputeEnvironment](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/CreateComputeEnvironment)。
------
# `CreateJobQueue` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `CreateJobQueue`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](batch_example_batch_Scenario_section.md)
+ [開始使用 Batch 和 Fargate](batch_example_fargate_GettingStarted_section.md)
------
#### [ CLI ]
**AWS CLI**
**使用單一運算環境建立低優先順序任務佇列**
此範例建立一個名為 LowPriority 的任務佇列，該佇列使用 M4Spot 運算環境。
命令：
```
aws batch create-job-queue --cli-input-json file:///LowPriority.json
```
JSON 檔案格式：
```
{
"jobQueueName": "LowPriority",
"state": "ENABLED",
"priority": 10,
"computeEnvironmentOrder": [
{
"order": 1,
"computeEnvironment": "M4Spot"
}
]
}
```
輸出：
```
{
"jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority",
"jobQueueName": "LowPriority"
}
```
**建立具有兩個運算環境的高優先順序任務佇列**
此範例建立名為 HighPriority 的任務佇列，該佇列使用順序為 1 的 C4OnDemand 運算環境，以及順序為 2 的 M4Spot 運算環境。排程器會先嘗試在 C4OnDemand 運算環境中放置任務。
命令：
```
aws batch create-job-queue --cli-input-json file:///HighPriority.json
```
JSON 檔案格式：
```
{
"jobQueueName": "HighPriority",
"state": "ENABLED",
"priority": 1,
"computeEnvironmentOrder": [
{
"order": 1,
"computeEnvironment": "C4OnDemand"
},
{
"order": 2,
"computeEnvironment": "M4Spot"
}
]
}
```
輸出：
```
{
"jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
"jobQueueName": "HighPriority"
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateJobQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/create-job-queue.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](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);
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [CreateJobQueue](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/CreateJobQueue)。
------
# `DeleteComputeEnvironment` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DeleteComputeEnvironment`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](batch_example_batch_Scenario_section.md)
+ [開始使用 Batch 和 Fargate](batch_example_fargate_GettingStarted_section.md)
------
#### [ CLI ]
**AWS CLI**
**刪除運算環境**
此範例刪除 P2OnDemand 運算環境。
命令：
```
aws batch delete-compute-environment --compute-environment P2OnDemand
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteComputeEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/delete-compute-environment.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](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);
}
}
});
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DeleteComputeEnvironment](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DeleteComputeEnvironment)。
------
# `DeleteJobQueue` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DeleteJobQueue`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](batch_example_batch_Scenario_section.md)
+ [開始使用 Batch 和 Fargate](batch_example_fargate_GettingStarted_section.md)
------
#### [ CLI ]
**AWS CLI**
**刪除任務佇列**
此範例刪除 GPGPU 任務佇列。
命令：
```
aws batch delete-job-queue --job-queue GPGPU
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteJobQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/delete-job-queue.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](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);
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DeleteJobQueue](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DeleteJobQueue)。
------
# `DeregisterJobDefinition` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DeregisterJobDefinition`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](batch_example_batch_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**取消註冊任務定義**
此範例取消註冊名為 sleep10 的任務定義。
命令：
```
aws batch deregister-job-definition --job-definition sleep10
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeregisterJobDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/deregister-job-definition.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](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;
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DeregisterJobDefinition](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DeregisterJobDefinition)。
------
# `DescribeComputeEnvironments` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DescribeComputeEnvironments`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](batch_example_batch_Scenario_section.md)
+ [開始使用 Batch 和 Fargate](batch_example_fargate_GettingStarted_section.md)
------
#### [ CLI ]
**AWS CLI**
**描述運算環境**
此範例描述 P2OnDemand 運算環境。
命令：
```
aws batch describe-compute-environments --compute-environments P2OnDemand
```
輸出：
```
{
"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"
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeComputeEnvironments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/describe-compute-environments.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](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"));
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DescribeComputeEnvironments](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DescribeComputeEnvironments)。
------
# `DescribeJobQueues` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DescribeJobQueues`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](batch_example_batch_Scenario_section.md)
+ [開始使用 Batch 和 Fargate](batch_example_fargate_GettingStarted_section.md)
------
#### [ CLI ]
**AWS CLI**
**描述任務佇列**
此範例描述 HighPriority 任務佇列。
命令：
```
aws batch describe-job-queues --job-queues HighPriority
```
輸出：
```
{
"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"
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeJobQueues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/describe-job-queues.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](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;
});
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DescribeJobQueues](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DescribeJobQueues)。
------
# `DescribeJobs` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DescribeJobs`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](batch_example_batch_Scenario_section.md)
+ [開始使用 Batch 和 Fargate](batch_example_fargate_GettingStarted_section.md)
------
#### [ CLI ]
**AWS CLI**
**描述任務**
下列 `describe-jobs` 範例描述具有指定任務 ID 的任務。
```
aws batch describe-jobs \
--jobs bcf0b186-a532-4122-842e-2ccab8d54efb
```
輸出：
```
{
"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
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/describe-jobs.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](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());
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [DescribeJobs](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/DescribeJobs)。
------
# `ListJobsPaginator` 搭配 AWS SDK 使用
以下程式碼範例顯示如何使用 `ListJobsPaginator`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](batch_example_batch_Scenario_section.md)
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](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;
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [ListJobsPaginator](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/ListJobsPaginator)。
------
# `RegisterJobDefinition` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `RegisterJobDefinition`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](batch_example_batch_Scenario_section.md)
+ [開始使用 Batch 和 Fargate](batch_example_fargate_GettingStarted_section.md)
------
#### [ CLI ]
**AWS CLI**
**註冊任務定義**
此範例會註冊簡單容器任務的任務定義。
命令：
```
aws batch register-job-definition --job-definition-name sleep30 --type container --container-properties '{ "image": "busybox", "vcpus": 1, "memory": 128, "command": [ "sleep", "30"]}'
```
輸出：
```
{
"jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1",
"jobDefinitionName": "sleep30",
"revision": 1
}
```
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [RegisterJobDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/register-job-definition.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](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;
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [RegisterJobDefinition](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/RegisterJobDefinition)。
------
# `SubmitJob` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `SubmitJob`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](batch_example_batch_Scenario_section.md)
+ [開始使用 Batch 和 Fargate](batch_example_fargate_GettingStarted_section.md)
------
#### [ CLI ]
**AWS CLI**
**提交任務**
此範例將稱為範例的簡單容器任務，提交至 HighPriority 任務佇列。
命令：
```
aws batch submit-job --job-name example --job-queue HighPriority --job-definition sleep60
```
輸出：
```
{
"jobName": "example",
"jobId": "876da822-4198-45f2-a252-6cea32512ea8"
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [SubmitJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/submit-job.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](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);
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [SubmitJob](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/SubmitJob)。
------
# `UpdateComputeEnvironment` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `UpdateComputeEnvironment`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](batch_example_batch_Scenario_section.md)
+ [開始使用 Batch 和 Fargate](batch_example_fargate_GettingStarted_section.md)
------
#### [ CLI ]
**AWS CLI**
**更新運算環境**
此範例停用 P2OnDemand 運算環境，以將其刪除。
命令：
```
aws batch update-compute-environment --compute-environment P2OnDemand --state DISABLED
```
輸出：
```
{
"computeEnvironmentName": "P2OnDemand",
"computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand"
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateComputeEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/update-compute-environment.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](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;
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [UpdateComputeEnvironment](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/UpdateComputeEnvironment)。
------
# `UpdateJobQueue` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `UpdateJobQueue`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](batch_example_batch_Scenario_section.md)
+ [開始使用 Batch 和 Fargate](batch_example_fargate_GettingStarted_section.md)
------
#### [ CLI ]
**AWS CLI**
**更新任務佇列**
此範例停用任務佇列，以將其刪除。
命令：
```
aws batch update-job-queue --job-queue GPGPU --state DISABLED
```
輸出：
```
{
"jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU",
"jobQueueName": "GPGPU"
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UpdateJobQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/update-job-queue.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](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);
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [UpdateJobQueue](https://docs.aws.amazon.com/goto/SdkForJavaV2/batch-2016-08-10/UpdateJobQueue)。
------