@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSBatchAsync extends AWSBatch
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSBatchAsync instead.
AWS Batch enables you to run batch computing workloads on the AWS Cloud. Batch computing is a common way for developers, scientists, and engineers to access large amounts of compute resources, and AWS Batch removes the undifferentiated heavy lifting of configuring and managing the required infrastructure. AWS Batch will be familiar to users of traditional batch computing software. This service can efficiently provision resources in response to jobs submitted in order to eliminate capacity constraints, reduce compute costs, and deliver results quickly.
As a fully managed service, AWS Batch enables developers, scientists, and engineers to run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes the workload distribution based on the quantity and scale of the workloads. With AWS Batch, there is no need to install or manage batch computing software, which allows you to focus on analyzing results and solving problems. AWS Batch reduces operational complexities, saves time, and reduces costs, which makes it easy for developers, scientists, and engineers to run their batch jobs in the AWS Cloud.
ENDPOINT_PREFIXcancelJob, createComputeEnvironment, createJobQueue, deleteComputeEnvironment, deleteJobQueue, deregisterJobDefinition, describeComputeEnvironments, describeJobDefinitions, describeJobQueues, describeJobs, getCachedResponseMetadata, listJobs, registerJobDefinition, setEndpoint, setRegion, shutdown, submitJob, terminateJob, updateComputeEnvironment, updateJobQueueFuture<CancelJobResult> cancelJobAsync(CancelJobRequest cancelJobRequest)
Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or
RUNNABLE state are cancelled. Jobs that have progressed to STARTING or
RUNNING are not cancelled (but the API operation still succeeds, even if no job is cancelled); these
jobs must be terminated with the TerminateJob operation.
cancelJobRequest - Future<CancelJobResult> cancelJobAsync(CancelJobRequest cancelJobRequest, AsyncHandler<CancelJobRequest,CancelJobResult> asyncHandler)
Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or
RUNNABLE state are cancelled. Jobs that have progressed to STARTING or
RUNNING are not cancelled (but the API operation still succeeds, even if no job is cancelled); these
jobs must be terminated with the TerminateJob operation.
cancelJobRequest - 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.Future<CreateComputeEnvironmentResult> createComputeEnvironmentAsync(CreateComputeEnvironmentRequest createComputeEnvironmentRequest)
Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute
environments.
In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use a recent, approved version of the Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.
In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see Container Instance AMIs in the Amazon EC2 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 and then manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS Container Instance in the Amazon EC2 Container Service Developer Guide.
createComputeEnvironmentRequest - Future<CreateComputeEnvironmentResult> createComputeEnvironmentAsync(CreateComputeEnvironmentRequest createComputeEnvironmentRequest, AsyncHandler<CreateComputeEnvironmentRequest,CreateComputeEnvironmentResult> asyncHandler)
Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute
environments.
In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use a recent, approved version of the Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.
In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see Container Instance AMIs in the Amazon EC2 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 and then manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS Container Instance in the Amazon EC2 Container Service Developer Guide.
createComputeEnvironmentRequest - 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.Future<CreateJobQueueResult> createJobQueueAsync(CreateJobQueueRequest createJobQueueRequest)
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.
createJobQueueRequest - Future<CreateJobQueueResult> createJobQueueAsync(CreateJobQueueRequest createJobQueueRequest, AsyncHandler<CreateJobQueueRequest,CreateJobQueueResult> asyncHandler)
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.
createJobQueueRequest - 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.Future<DeleteComputeEnvironmentResult> deleteComputeEnvironmentAsync(DeleteComputeEnvironmentRequest deleteComputeEnvironmentRequest)
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.
deleteComputeEnvironmentRequest - Future<DeleteComputeEnvironmentResult> deleteComputeEnvironmentAsync(DeleteComputeEnvironmentRequest deleteComputeEnvironmentRequest, AsyncHandler<DeleteComputeEnvironmentRequest,DeleteComputeEnvironmentResult> asyncHandler)
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.
deleteComputeEnvironmentRequest - 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.Future<DeleteJobQueueResult> deleteJobQueueAsync(DeleteJobQueueRequest deleteJobQueueRequest)
Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are terminated when you delete a job queue.
It is not necessary to disassociate compute environments from a queue before submitting a
DeleteJobQueue request.
deleteJobQueueRequest - Future<DeleteJobQueueResult> deleteJobQueueAsync(DeleteJobQueueRequest deleteJobQueueRequest, AsyncHandler<DeleteJobQueueRequest,DeleteJobQueueResult> asyncHandler)
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 is not necessary to disassociate compute environments from a queue before submitting a
DeleteJobQueue request.
deleteJobQueueRequest - 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.Future<DeregisterJobDefinitionResult> deregisterJobDefinitionAsync(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest)
Deregisters an AWS Batch job definition.
deregisterJobDefinitionRequest - Future<DeregisterJobDefinitionResult> deregisterJobDefinitionAsync(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest, AsyncHandler<DeregisterJobDefinitionRequest,DeregisterJobDefinitionResult> asyncHandler)
Deregisters an AWS Batch job definition.
deregisterJobDefinitionRequest - 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.Future<DescribeComputeEnvironmentsResult> describeComputeEnvironmentsAsync(DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest)
Describes one or more of your compute environments.
If you are 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.
describeComputeEnvironmentsRequest - Future<DescribeComputeEnvironmentsResult> describeComputeEnvironmentsAsync(DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest, AsyncHandler<DescribeComputeEnvironmentsRequest,DescribeComputeEnvironmentsResult> asyncHandler)
Describes one or more of your compute environments.
If you are 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.
describeComputeEnvironmentsRequest - 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.Future<DescribeJobDefinitionsResult> describeJobDefinitionsAsync(DescribeJobDefinitionsRequest describeJobDefinitionsRequest)
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
return job definitions that match that status.
describeJobDefinitionsRequest - Future<DescribeJobDefinitionsResult> describeJobDefinitionsAsync(DescribeJobDefinitionsRequest describeJobDefinitionsRequest, AsyncHandler<DescribeJobDefinitionsRequest,DescribeJobDefinitionsResult> asyncHandler)
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
return job definitions that match that status.
describeJobDefinitionsRequest - 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.Future<DescribeJobQueuesResult> describeJobQueuesAsync(DescribeJobQueuesRequest describeJobQueuesRequest)
Describes one or more of your job queues.
describeJobQueuesRequest - Future<DescribeJobQueuesResult> describeJobQueuesAsync(DescribeJobQueuesRequest describeJobQueuesRequest, AsyncHandler<DescribeJobQueuesRequest,DescribeJobQueuesResult> asyncHandler)
Describes one or more of your job queues.
describeJobQueuesRequest - 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.Future<DescribeJobsResult> describeJobsAsync(DescribeJobsRequest describeJobsRequest)
Describes a list of AWS Batch jobs.
describeJobsRequest - Future<DescribeJobsResult> describeJobsAsync(DescribeJobsRequest describeJobsRequest, AsyncHandler<DescribeJobsRequest,DescribeJobsResult> asyncHandler)
Describes a list of AWS Batch jobs.
describeJobsRequest - 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.Future<ListJobsResult> listJobsAsync(ListJobsRequest listJobsRequest)
Returns a list of task jobs for a specified job queue. You can filter the results by job status with the
jobStatus parameter. If you do not specify a status, only RUNNING jobs are returned.
listJobsRequest - Future<ListJobsResult> listJobsAsync(ListJobsRequest listJobsRequest, AsyncHandler<ListJobsRequest,ListJobsResult> asyncHandler)
Returns a list of task jobs for a specified job queue. You can filter the results by job status with the
jobStatus parameter. If you do not specify a status, only RUNNING jobs are returned.
listJobsRequest - 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.Future<RegisterJobDefinitionResult> registerJobDefinitionAsync(RegisterJobDefinitionRequest registerJobDefinitionRequest)
Registers an AWS Batch job definition.
registerJobDefinitionRequest - Future<RegisterJobDefinitionResult> registerJobDefinitionAsync(RegisterJobDefinitionRequest registerJobDefinitionRequest, AsyncHandler<RegisterJobDefinitionRequest,RegisterJobDefinitionResult> asyncHandler)
Registers an AWS Batch job definition.
registerJobDefinitionRequest - 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.Future<SubmitJobResult> submitJobAsync(SubmitJobRequest submitJobRequest)
Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.
submitJobRequest - Future<SubmitJobResult> submitJobAsync(SubmitJobRequest submitJobRequest, AsyncHandler<SubmitJobRequest,SubmitJobResult> asyncHandler)
Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.
submitJobRequest - 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.Future<TerminateJobResult> terminateJobAsync(TerminateJobRequest terminateJobRequest)
Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are
terminated, which causes them to transition to FAILED. Jobs that have not progressed to the
STARTING state are cancelled.
terminateJobRequest - Future<TerminateJobResult> terminateJobAsync(TerminateJobRequest terminateJobRequest, AsyncHandler<TerminateJobRequest,TerminateJobResult> asyncHandler)
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.
terminateJobRequest - 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.Future<UpdateComputeEnvironmentResult> updateComputeEnvironmentAsync(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest)
Updates an AWS Batch compute environment.
updateComputeEnvironmentRequest - Future<UpdateComputeEnvironmentResult> updateComputeEnvironmentAsync(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest, AsyncHandler<UpdateComputeEnvironmentRequest,UpdateComputeEnvironmentResult> asyncHandler)
Updates an AWS Batch compute environment.
updateComputeEnvironmentRequest - 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.Future<UpdateJobQueueResult> updateJobQueueAsync(UpdateJobQueueRequest updateJobQueueRequest)
Updates a job queue.
updateJobQueueRequest - Future<UpdateJobQueueResult> updateJobQueueAsync(UpdateJobQueueRequest updateJobQueueRequest, AsyncHandler<UpdateJobQueueRequest,UpdateJobQueueResult> asyncHandler)
Updates a job queue.
updateJobQueueRequest - 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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.