@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSBatchClient extends AmazonWebServiceClient implements AWSBatch
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.
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 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.
cancelJob in interface AWSBatchcancelJobRequest - Contains the parameters for CancelJob.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.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 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:
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.
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.
createComputeEnvironment in interface AWSBatchcreateComputeEnvironmentRequest - Contains the parameters for CreateComputeEnvironment.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.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 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.
createJobQueue in interface AWSBatchcreateJobQueueRequest - Contains the parameters for CreateJobQueue.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.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 CreateSchedulingPolicyResult createSchedulingPolicy(CreateSchedulingPolicyRequest request)
Creates an Batch scheduling policy.
createSchedulingPolicy in interface AWSBatchcreateSchedulingPolicyRequest - Contains the parameters for CreateSchedulingPolicy.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.public DeleteComputeEnvironmentResult deleteComputeEnvironment(DeleteComputeEnvironmentRequest request)
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.
deleteComputeEnvironment in interface AWSBatchdeleteComputeEnvironmentRequest - Contains the parameters for DeleteComputeEnvironment.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.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 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.
deleteJobQueue in interface AWSBatchdeleteJobQueueRequest - Contains the parameters for DeleteJobQueue.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.AWSBatch client = AWSBatchClientBuilder.standard().build();
DeleteJobQueueRequest request = new DeleteJobQueueRequest().withJobQueue("GPGPU");
DeleteJobQueueResult response = client.deleteJobQueue(request);public DeleteSchedulingPolicyResult deleteSchedulingPolicy(DeleteSchedulingPolicyRequest request)
Deletes the specified scheduling policy.
You can't delete a scheduling policy that's used in any job queues.
deleteSchedulingPolicy in interface AWSBatchdeleteSchedulingPolicyRequest - Contains the parameters for DeleteSchedulingPolicy.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.public DeregisterJobDefinitionResult deregisterJobDefinition(DeregisterJobDefinitionRequest request)
Deregisters an 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. 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.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 launch your Amazon ECS container instances into.
describeComputeEnvironments in interface AWSBatchdescribeComputeEnvironmentsRequest - Contains the parameters for DescribeComputeEnvironments.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.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 - Contains the parameters for DescribeJobDefinitions.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.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 - Contains the parameters for DescribeJobQueues.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.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 Batch jobs.
describeJobs in interface AWSBatchdescribeJobsRequest - Contains the parameters for DescribeJobs.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.AWSBatch client = AWSBatchClientBuilder.standard().build();
DescribeJobsRequest request = new DescribeJobsRequest().withJobs("24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9");
DescribeJobsResult response = client.describeJobs(request);public DescribeSchedulingPoliciesResult describeSchedulingPolicies(DescribeSchedulingPoliciesRequest request)
Describes one or more of your scheduling policies.
describeSchedulingPolicies in interface AWSBatchdescribeSchedulingPoliciesRequest - Contains the parameters for DescribeSchedulingPolicies.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.public GetJobQueueSnapshotResult getJobQueueSnapshot(GetJobQueueSnapshotRequest request)
Provides a list of the first 100 RUNNABLE jobs associated to a single job queue.
getJobQueueSnapshot in interface AWSBatchgetJobQueueSnapshotRequest - 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.public ListJobsResult listJobs(ListJobsRequest request)
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.
listJobs in interface AWSBatchlistJobsRequest - Contains the parameters for ListJobs.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.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 ListSchedulingPoliciesResult listSchedulingPolicies(ListSchedulingPoliciesRequest request)
Returns a list of Batch scheduling policies.
listSchedulingPolicies in interface AWSBatchlistSchedulingPoliciesRequest - Contains the parameters for ListSchedulingPolicies.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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
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.
listTagsForResource in interface AWSBatchlistTagsForResourceRequest - Contains the parameters for ListTagsForResource.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.public RegisterJobDefinitionResult registerJobDefinition(RegisterJobDefinitionRequest request)
Registers an Batch job definition.
registerJobDefinition in interface AWSBatchregisterJobDefinitionRequest - Contains the parameters for RegisterJobDefinition.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.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 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.
submitJob in interface AWSBatchsubmitJobRequest - Contains the parameters for SubmitJob.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.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
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.
tagResource in interface AWSBatchtagResourceRequest - Contains the parameters for TagResource.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.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 - Contains the parameters for TerminateJob.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.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 Batch resource.
untagResource in interface AWSBatchuntagResourceRequest - Contains the parameters for UntagResource.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.public UpdateComputeEnvironmentResult updateComputeEnvironment(UpdateComputeEnvironmentRequest request)
Updates an Batch compute environment.
updateComputeEnvironment in interface AWSBatchupdateComputeEnvironmentRequest - Contains the parameters for UpdateComputeEnvironment.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.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 - Contains the parameters for UpdateJobQueue.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.AWSBatch client = AWSBatchClientBuilder.standard().build();
UpdateJobQueueRequest request = new UpdateJobQueueRequest().withJobQueue("GPGPU").withState("DISABLED");
UpdateJobQueueResult response = client.updateJobQueue(request);public UpdateSchedulingPolicyResult updateSchedulingPolicy(UpdateSchedulingPolicyRequest request)
Updates a scheduling policy.
updateSchedulingPolicy in interface AWSBatchupdateSchedulingPolicyRequest - Contains the parameters for UpdateSchedulingPolicy.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.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