com.amazonaws.services.batch

Interface AWSBatch

All Known Subinterfaces:

AWSBatchAsync

All Known Implementing Classes:

AbstractAWSBatch, AbstractAWSBatchAsync, AWSBatchAsyncClient, AWSBatchClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSBatch

Interface for accessing AWS Batch.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSBatch instead.

Batch

Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of the batch computing to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts a familiar batch computing software approach. You can use Batch to efficiently provision resources, and work toward eliminating capacity constraints, reducing your overall compute costs, and delivering results more quickly.

As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus on analyzing results and solving your specific problems instead.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CancelJobResult	cancelJob(CancelJobRequest cancelJobRequest) Cancels a job in an Batch job queue.
CreateComputeEnvironmentResult	createComputeEnvironment(CreateComputeEnvironmentRequest createComputeEnvironmentRequest) Creates an Batch compute environment.
CreateJobQueueResult	createJobQueue(CreateJobQueueRequest createJobQueueRequest) Creates an Batch job queue.
CreateSchedulingPolicyResult	createSchedulingPolicy(CreateSchedulingPolicyRequest createSchedulingPolicyRequest) Creates an Batch scheduling policy.
DeleteComputeEnvironmentResult	deleteComputeEnvironment(DeleteComputeEnvironmentRequest deleteComputeEnvironmentRequest) Deletes an Batch compute environment.
DeleteJobQueueResult	deleteJobQueue(DeleteJobQueueRequest deleteJobQueueRequest) Deletes the specified job queue.
DeleteSchedulingPolicyResult	deleteSchedulingPolicy(DeleteSchedulingPolicyRequest deleteSchedulingPolicyRequest) Deletes the specified scheduling policy.
DeregisterJobDefinitionResult	deregisterJobDefinition(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest) Deregisters an Batch job definition.
DescribeComputeEnvironmentsResult	describeComputeEnvironments(DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest) Describes one or more of your compute environments.
DescribeJobDefinitionsResult	describeJobDefinitions(DescribeJobDefinitionsRequest describeJobDefinitionsRequest) Describes a list of job definitions.
DescribeJobQueuesResult	describeJobQueues(DescribeJobQueuesRequest describeJobQueuesRequest) Describes one or more of your job queues.
DescribeJobsResult	describeJobs(DescribeJobsRequest describeJobsRequest) Describes a list of Batch jobs.
DescribeSchedulingPoliciesResult	describeSchedulingPolicies(DescribeSchedulingPoliciesRequest describeSchedulingPoliciesRequest) Describes one or more of your scheduling policies.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetJobQueueSnapshotResult	getJobQueueSnapshot(GetJobQueueSnapshotRequest getJobQueueSnapshotRequest) Provides a list of the first 100 RUNNABLE jobs associated to a single job queue.
ListJobsResult	listJobs(ListJobsRequest listJobsRequest) Returns a list of Batch jobs.
ListSchedulingPoliciesResult	listSchedulingPolicies(ListSchedulingPoliciesRequest listSchedulingPoliciesRequest) Returns a list of Batch scheduling policies.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for an Batch resource.
RegisterJobDefinitionResult	registerJobDefinition(RegisterJobDefinitionRequest registerJobDefinitionRequest) Registers an Batch job definition.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
SubmitJobResult	submitJob(SubmitJobRequest submitJobRequest) Submits an Batch job from a job definition.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Associates the specified tags to a resource with the specified resourceArn.
TerminateJobResult	terminateJob(TerminateJobRequest terminateJobRequest) Terminates a job in a job queue.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Deletes specified tags from an Batch resource.
UpdateComputeEnvironmentResult	updateComputeEnvironment(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest) Updates an Batch compute environment.
UpdateJobQueueResult	updateJobQueue(UpdateJobQueueRequest updateJobQueueRequest) Updates a job queue.
UpdateSchedulingPolicyResult	updateSchedulingPolicy(UpdateSchedulingPolicyRequest updateSchedulingPolicyRequest) Updates a scheduling policy.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("batch.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "batch.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "batch.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "batch.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "batch.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

cancelJob

CancelJobResult cancelJob(CancelJobRequest cancelJobRequest)

Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED or PENDING are canceled. A job inRUNNABLE remains in RUNNABLE until it reaches the head of the job queue. Then the job status is updated to FAILED.

A PENDING job is canceled after all dependency jobs are completed. Therefore, it may take longer than expected to cancel a job in PENDING status.

When you try to cancel an array parent job in PENDING, Batch attempts to cancel all child jobs. The array parent job is canceled when all child jobs are completed.

Jobs that progressed to the STARTING or RUNNING state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.

Parameters:

cancelJobRequest - Contains the parameters for CancelJob.

Returns:

Result of the CancelJob operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

Samples:

• To cancel a job

  This example cancels a job with the specified job ID.
  

  AWSBatch client = AWSBatchClientBuilder.standard().build();
  CancelJobRequest request = new CancelJobRequest().withJobId("1d828f65-7a4d-42e8-996d-3b900ed59dc4").withReason("Cancelling job.");
  CancelJobResult response = client.cancelJob(request);

createComputeEnvironment

CreateComputeEnvironmentResult createComputeEnvironment(CreateComputeEnvironmentRequest createComputeEnvironmentRequest)

Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use EC2 resources.

In a managed compute environment, Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price.

Multi-node parallel jobs aren't supported on Spot Instances.

In an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide.

To create a compute environment that uses EKS resources, the caller must have permissions to call eks:DescribeCluster.

Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is available. You're responsible for the management of the guest operating system. This includes any updates and security patches. You're also responsible for any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete these steps:

1. Create a new compute environment with the new AMI.

2. Add the compute environment to an existing job queue.

3. Remove the earlier compute environment from your job queue.

4. Delete the earlier compute environment.

In April 2022, Batch added enhanced support for updating compute environments. For more information, see Updating compute environments. To use the enhanced updating of compute environments to update AMIs, follow these rules:

• Either don't set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role.

• Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, or SPOT_PRICE_CAPACITY_OPTIMIZED.

• Set the update to latest image version (updateToLatestImageVersion) parameter to true. The updateToLatestImageVersion parameter is used when you update a compute environment. This parameter is ignored when you create a compute environment.

• Don't specify an AMI ID in imageId, imageIdOverride (in ec2Configuration ), or in the launch template (launchTemplate). In that case, Batch selects the latest Amazon ECS optimized AMI that's supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID in the imageId or imageIdOverride parameters, or the launch template identified by the LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the imageId or imageIdOverride parameters. It can only be replaced by specifying a different launch template, or if the launch template version is set to $Default or $Latest, by setting either a new default version for the launch template (if $Default) or by adding a new version to the launch template (if $Latest).

If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be re-selected. If the version setting in the launch template (launchTemplate) is set to $Latest or $Default, the latest or default version of the launch template is evaluated up at the time of the infrastructure update, even if the launchTemplate wasn't updated.

Parameters:

createComputeEnvironmentRequest - Contains the parameters for CreateComputeEnvironment.

Returns:

Result of the CreateComputeEnvironment operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

Samples:

• To create a managed EC2 Spot compute environment

  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.
  

  AWSBatch client = AWSBatchClientBuilder.standard().build();
  CreateComputeEnvironmentRequest request = new CreateComputeEnvironmentRequest()
          .withComputeEnvironmentName("C4OnDemand")
          .withType("MANAGED")
          .withState("ENABLED")
          .withComputeResources(
                  new ComputeResource().withType("EC2").withMinvCpus(0).withMaxvCpus(128).withDesiredvCpus(48)
                          .withInstanceTypes("c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge")
                          .withSubnets("subnet-220c0e0a", "subnet-1a95556d", "subnet-978f6dce").withSecurityGroupIds("sg-cf5093b2")
                          .withEc2KeyPair("id_rsa").withInstanceRole("ecsInstanceRole"))
          .withServiceRole("arn:aws:iam::012345678910:role/AWSBatchServiceRole");
  CreateComputeEnvironmentResult response = client.createComputeEnvironment(request);AWSBatch client = AWSBatchClientBuilder.standard().build();
  CreateComputeEnvironmentRequest request = new CreateComputeEnvironmentRequest()
          .withComputeEnvironmentName("M4Spot")
          .withType("MANAGED")
          .withState("ENABLED")
          .withComputeResources(
                  new ComputeResource().withType("SPOT").withMinvCpus(0).withMaxvCpus(128).withDesiredvCpus(4).withInstanceTypes("m4")
                          .withSubnets("subnet-220c0e0a", "subnet-1a95556d", "subnet-978f6dce").withSecurityGroupIds("sg-cf5093b2")
                          .withEc2KeyPair("id_rsa").withInstanceRole("ecsInstanceRole").withBidPercentage(20)
                          .withSpotIamFleetRole("arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role"))
          .withServiceRole("arn:aws:iam::012345678910:role/AWSBatchServiceRole");
  CreateComputeEnvironmentResult response = client.createComputeEnvironment(request);

createJobQueue

CreateJobQueueResult createJobQueue(CreateJobQueueRequest createJobQueueRequest)

Creates an Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.

You also set a priority to the job queue that determines the order that the Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.

Parameters:

createJobQueueRequest - Contains the parameters for CreateJobQueue.

Returns:

Result of the CreateJobQueue operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

Samples:

• To create a job queue with multiple 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.
  

  AWSBatch client = AWSBatchClientBuilder.standard().build();
  CreateJobQueueRequest request = new CreateJobQueueRequest().withJobQueueName("LowPriority").withState("ENABLED").withPriority(1)
          .withComputeEnvironmentOrder(new ComputeEnvironmentOrder().withOrder(1).withComputeEnvironment("M4Spot"));
  CreateJobQueueResult response = client.createJobQueue(request);AWSBatch client = AWSBatchClientBuilder.standard().build();
  CreateJobQueueRequest request = new CreateJobQueueRequest()
          .withJobQueueName("HighPriority")
          .withState("ENABLED")
          .withPriority(10)
          .withComputeEnvironmentOrder(new ComputeEnvironmentOrder().withOrder(1).withComputeEnvironment("C4OnDemand"),
                  new ComputeEnvironmentOrder().withOrder(2).withComputeEnvironment("M4Spot"));
  CreateJobQueueResult response = client.createJobQueue(request);

createSchedulingPolicy

CreateSchedulingPolicyResult createSchedulingPolicy(CreateSchedulingPolicyRequest createSchedulingPolicyRequest)

Creates an Batch scheduling policy.

Parameters:

createSchedulingPolicyRequest - Contains the parameters for CreateSchedulingPolicy.

Returns:

Result of the CreateSchedulingPolicy operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

deleteComputeEnvironment

DeleteComputeEnvironmentResult deleteComputeEnvironment(DeleteComputeEnvironmentRequest deleteComputeEnvironmentRequest)

Deletes an Batch compute environment.

Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. Compute environments that use Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment enters an invalid state.

Parameters:

deleteComputeEnvironmentRequest - Contains the parameters for DeleteComputeEnvironment.

Returns:

Result of the DeleteComputeEnvironment operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

Samples:

• To delete a compute environment

  This example deletes the P2OnDemand compute environment.
  

  AWSBatch client = AWSBatchClientBuilder.standard().build();
  DeleteComputeEnvironmentRequest request = new DeleteComputeEnvironmentRequest().withComputeEnvironment("P2OnDemand");
  DeleteComputeEnvironmentResult response = client.deleteComputeEnvironment(request);

deleteJobQueue

DeleteJobQueueResult deleteJobQueue(DeleteJobQueueRequest deleteJobQueueRequest)

Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are eventually terminated when you delete a job queue. The jobs are terminated at a rate of about 16 jobs each second.

It's not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request.

Parameters:

deleteJobQueueRequest - Contains the parameters for DeleteJobQueue.

Returns:

Result of the DeleteJobQueue operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

Samples:

• To delete a job queue

  This example deletes the GPGPU job queue.
  

  AWSBatch client = AWSBatchClientBuilder.standard().build();
  DeleteJobQueueRequest request = new DeleteJobQueueRequest().withJobQueue("GPGPU");
  DeleteJobQueueResult response = client.deleteJobQueue(request);

deleteSchedulingPolicy

DeleteSchedulingPolicyResult deleteSchedulingPolicy(DeleteSchedulingPolicyRequest deleteSchedulingPolicyRequest)

Deletes the specified scheduling policy.

You can't delete a scheduling policy that's used in any job queues.

Parameters:

deleteSchedulingPolicyRequest - Contains the parameters for DeleteSchedulingPolicy.

Returns:

Result of the DeleteSchedulingPolicy operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

deregisterJobDefinition

DeregisterJobDefinitionResult deregisterJobDefinition(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest)

Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.

Parameters:

deregisterJobDefinitionRequest -

Returns:

Result of the DeregisterJobDefinition operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

Samples:

• To deregister a job definition

  This example deregisters a job definition called sleep10.
  

  AWSBatch client = AWSBatchClientBuilder.standard().build();
  DeregisterJobDefinitionRequest request = new DeregisterJobDefinitionRequest().withJobDefinition("sleep10");
  DeregisterJobDefinitionResult response = client.deregisterJobDefinition(request);

describeComputeEnvironments

DescribeComputeEnvironmentsResult describeComputeEnvironments(DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest)

Describes one or more of your compute environments.

If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you launch your Amazon ECS container instances into.

Parameters:

describeComputeEnvironmentsRequest - Contains the parameters for DescribeComputeEnvironments.

Returns:

Result of the DescribeComputeEnvironments operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

Samples:

• To describe a compute environment

  This example describes the P2OnDemand compute environment.
  

  AWSBatch client = AWSBatchClientBuilder.standard().build();
  DescribeComputeEnvironmentsRequest request = new DescribeComputeEnvironmentsRequest().withComputeEnvironments("P2OnDemand");
  DescribeComputeEnvironmentsResult response = client.describeComputeEnvironments(request);

describeJobDefinitions

DescribeJobDefinitionsResult describeJobDefinitions(DescribeJobDefinitionsRequest describeJobDefinitionsRequest)

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.

Parameters:

describeJobDefinitionsRequest - Contains the parameters for DescribeJobDefinitions.

Returns:

Result of the DescribeJobDefinitions operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

Samples:

• To describe active job definitions

  This example describes all of your active job definitions.
  

  AWSBatch client = AWSBatchClientBuilder.standard().build();
  DescribeJobDefinitionsRequest request = new DescribeJobDefinitionsRequest().withStatus("ACTIVE");
  DescribeJobDefinitionsResult response = client.describeJobDefinitions(request);

describeJobQueues

DescribeJobQueuesResult describeJobQueues(DescribeJobQueuesRequest describeJobQueuesRequest)

Describes one or more of your job queues.

Parameters:

describeJobQueuesRequest - Contains the parameters for DescribeJobQueues.

Returns:

Result of the DescribeJobQueues operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

Samples:

• To describe a job queue

  This example describes the HighPriority job queue.
  

  AWSBatch client = AWSBatchClientBuilder.standard().build();
  DescribeJobQueuesRequest request = new DescribeJobQueuesRequest().withJobQueues("HighPriority");
  DescribeJobQueuesResult response = client.describeJobQueues(request);

describeJobs

DescribeJobsResult describeJobs(DescribeJobsRequest describeJobsRequest)

Describes a list of Batch jobs.

Parameters:

describeJobsRequest - Contains the parameters for DescribeJobs.

Returns:

Result of the DescribeJobs operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

Samples:

• To describe a specific job

  This example describes a job with the specified job ID.
  

  AWSBatch client = AWSBatchClientBuilder.standard().build();
  DescribeJobsRequest request = new DescribeJobsRequest().withJobs("24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9");
  DescribeJobsResult response = client.describeJobs(request);

describeSchedulingPolicies

DescribeSchedulingPoliciesResult describeSchedulingPolicies(DescribeSchedulingPoliciesRequest describeSchedulingPoliciesRequest)

Describes one or more of your scheduling policies.

Parameters:

describeSchedulingPoliciesRequest - Contains the parameters for DescribeSchedulingPolicies.

Returns:

Result of the DescribeSchedulingPolicies operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

getJobQueueSnapshot

GetJobQueueSnapshotResult getJobQueueSnapshot(GetJobQueueSnapshotRequest getJobQueueSnapshotRequest)

Provides a list of the first 100 RUNNABLE jobs associated to a single job queue.

Parameters:

getJobQueueSnapshotRequest -

Returns:

Result of the GetJobQueueSnapshot operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

listJobs

ListJobsResult listJobs(ListJobsRequest listJobsRequest)

Returns a list of Batch jobs.

You must specify only one of the following items:

• A job queue ID to return a list of jobs in that job queue

• A multi-node parallel job ID to return a list of nodes for that job

• An array job ID to return a list of the children for that job

You can filter the results by job status with the jobStatus parameter. If you don't specify a status, only RUNNING jobs are returned.

Parameters:

listJobsRequest - Contains the parameters for ListJobs.

Returns:

Result of the ListJobs operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

Samples:

• To list submitted jobs

  This example lists jobs in the HighPriority job queue that are in the SUBMITTED job status.
  

  AWSBatch client = AWSBatchClientBuilder.standard().build();
  ListJobsRequest request = new ListJobsRequest().withJobQueue("HighPriority");
  ListJobsResult response = client.listJobs(request);AWSBatch client = AWSBatchClientBuilder.standard().build();
  ListJobsRequest request = new ListJobsRequest().withJobQueue("HighPriority").withJobStatus("SUBMITTED");
  ListJobsResult response = client.listJobs(request);

listSchedulingPolicies

ListSchedulingPoliciesResult listSchedulingPolicies(ListSchedulingPoliciesRequest listSchedulingPoliciesRequest)

Returns a list of Batch scheduling policies.

Parameters:

listSchedulingPoliciesRequest - Contains the parameters for ListSchedulingPolicies.

Returns:

Result of the ListSchedulingPolicies operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

Parameters:

listTagsForResourceRequest - Contains the parameters for ListTagsForResource.

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

registerJobDefinition

RegisterJobDefinitionResult registerJobDefinition(RegisterJobDefinitionRequest registerJobDefinitionRequest)

Registers an Batch job definition.

Parameters:

registerJobDefinitionRequest - Contains the parameters for RegisterJobDefinition.

Returns:

Result of the RegisterJobDefinition operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

Samples:

• To register a job definition

  This example registers a job definition for a simple container job.
  

  AWSBatch client = AWSBatchClientBuilder.standard().build();
  RegisterJobDefinitionRequest request = new RegisterJobDefinitionRequest().withJobDefinitionName("sleep10").withType("container")
          .withContainerProperties(new ContainerProperties().withImage("busybox").withVcpus(1).withMemory(128).withCommand("sleep", "10"));
  RegisterJobDefinitionResult response = client.registerJobDefinition(request);

submitJob

SubmitJobResult submitJob(SubmitJobRequest submitJobRequest)

Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the resourceRequirements objects in the job definition are the exception. They can't be overridden this way using the memory and vcpus parameters. Rather, you must specify updates to job definition parameters in a resourceRequirements object that's included in the containerOverrides parameter.

Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.

Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.

Parameters:

submitJobRequest - Contains the parameters for SubmitJob.

Returns:

Result of the SubmitJob operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

Samples:

• To submit a job to a queue

  This example submits a simple container job called example to the HighPriority job queue.
  

  AWSBatch client = AWSBatchClientBuilder.standard().build();
  SubmitJobRequest request = new SubmitJobRequest().withJobName("example").withJobQueue("HighPriority").withJobDefinition("sleep60");
  SubmitJobResult response = client.submitJob(request);

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

Parameters:

tagResourceRequest - Contains the parameters for TagResource.

Returns:

Result of the TagResource operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

terminateJob

TerminateJobResult terminateJob(TerminateJobRequest terminateJobRequest)

Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled.

Parameters:

terminateJobRequest - Contains the parameters for TerminateJob.

Returns:

Result of the TerminateJob operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

Samples:

• To terminate a job

  This example terminates a job with the specified job ID.
  

  AWSBatch client = AWSBatchClientBuilder.standard().build();
  TerminateJobRequest request = new TerminateJobRequest().withJobId("61e743ed-35e4-48da-b2de-5c8333821c84").withReason("Terminating job.");
  TerminateJobResult response = client.terminateJob(request);

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Deletes specified tags from an Batch resource.

Parameters:

untagResourceRequest - Contains the parameters for UntagResource.

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

updateComputeEnvironment

UpdateComputeEnvironmentResult updateComputeEnvironment(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest)

Updates an Batch compute environment.

Parameters:

updateComputeEnvironmentRequest - Contains the parameters for UpdateComputeEnvironment.

Returns:

Result of the UpdateComputeEnvironment operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

Samples:

• To update a compute environment

  This example disables the P2OnDemand compute environment so it can be deleted.
  

  AWSBatch client = AWSBatchClientBuilder.standard().build();
  UpdateComputeEnvironmentRequest request = new UpdateComputeEnvironmentRequest().withComputeEnvironment("P2OnDemand").withState("DISABLED");
  UpdateComputeEnvironmentResult response = client.updateComputeEnvironment(request);

updateJobQueue

UpdateJobQueueResult updateJobQueue(UpdateJobQueueRequest updateJobQueueRequest)

Updates a job queue.

Parameters:

updateJobQueueRequest - Contains the parameters for UpdateJobQueue.

Returns:

Result of the UpdateJobQueue operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

Samples:

• To update a job queue

  This example disables a job queue so that it can be deleted.
  

  AWSBatch client = AWSBatchClientBuilder.standard().build();
  UpdateJobQueueRequest request = new UpdateJobQueueRequest().withJobQueue("GPGPU").withState("DISABLED");
  UpdateJobQueueResult response = client.updateJobQueue(request);

updateSchedulingPolicy

UpdateSchedulingPolicyResult updateSchedulingPolicy(UpdateSchedulingPolicyRequest updateSchedulingPolicyRequest)

Updates a scheduling policy.

Parameters:

updateSchedulingPolicyRequest - Contains the parameters for UpdateSchedulingPolicy.

Returns:

Result of the UpdateSchedulingPolicy operation returned by the service.

Throws:

ClientException - These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException - These errors are usually caused by a server issue.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.