com.amazonaws.services.batch.AWSBatchAsync Maven / Gradle / Ivy
/*
* Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.batch;
import javax.annotation.Generated;
import com.amazonaws.services.batch.model.*;
/**
* Interface for accessing AWS Batch asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code 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
* {@link com.amazonaws.services.batch.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSBatchAsync extends AWSBatch {
/**
*
* Cancels jobs 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 jobs are cancelled);
* these jobs must be terminated with the TerminateJob operation.
*
*
* @param cancelJobRequest
* @return A Java Future containing the result of the CancelJob operation returned by the service.
* @sample AWSBatchAsync.CancelJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future cancelJobAsync(CancelJobRequest cancelJobRequest);
/**
*
* Cancels jobs 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 jobs are cancelled);
* these jobs must be terminated with the TerminateJob operation.
*
*
* @param cancelJobRequest
* @param 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.
* @return A Java Future containing the result of the CancelJob operation returned by the service.
* @sample AWSBatchAsyncHandler.CancelJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future cancelJobAsync(CancelJobRequest cancelJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGEDcompute
* 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 the latest 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.
*
*
* @param createComputeEnvironmentRequest
* @return A Java Future containing the result of the CreateComputeEnvironment operation returned by the service.
* @sample AWSBatchAsync.CreateComputeEnvironment
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createComputeEnvironmentAsync(CreateComputeEnvironmentRequest createComputeEnvironmentRequest);
/**
*
* Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGEDcompute
* 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 the latest 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.
*
*
* @param createComputeEnvironmentRequest
* @param 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.
* @return A Java Future containing the result of the CreateComputeEnvironment operation returned by the service.
* @sample AWSBatchAsyncHandler.CreateComputeEnvironment
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createComputeEnvironmentAsync(CreateComputeEnvironmentRequest createComputeEnvironmentRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param createJobQueueRequest
* @return A Java Future containing the result of the CreateJobQueue operation returned by the service.
* @sample AWSBatchAsync.CreateJobQueue
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param createJobQueueRequest
* @param 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.
* @return A Java Future containing the result of the CreateJobQueue operation returned by the service.
* @sample AWSBatchAsyncHandler.CreateJobQueue
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createJobQueueAsync(CreateJobQueueRequest createJobQueueRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param deleteComputeEnvironmentRequest
* @return A Java Future containing the result of the DeleteComputeEnvironment operation returned by the service.
* @sample AWSBatchAsync.DeleteComputeEnvironment
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param deleteComputeEnvironmentRequest
* @param 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.
* @return A Java Future containing the result of the DeleteComputeEnvironment operation returned by the service.
* @sample AWSBatchAsyncHandler.DeleteComputeEnvironment
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteComputeEnvironmentAsync(DeleteComputeEnvironmentRequest deleteComputeEnvironmentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue
* operation and terminate any jobs that have not completed with the TerminateJob.
*
*
* It is not necessary to disassociate compute environments from a queue before submitting a
* DeleteJobQueue request.
*
*
* @param deleteJobQueueRequest
* @return A Java Future containing the result of the DeleteJobQueue operation returned by the service.
* @sample AWSBatchAsync.DeleteJobQueue
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteJobQueueAsync(DeleteJobQueueRequest deleteJobQueueRequest);
/**
*
* Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue
* operation and terminate any jobs that have not completed with the TerminateJob.
*
*
* It is not necessary to disassociate compute environments from a queue before submitting a
* DeleteJobQueue request.
*
*
* @param deleteJobQueueRequest
* @param 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.
* @return A Java Future containing the result of the DeleteJobQueue operation returned by the service.
* @sample AWSBatchAsyncHandler.DeleteJobQueue
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteJobQueueAsync(DeleteJobQueueRequest deleteJobQueueRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deregisters an AWS Batch job definition.
*
*
* @param deregisterJobDefinitionRequest
* @return A Java Future containing the result of the DeregisterJobDefinition operation returned by the service.
* @sample AWSBatchAsync.DeregisterJobDefinition
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deregisterJobDefinitionAsync(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest);
/**
*
* Deregisters an AWS Batch job definition.
*
*
* @param deregisterJobDefinitionRequest
* @param 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.
* @return A Java Future containing the result of the DeregisterJobDefinition operation returned by the service.
* @sample AWSBatchAsyncHandler.DeregisterJobDefinition
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deregisterJobDefinitionAsync(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param describeComputeEnvironmentsRequest
* @return A Java Future containing the result of the DescribeComputeEnvironments operation returned by the service.
* @sample AWSBatchAsync.DescribeComputeEnvironments
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param describeComputeEnvironmentsRequest
* @param 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.
* @return A Java Future containing the result of the DescribeComputeEnvironments operation returned by the service.
* @sample AWSBatchAsyncHandler.DescribeComputeEnvironments
* @see AWS API Documentation
*/
java.util.concurrent.Future describeComputeEnvironmentsAsync(
DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
* return job definitions that match that status.
*
*
* @param describeJobDefinitionsRequest
* @return A Java Future containing the result of the DescribeJobDefinitions operation returned by the service.
* @sample AWSBatchAsync.DescribeJobDefinitions
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param describeJobDefinitionsRequest
* @param 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.
* @return A Java Future containing the result of the DescribeJobDefinitions operation returned by the service.
* @sample AWSBatchAsyncHandler.DescribeJobDefinitions
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeJobDefinitionsAsync(DescribeJobDefinitionsRequest describeJobDefinitionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes one or more of your job queues.
*
*
* @param describeJobQueuesRequest
* @return A Java Future containing the result of the DescribeJobQueues operation returned by the service.
* @sample AWSBatchAsync.DescribeJobQueues
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeJobQueuesAsync(DescribeJobQueuesRequest describeJobQueuesRequest);
/**
*
* Describes one or more of your job queues.
*
*
* @param describeJobQueuesRequest
* @param 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.
* @return A Java Future containing the result of the DescribeJobQueues operation returned by the service.
* @sample AWSBatchAsyncHandler.DescribeJobQueues
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeJobQueuesAsync(DescribeJobQueuesRequest describeJobQueuesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes a list of AWS Batch jobs.
*
*
* @param describeJobsRequest
* @return A Java Future containing the result of the DescribeJobs operation returned by the service.
* @sample AWSBatchAsync.DescribeJobs
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeJobsAsync(DescribeJobsRequest describeJobsRequest);
/**
*
* Describes a list of AWS Batch jobs.
*
*
* @param describeJobsRequest
* @param 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.
* @return A Java Future containing the result of the DescribeJobs operation returned by the service.
* @sample AWSBatchAsyncHandler.DescribeJobs
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeJobsAsync(DescribeJobsRequest describeJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of task jobs for a specified job queue. You can filter the results by job status with the
* jobStatus parameter.
*
*
* @param listJobsRequest
* @return A Java Future containing the result of the ListJobs operation returned by the service.
* @sample AWSBatchAsync.ListJobs
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param listJobsRequest
* @param 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.
* @return A Java Future containing the result of the ListJobs operation returned by the service.
* @sample AWSBatchAsyncHandler.ListJobs
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listJobsAsync(ListJobsRequest listJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Registers an AWS Batch job definition.
*
*
* @param registerJobDefinitionRequest
* @return A Java Future containing the result of the RegisterJobDefinition operation returned by the service.
* @sample AWSBatchAsync.RegisterJobDefinition
* @see AWS
* API Documentation
*/
java.util.concurrent.Future registerJobDefinitionAsync(RegisterJobDefinitionRequest registerJobDefinitionRequest);
/**
*
* Registers an AWS Batch job definition.
*
*
* @param registerJobDefinitionRequest
* @param 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.
* @return A Java Future containing the result of the RegisterJobDefinition operation returned by the service.
* @sample AWSBatchAsyncHandler.RegisterJobDefinition
* @see AWS
* API Documentation
*/
java.util.concurrent.Future registerJobDefinitionAsync(RegisterJobDefinitionRequest registerJobDefinitionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters
* defined in the job definition.
*
*
* @param submitJobRequest
* @return A Java Future containing the result of the SubmitJob operation returned by the service.
* @sample AWSBatchAsync.SubmitJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future submitJobAsync(SubmitJobRequest submitJobRequest);
/**
*
* Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters
* defined in the job definition.
*
*
* @param submitJobRequest
* @param 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.
* @return A Java Future containing the result of the SubmitJob operation returned by the service.
* @sample AWSBatchAsyncHandler.SubmitJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future submitJobAsync(SubmitJobRequest submitJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Terminates jobs 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.
*
*
* @param terminateJobRequest
* @return A Java Future containing the result of the TerminateJob operation returned by the service.
* @sample AWSBatchAsync.TerminateJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future terminateJobAsync(TerminateJobRequest terminateJobRequest);
/**
*
* Terminates jobs 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.
*
*
* @param terminateJobRequest
* @param 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.
* @return A Java Future containing the result of the TerminateJob operation returned by the service.
* @sample AWSBatchAsyncHandler.TerminateJob
* @see AWS API
* Documentation
*/
java.util.concurrent.Future terminateJobAsync(TerminateJobRequest terminateJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates an AWS Batch compute environment.
*
*
* @param updateComputeEnvironmentRequest
* @return A Java Future containing the result of the UpdateComputeEnvironment operation returned by the service.
* @sample AWSBatchAsync.UpdateComputeEnvironment
* @see AWS
* API Documentation
*/
java.util.concurrent.Future updateComputeEnvironmentAsync(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest);
/**
*
* Updates an AWS Batch compute environment.
*
*
* @param updateComputeEnvironmentRequest
* @param 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.
* @return A Java Future containing the result of the UpdateComputeEnvironment operation returned by the service.
* @sample AWSBatchAsyncHandler.UpdateComputeEnvironment
* @see AWS
* API Documentation
*/
java.util.concurrent.Future updateComputeEnvironmentAsync(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates a job queue.
*
*
* @param updateJobQueueRequest
* @return A Java Future containing the result of the UpdateJobQueue operation returned by the service.
* @sample AWSBatchAsync.UpdateJobQueue
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateJobQueueAsync(UpdateJobQueueRequest updateJobQueueRequest);
/**
*
* Updates a job queue.
*
*
* @param updateJobQueueRequest
* @param 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.
* @return A Java Future containing the result of the UpdateJobQueue operation returned by the service.
* @sample AWSBatchAsyncHandler.UpdateJobQueue
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateJobQueueAsync(UpdateJobQueueRequest updateJobQueueRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}