@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSBatchClient extends AmazonWebServiceClient implements AWSBatch
Using AWS Batch, you can run batch computing workloads on the AWS Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. AWS Batch utilizes the advantages of this computing workload to remove the undifferentiated heavy lifting of configuring and managing required infrastructure, while also adopting a familiar batch computing software approach. Given these advantages, AWS Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively helping to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.
As a fully managed service, AWS Batch can run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads. With AWS Batch, there's no need to install or manage batch computing software. This means that you can focus your time and energy on analyzing results and solving your specific problems.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSBatchClient()
Deprecated.
|
AWSBatchClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSBatchClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSBatchClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSBatchClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSBatchClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSBatchClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSBatchClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@Deprecated public AWSBatchClient()
AWSBatchClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSBatchClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to AWS Batch (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSBatchClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSBatchClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSBatchClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS Batch (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSBatchClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSBatchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS Batch (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSBatchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS Batch (ex: proxy settings,
retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AWSBatchClientBuilder builder()
public CancelJobResult cancelJob(CancelJobRequest request)
Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or
RUNNABLE state are canceled. Jobs that have progressed to STARTING or
RUNNING are not canceled (but the API operation still succeeds, even if no job is canceled); these
jobs must be terminated with the TerminateJob operation.
cancelJob in interface AWSBatchcancelJobRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.AWSBatch client = AWSBatchClientBuilder.standard().build();
CancelJobRequest request = new CancelJobRequest().withJobId("1d828f65-7a4d-42e8-996d-3b900ed59dc4").withReason("Cancelling job.");
CancelJobResult response = client.cancelJob(request);public CreateComputeEnvironmentResult createComputeEnvironment(CreateComputeEnvironmentRequest request)
Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute
environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources.
UNMANAGED compute environments can only use EC2 resources.
In a managed compute environment, AWS 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. You can choose either to use EC2 On-Demand Instances and EC2 Spot Instances, or to 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 below a specified percentage of the On-Demand price.
Multi-node parallel jobs are not supported on Spot Instances.
In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMI. However, you need to verify that your AMI meets the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it. Then, manually 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.
AWS Batch doesn't upgrade the AMIs in a compute environment after it's created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS-optimized AMI is available. Therefore, you're responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs, complete these steps:
Create a new compute environment with the new AMI.
Add the compute environment to an existing job queue.
Remove the earlier compute environment from your job queue.
Delete the earlier compute environment.
createComputeEnvironment in interface AWSBatchcreateComputeEnvironmentRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.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);public CreateJobQueueResult createJobQueue(CreateJobQueueRequest request)
Creates an AWS 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 in which the AWS 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.
createJobQueue in interface AWSBatchcreateJobQueueRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.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);public DeleteComputeEnvironmentResult deleteComputeEnvironment(DeleteComputeEnvironmentRequest request)
Deletes an AWS 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 AWS Fargate resources must terminate all
active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute
environment will end up in an invalid state.
deleteComputeEnvironment in interface AWSBatchdeleteComputeEnvironmentRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.AWSBatch client = AWSBatchClientBuilder.standard().build();
DeleteComputeEnvironmentRequest request = new DeleteComputeEnvironmentRequest().withComputeEnvironment("P2OnDemand");
DeleteComputeEnvironmentResult response = client.deleteComputeEnvironment(request);public DeleteJobQueueResult deleteJobQueue(DeleteJobQueueRequest request)
Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are terminated when you delete a job queue.
It's not necessary to disassociate compute environments from a queue before submitting a
DeleteJobQueue request.
deleteJobQueue in interface AWSBatchdeleteJobQueueRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.AWSBatch client = AWSBatchClientBuilder.standard().build();
DeleteJobQueueRequest request = new DeleteJobQueueRequest().withJobQueue("GPGPU");
DeleteJobQueueResult response = client.deleteJobQueue(request);public DeregisterJobDefinitionResult deregisterJobDefinition(DeregisterJobDefinitionRequest request)
Deregisters an AWS Batch job definition. Job definitions are permanently deleted after 180 days.
deregisterJobDefinition in interface AWSBatchderegisterJobDefinitionRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.AWSBatch client = AWSBatchClientBuilder.standard().build();
DeregisterJobDefinitionRequest request = new DeregisterJobDefinitionRequest().withJobDefinition("sleep10");
DeregisterJobDefinitionResult response = client.deregisterJobDefinition(request);public DescribeComputeEnvironmentsResult describeComputeEnvironments(DescribeComputeEnvironmentsRequest request)
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 should launch your Amazon ECS container instances
into.
describeComputeEnvironments in interface AWSBatchdescribeComputeEnvironmentsRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.AWSBatch client = AWSBatchClientBuilder.standard().build();
DescribeComputeEnvironmentsRequest request = new DescribeComputeEnvironmentsRequest().withComputeEnvironments("P2OnDemand");
DescribeComputeEnvironmentsResult response = client.describeComputeEnvironments(request);public DescribeJobDefinitionsResult describeJobDefinitions(DescribeJobDefinitionsRequest request)
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
return job definitions that match that status.
describeJobDefinitions in interface AWSBatchdescribeJobDefinitionsRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.AWSBatch client = AWSBatchClientBuilder.standard().build();
DescribeJobDefinitionsRequest request = new DescribeJobDefinitionsRequest().withStatus("ACTIVE");
DescribeJobDefinitionsResult response = client.describeJobDefinitions(request);public DescribeJobQueuesResult describeJobQueues(DescribeJobQueuesRequest request)
Describes one or more of your job queues.
describeJobQueues in interface AWSBatchdescribeJobQueuesRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.AWSBatch client = AWSBatchClientBuilder.standard().build();
DescribeJobQueuesRequest request = new DescribeJobQueuesRequest().withJobQueues("HighPriority");
DescribeJobQueuesResult response = client.describeJobQueues(request);public DescribeJobsResult describeJobs(DescribeJobsRequest request)
Describes a list of AWS Batch jobs.
describeJobs in interface AWSBatchdescribeJobsRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.AWSBatch client = AWSBatchClientBuilder.standard().build();
DescribeJobsRequest request = new DescribeJobsRequest().withJobs("24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9");
DescribeJobsResult response = client.describeJobs(request);public ListJobsResult listJobs(ListJobsRequest request)
Returns a list of AWS 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 that job's nodes
An array job ID to return a list of that job's children
You can filter the results by job status with the jobStatus parameter. If you don't specify a
status, only RUNNING jobs are returned.
listJobs in interface AWSBatchlistJobsRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.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);public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags for an AWS Batch resource. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
listTagsForResource in interface AWSBatchlistTagsForResourceRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.public RegisterJobDefinitionResult registerJobDefinition(RegisterJobDefinitionRequest request)
Registers an AWS Batch job definition.
registerJobDefinition in interface AWSBatchregisterJobDefinitionRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.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);public SubmitJobResult submitJob(SubmitJobRequest request)
Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.
Jobs run on Fargate resources don't run for more than 14 days. After 14 days, the Fargate resources might no longer be available and the job is terminated.
submitJob in interface AWSBatchsubmitJobRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.AWSBatch client = AWSBatchClientBuilder.standard().build();
SubmitJobRequest request = new SubmitJobRequest().withJobName("example").withJobQueue("HighPriority").withJobDefinition("sleep60");
SubmitJobResult response = client.submitJob(request);public TagResourceResult tagResource(TagResourceRequest request)
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
associated with that resource are deleted as well. AWS Batch resources that support tags are compute
environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP)
jobs are not supported.
tagResource in interface AWSBatchtagResourceRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.public TerminateJobResult terminateJob(TerminateJobRequest request)
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.
terminateJob in interface AWSBatchterminateJobRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.AWSBatch client = AWSBatchClientBuilder.standard().build();
TerminateJobRequest request = new TerminateJobRequest().withJobId("61e743ed-35e4-48da-b2de-5c8333821c84").withReason("Terminating job.");
TerminateJobResult response = client.terminateJob(request);public UntagResourceResult untagResource(UntagResourceRequest request)
Deletes specified tags from an AWS Batch resource.
untagResource in interface AWSBatchuntagResourceRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.public UpdateComputeEnvironmentResult updateComputeEnvironment(UpdateComputeEnvironmentRequest request)
Updates an AWS Batch compute environment.
updateComputeEnvironment in interface AWSBatchupdateComputeEnvironmentRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.AWSBatch client = AWSBatchClientBuilder.standard().build();
UpdateComputeEnvironmentRequest request = new UpdateComputeEnvironmentRequest().withComputeEnvironment("P2OnDemand").withState("DISABLED");
UpdateComputeEnvironmentResult response = client.updateComputeEnvironment(request);public UpdateJobQueueResult updateJobQueue(UpdateJobQueueRequest request)
Updates a job queue.
updateJobQueue in interface AWSBatchupdateJobQueueRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permissions to use the action or resource, or specifying an identifier that isn't
valid.ServerException - These errors are usually caused by a server issue.AWSBatch client = AWSBatchClientBuilder.standard().build();
UpdateJobQueueRequest request = new UpdateJobQueueRequest().withJobQueue("GPGPU").withState("DISABLED");
UpdateJobQueueResult response = client.updateJobQueue(request);public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata in interface AWSBatchrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSBatchshutdown in class AmazonWebServiceClient