@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSBatchAsyncClient extends AWSBatchClient implements AWSBatchAsync
AsyncHandler can be used to receive notification when
an asynchronous operation completes.
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 |
|---|
AWSBatchAsyncClient()
Deprecated.
|
AWSBatchAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AWSBatchAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AWSBatchAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AWSBatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSBatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSBatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AWSBatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AWSBatchAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
builder, cancelJob, createComputeEnvironment, createJobQueue, createSchedulingPolicy, deleteComputeEnvironment, deleteJobQueue, deleteSchedulingPolicy, deregisterJobDefinition, describeComputeEnvironments, describeJobDefinitions, describeJobQueues, describeJobs, describeSchedulingPolicies, getCachedResponseMetadata, getJobQueueSnapshot, listJobs, listSchedulingPolicies, listTagsForResource, registerJobDefinition, submitJob, tagResource, terminateJob, untagResource, updateComputeEnvironment, updateJobQueue, updateSchedulingPolicyaddRequestHandler, 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, waitcancelJob, createComputeEnvironment, createJobQueue, createSchedulingPolicy, deleteComputeEnvironment, deleteJobQueue, deleteSchedulingPolicy, deregisterJobDefinition, describeComputeEnvironments, describeJobDefinitions, describeJobQueues, describeJobs, describeSchedulingPolicies, getCachedResponseMetadata, getJobQueueSnapshot, listJobs, listSchedulingPolicies, listTagsForResource, registerJobDefinition, setEndpoint, setRegion, submitJob, tagResource, terminateJob, untagResource, updateComputeEnvironment, updateJobQueue, updateSchedulingPolicy@Deprecated public AWSBatchAsyncClient()
AWSBatchAsyncClientBuilder.defaultClient()Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
@Deprecated public AWSBatchAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client connects to AWS Batch (ex: proxy settings,
retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AWSBatchAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AWSBatchAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AWSBatchAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AWSBatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AWSBatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AWSBatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AWSBatchAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.public static AWSBatchAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CancelJobResult> cancelJobAsync(CancelJobRequest request)
AWSBatchAsync
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.
cancelJobAsync in interface AWSBatchAsyncrequest - Contains the parameters for CancelJob.public Future<CancelJobResult> cancelJobAsync(CancelJobRequest request, AsyncHandler<CancelJobRequest,CancelJobResult> asyncHandler)
AWSBatchAsync
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.
cancelJobAsync in interface AWSBatchAsyncrequest - Contains the parameters for CancelJob.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateComputeEnvironmentResult> createComputeEnvironmentAsync(CreateComputeEnvironmentRequest request)
AWSBatchAsync
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.
createComputeEnvironmentAsync in interface AWSBatchAsyncrequest - Contains the parameters for CreateComputeEnvironment.public Future<CreateComputeEnvironmentResult> createComputeEnvironmentAsync(CreateComputeEnvironmentRequest request, AsyncHandler<CreateComputeEnvironmentRequest,CreateComputeEnvironmentResult> asyncHandler)
AWSBatchAsync
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.
createComputeEnvironmentAsync in interface AWSBatchAsyncrequest - Contains the parameters for CreateComputeEnvironment.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateJobQueueResult> createJobQueueAsync(CreateJobQueueRequest request)
AWSBatchAsyncCreates 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.
createJobQueueAsync in interface AWSBatchAsyncrequest - Contains the parameters for CreateJobQueue.public Future<CreateJobQueueResult> createJobQueueAsync(CreateJobQueueRequest request, AsyncHandler<CreateJobQueueRequest,CreateJobQueueResult> asyncHandler)
AWSBatchAsyncCreates 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.
createJobQueueAsync in interface AWSBatchAsyncrequest - Contains the parameters for CreateJobQueue.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateSchedulingPolicyResult> createSchedulingPolicyAsync(CreateSchedulingPolicyRequest request)
AWSBatchAsyncCreates an Batch scheduling policy.
createSchedulingPolicyAsync in interface AWSBatchAsyncrequest - Contains the parameters for CreateSchedulingPolicy.public Future<CreateSchedulingPolicyResult> createSchedulingPolicyAsync(CreateSchedulingPolicyRequest request, AsyncHandler<CreateSchedulingPolicyRequest,CreateSchedulingPolicyResult> asyncHandler)
AWSBatchAsyncCreates an Batch scheduling policy.
createSchedulingPolicyAsync in interface AWSBatchAsyncrequest - Contains the parameters for CreateSchedulingPolicy.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteComputeEnvironmentResult> deleteComputeEnvironmentAsync(DeleteComputeEnvironmentRequest request)
AWSBatchAsyncDeletes 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.
deleteComputeEnvironmentAsync in interface AWSBatchAsyncrequest - Contains the parameters for DeleteComputeEnvironment.public Future<DeleteComputeEnvironmentResult> deleteComputeEnvironmentAsync(DeleteComputeEnvironmentRequest request, AsyncHandler<DeleteComputeEnvironmentRequest,DeleteComputeEnvironmentResult> asyncHandler)
AWSBatchAsyncDeletes 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.
deleteComputeEnvironmentAsync in interface AWSBatchAsyncrequest - Contains the parameters for DeleteComputeEnvironment.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteJobQueueResult> deleteJobQueueAsync(DeleteJobQueueRequest request)
AWSBatchAsyncDeletes 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.
deleteJobQueueAsync in interface AWSBatchAsyncrequest - Contains the parameters for DeleteJobQueue.public Future<DeleteJobQueueResult> deleteJobQueueAsync(DeleteJobQueueRequest request, AsyncHandler<DeleteJobQueueRequest,DeleteJobQueueResult> asyncHandler)
AWSBatchAsyncDeletes 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.
deleteJobQueueAsync in interface AWSBatchAsyncrequest - Contains the parameters for DeleteJobQueue.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteSchedulingPolicyResult> deleteSchedulingPolicyAsync(DeleteSchedulingPolicyRequest request)
AWSBatchAsyncDeletes the specified scheduling policy.
You can't delete a scheduling policy that's used in any job queues.
deleteSchedulingPolicyAsync in interface AWSBatchAsyncrequest - Contains the parameters for DeleteSchedulingPolicy.public Future<DeleteSchedulingPolicyResult> deleteSchedulingPolicyAsync(DeleteSchedulingPolicyRequest request, AsyncHandler<DeleteSchedulingPolicyRequest,DeleteSchedulingPolicyResult> asyncHandler)
AWSBatchAsyncDeletes the specified scheduling policy.
You can't delete a scheduling policy that's used in any job queues.
deleteSchedulingPolicyAsync in interface AWSBatchAsyncrequest - Contains the parameters for DeleteSchedulingPolicy.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeregisterJobDefinitionResult> deregisterJobDefinitionAsync(DeregisterJobDefinitionRequest request)
AWSBatchAsyncDeregisters an Batch job definition. Job definitions are permanently deleted after 180 days.
deregisterJobDefinitionAsync in interface AWSBatchAsyncpublic Future<DeregisterJobDefinitionResult> deregisterJobDefinitionAsync(DeregisterJobDefinitionRequest request, AsyncHandler<DeregisterJobDefinitionRequest,DeregisterJobDefinitionResult> asyncHandler)
AWSBatchAsyncDeregisters an Batch job definition. Job definitions are permanently deleted after 180 days.
deregisterJobDefinitionAsync in interface AWSBatchAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeComputeEnvironmentsResult> describeComputeEnvironmentsAsync(DescribeComputeEnvironmentsRequest request)
AWSBatchAsyncDescribes 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.
describeComputeEnvironmentsAsync in interface AWSBatchAsyncrequest - Contains the parameters for DescribeComputeEnvironments.public Future<DescribeComputeEnvironmentsResult> describeComputeEnvironmentsAsync(DescribeComputeEnvironmentsRequest request, AsyncHandler<DescribeComputeEnvironmentsRequest,DescribeComputeEnvironmentsResult> asyncHandler)
AWSBatchAsyncDescribes 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.
describeComputeEnvironmentsAsync in interface AWSBatchAsyncrequest - Contains the parameters for DescribeComputeEnvironments.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeJobDefinitionsResult> describeJobDefinitionsAsync(DescribeJobDefinitionsRequest request)
AWSBatchAsync
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
return job definitions that match that status.
describeJobDefinitionsAsync in interface AWSBatchAsyncrequest - Contains the parameters for DescribeJobDefinitions.public Future<DescribeJobDefinitionsResult> describeJobDefinitionsAsync(DescribeJobDefinitionsRequest request, AsyncHandler<DescribeJobDefinitionsRequest,DescribeJobDefinitionsResult> asyncHandler)
AWSBatchAsync
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
return job definitions that match that status.
describeJobDefinitionsAsync in interface AWSBatchAsyncrequest - Contains the parameters for DescribeJobDefinitions.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeJobQueuesResult> describeJobQueuesAsync(DescribeJobQueuesRequest request)
AWSBatchAsyncDescribes one or more of your job queues.
describeJobQueuesAsync in interface AWSBatchAsyncrequest - Contains the parameters for DescribeJobQueues.public Future<DescribeJobQueuesResult> describeJobQueuesAsync(DescribeJobQueuesRequest request, AsyncHandler<DescribeJobQueuesRequest,DescribeJobQueuesResult> asyncHandler)
AWSBatchAsyncDescribes one or more of your job queues.
describeJobQueuesAsync in interface AWSBatchAsyncrequest - Contains the parameters for DescribeJobQueues.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeJobsResult> describeJobsAsync(DescribeJobsRequest request)
AWSBatchAsyncDescribes a list of Batch jobs.
describeJobsAsync in interface AWSBatchAsyncrequest - Contains the parameters for DescribeJobs.public Future<DescribeJobsResult> describeJobsAsync(DescribeJobsRequest request, AsyncHandler<DescribeJobsRequest,DescribeJobsResult> asyncHandler)
AWSBatchAsyncDescribes a list of Batch jobs.
describeJobsAsync in interface AWSBatchAsyncrequest - Contains the parameters for DescribeJobs.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeSchedulingPoliciesResult> describeSchedulingPoliciesAsync(DescribeSchedulingPoliciesRequest request)
AWSBatchAsyncDescribes one or more of your scheduling policies.
describeSchedulingPoliciesAsync in interface AWSBatchAsyncrequest - Contains the parameters for DescribeSchedulingPolicies.public Future<DescribeSchedulingPoliciesResult> describeSchedulingPoliciesAsync(DescribeSchedulingPoliciesRequest request, AsyncHandler<DescribeSchedulingPoliciesRequest,DescribeSchedulingPoliciesResult> asyncHandler)
AWSBatchAsyncDescribes one or more of your scheduling policies.
describeSchedulingPoliciesAsync in interface AWSBatchAsyncrequest - Contains the parameters for DescribeSchedulingPolicies.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetJobQueueSnapshotResult> getJobQueueSnapshotAsync(GetJobQueueSnapshotRequest request)
AWSBatchAsync
Provides a list of the first 100 RUNNABLE jobs associated to a single job queue.
getJobQueueSnapshotAsync in interface AWSBatchAsyncpublic Future<GetJobQueueSnapshotResult> getJobQueueSnapshotAsync(GetJobQueueSnapshotRequest request, AsyncHandler<GetJobQueueSnapshotRequest,GetJobQueueSnapshotResult> asyncHandler)
AWSBatchAsync
Provides a list of the first 100 RUNNABLE jobs associated to a single job queue.
getJobQueueSnapshotAsync in interface AWSBatchAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListJobsResult> listJobsAsync(ListJobsRequest request)
AWSBatchAsyncReturns 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.
listJobsAsync in interface AWSBatchAsyncrequest - Contains the parameters for ListJobs.public Future<ListJobsResult> listJobsAsync(ListJobsRequest request, AsyncHandler<ListJobsRequest,ListJobsResult> asyncHandler)
AWSBatchAsyncReturns 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.
listJobsAsync in interface AWSBatchAsyncrequest - Contains the parameters for ListJobs.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListSchedulingPoliciesResult> listSchedulingPoliciesAsync(ListSchedulingPoliciesRequest request)
AWSBatchAsyncReturns a list of Batch scheduling policies.
listSchedulingPoliciesAsync in interface AWSBatchAsyncrequest - Contains the parameters for ListSchedulingPolicies.public Future<ListSchedulingPoliciesResult> listSchedulingPoliciesAsync(ListSchedulingPoliciesRequest request, AsyncHandler<ListSchedulingPoliciesRequest,ListSchedulingPoliciesResult> asyncHandler)
AWSBatchAsyncReturns a list of Batch scheduling policies.
listSchedulingPoliciesAsync in interface AWSBatchAsyncrequest - Contains the parameters for ListSchedulingPolicies.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSBatchAsyncLists 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.
listTagsForResourceAsync in interface AWSBatchAsyncrequest - Contains the parameters for ListTagsForResource.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSBatchAsyncLists 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.
listTagsForResourceAsync in interface AWSBatchAsyncrequest - Contains the parameters for ListTagsForResource.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RegisterJobDefinitionResult> registerJobDefinitionAsync(RegisterJobDefinitionRequest request)
AWSBatchAsyncRegisters an Batch job definition.
registerJobDefinitionAsync in interface AWSBatchAsyncrequest - Contains the parameters for RegisterJobDefinition.public Future<RegisterJobDefinitionResult> registerJobDefinitionAsync(RegisterJobDefinitionRequest request, AsyncHandler<RegisterJobDefinitionRequest,RegisterJobDefinitionResult> asyncHandler)
AWSBatchAsyncRegisters an Batch job definition.
registerJobDefinitionAsync in interface AWSBatchAsyncrequest - Contains the parameters for RegisterJobDefinition.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SubmitJobResult> submitJobAsync(SubmitJobRequest request)
AWSBatchAsync
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.
submitJobAsync in interface AWSBatchAsyncrequest - Contains the parameters for SubmitJob.public Future<SubmitJobResult> submitJobAsync(SubmitJobRequest request, AsyncHandler<SubmitJobRequest,SubmitJobResult> asyncHandler)
AWSBatchAsync
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.
submitJobAsync in interface AWSBatchAsyncrequest - Contains the parameters for SubmitJob.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSBatchAsync
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.
tagResourceAsync in interface AWSBatchAsyncrequest - Contains the parameters for TagResource.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSBatchAsync
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.
tagResourceAsync in interface AWSBatchAsyncrequest - Contains the parameters for TagResource.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TerminateJobResult> terminateJobAsync(TerminateJobRequest request)
AWSBatchAsync
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.
terminateJobAsync in interface AWSBatchAsyncrequest - Contains the parameters for TerminateJob.public Future<TerminateJobResult> terminateJobAsync(TerminateJobRequest request, AsyncHandler<TerminateJobRequest,TerminateJobResult> asyncHandler)
AWSBatchAsync
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.
terminateJobAsync in interface AWSBatchAsyncrequest - Contains the parameters for TerminateJob.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSBatchAsyncDeletes specified tags from an Batch resource.
untagResourceAsync in interface AWSBatchAsyncrequest - Contains the parameters for UntagResource.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSBatchAsyncDeletes specified tags from an Batch resource.
untagResourceAsync in interface AWSBatchAsyncrequest - Contains the parameters for UntagResource.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateComputeEnvironmentResult> updateComputeEnvironmentAsync(UpdateComputeEnvironmentRequest request)
AWSBatchAsyncUpdates an Batch compute environment.
updateComputeEnvironmentAsync in interface AWSBatchAsyncrequest - Contains the parameters for UpdateComputeEnvironment.public Future<UpdateComputeEnvironmentResult> updateComputeEnvironmentAsync(UpdateComputeEnvironmentRequest request, AsyncHandler<UpdateComputeEnvironmentRequest,UpdateComputeEnvironmentResult> asyncHandler)
AWSBatchAsyncUpdates an Batch compute environment.
updateComputeEnvironmentAsync in interface AWSBatchAsyncrequest - Contains the parameters for UpdateComputeEnvironment.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateJobQueueResult> updateJobQueueAsync(UpdateJobQueueRequest request)
AWSBatchAsyncUpdates a job queue.
updateJobQueueAsync in interface AWSBatchAsyncrequest - Contains the parameters for UpdateJobQueue.public Future<UpdateJobQueueResult> updateJobQueueAsync(UpdateJobQueueRequest request, AsyncHandler<UpdateJobQueueRequest,UpdateJobQueueResult> asyncHandler)
AWSBatchAsyncUpdates a job queue.
updateJobQueueAsync in interface AWSBatchAsyncrequest - Contains the parameters for UpdateJobQueue.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateSchedulingPolicyResult> updateSchedulingPolicyAsync(UpdateSchedulingPolicyRequest request)
AWSBatchAsyncUpdates a scheduling policy.
updateSchedulingPolicyAsync in interface AWSBatchAsyncrequest - Contains the parameters for UpdateSchedulingPolicy.public Future<UpdateSchedulingPolicyResult> updateSchedulingPolicyAsync(UpdateSchedulingPolicyRequest request, AsyncHandler<UpdateSchedulingPolicyRequest,UpdateSchedulingPolicyResult> asyncHandler)
AWSBatchAsyncUpdates a scheduling policy.
updateSchedulingPolicyAsync in interface AWSBatchAsyncrequest - Contains the parameters for UpdateSchedulingPolicy.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSBatchshutdown in class AWSBatchClient