@Generated(value="software.amazon.awssdk:codegen") public interface BatchAsyncClient extends SdkClient
builder()
method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static BatchAsyncClient create()
BatchAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static BatchAsyncClientBuilder builder()
BatchAsyncClient.default CompletableFuture<CancelJobResponse> cancelJob(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 - default CompletableFuture<CancelJobResponse> cancelJob(Consumer<CancelJobRequest.Builder> 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.
This is a convenience which creates an instance of the CancelJobRequest.Builder avoiding the need to
create one manually via CancelJobRequest.builder()
cancelJobRequest - A Consumer that will call methods on CancelJobRequest.Builder to create a request.default CompletableFuture<CreateComputeEnvironmentResponse> createComputeEnvironment(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 - default CompletableFuture<CreateComputeEnvironmentResponse> createComputeEnvironment(Consumer<CreateComputeEnvironmentRequest.Builder> 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.
This is a convenience which creates an instance of the CreateComputeEnvironmentRequest.Builder avoiding
the need to create one manually via CreateComputeEnvironmentRequest.builder()
createComputeEnvironmentRequest - A Consumer that will call methods on CreateComputeEnvironmentRequest.Builder to create a
request.default CompletableFuture<CreateJobQueueResponse> createJobQueue(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 - default CompletableFuture<CreateJobQueueResponse> createJobQueue(Consumer<CreateJobQueueRequest.Builder> 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.
This is a convenience which creates an instance of the CreateJobQueueRequest.Builder avoiding the need to
create one manually via CreateJobQueueRequest.builder()
createJobQueueRequest - A Consumer that will call methods on CreateJobQueueRequest.Builder to create a request.default CompletableFuture<DeleteComputeEnvironmentResponse> deleteComputeEnvironment(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 - default CompletableFuture<DeleteComputeEnvironmentResponse> deleteComputeEnvironment(Consumer<DeleteComputeEnvironmentRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteComputeEnvironmentRequest.Builder avoiding
the need to create one manually via DeleteComputeEnvironmentRequest.builder()
deleteComputeEnvironmentRequest - A Consumer that will call methods on DeleteComputeEnvironmentRequest.Builder to create a
request.default CompletableFuture<DeleteJobQueueResponse> deleteJobQueue(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 - default CompletableFuture<DeleteJobQueueResponse> deleteJobQueue(Consumer<DeleteJobQueueRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteJobQueueRequest.Builder avoiding the need to
create one manually via DeleteJobQueueRequest.builder()
deleteJobQueueRequest - A Consumer that will call methods on DeleteJobQueueRequest.Builder to create a request.default CompletableFuture<DeregisterJobDefinitionResponse> deregisterJobDefinition(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest)
Deregisters an AWS Batch job definition.
deregisterJobDefinitionRequest - default CompletableFuture<DeregisterJobDefinitionResponse> deregisterJobDefinition(Consumer<DeregisterJobDefinitionRequest.Builder> deregisterJobDefinitionRequest)
Deregisters an AWS Batch job definition.
This is a convenience which creates an instance of the DeregisterJobDefinitionRequest.Builder avoiding
the need to create one manually via DeregisterJobDefinitionRequest.builder()
deregisterJobDefinitionRequest - A Consumer that will call methods on DeregisterJobDefinitionRequest.Builder to create a
request.default CompletableFuture<DescribeComputeEnvironmentsResponse> describeComputeEnvironments(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 - default CompletableFuture<DescribeComputeEnvironmentsResponse> describeComputeEnvironments(Consumer<DescribeComputeEnvironmentsRequest.Builder> 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.
This is a convenience which creates an instance of the DescribeComputeEnvironmentsRequest.Builder
avoiding the need to create one manually via DescribeComputeEnvironmentsRequest.builder()
describeComputeEnvironmentsRequest - A Consumer that will call methods on DescribeComputeEnvironmentsRequest.Builder to create
a request.default CompletableFuture<DescribeComputeEnvironmentsResponse> describeComputeEnvironments()
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.
default CompletableFuture<DescribeJobDefinitionsResponse> describeJobDefinitions(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 - default CompletableFuture<DescribeJobDefinitionsResponse> describeJobDefinitions(Consumer<DescribeJobDefinitionsRequest.Builder> describeJobDefinitionsRequest)
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
return job definitions that match that status.
This is a convenience which creates an instance of the DescribeJobDefinitionsRequest.Builder avoiding the
need to create one manually via DescribeJobDefinitionsRequest.builder()
describeJobDefinitionsRequest - A Consumer that will call methods on DescribeJobDefinitionsRequest.Builder to create a
request.default CompletableFuture<DescribeJobDefinitionsResponse> describeJobDefinitions()
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
return job definitions that match that status.
default CompletableFuture<DescribeJobQueuesResponse> describeJobQueues(DescribeJobQueuesRequest describeJobQueuesRequest)
Describes one or more of your job queues.
describeJobQueuesRequest - default CompletableFuture<DescribeJobQueuesResponse> describeJobQueues(Consumer<DescribeJobQueuesRequest.Builder> describeJobQueuesRequest)
Describes one or more of your job queues.
This is a convenience which creates an instance of the DescribeJobQueuesRequest.Builder avoiding the need
to create one manually via DescribeJobQueuesRequest.builder()
describeJobQueuesRequest - A Consumer that will call methods on DescribeJobQueuesRequest.Builder to create a request.default CompletableFuture<DescribeJobQueuesResponse> describeJobQueues()
Describes one or more of your job queues.
default CompletableFuture<DescribeJobsResponse> describeJobs(DescribeJobsRequest describeJobsRequest)
Describes a list of AWS Batch jobs.
describeJobsRequest - default CompletableFuture<DescribeJobsResponse> describeJobs(Consumer<DescribeJobsRequest.Builder> describeJobsRequest)
Describes a list of AWS Batch jobs.
This is a convenience which creates an instance of the DescribeJobsRequest.Builder avoiding the need to
create one manually via DescribeJobsRequest.builder()
describeJobsRequest - A Consumer that will call methods on DescribeJobsRequest.Builder to create a request.default CompletableFuture<ListJobsResponse> listJobs(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 - default CompletableFuture<ListJobsResponse> listJobs(Consumer<ListJobsRequest.Builder> 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.
This is a convenience which creates an instance of the ListJobsRequest.Builder avoiding the need to
create one manually via ListJobsRequest.builder()
listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.default CompletableFuture<RegisterJobDefinitionResponse> registerJobDefinition(RegisterJobDefinitionRequest registerJobDefinitionRequest)
Registers an AWS Batch job definition.
registerJobDefinitionRequest - default CompletableFuture<RegisterJobDefinitionResponse> registerJobDefinition(Consumer<RegisterJobDefinitionRequest.Builder> registerJobDefinitionRequest)
Registers an AWS Batch job definition.
This is a convenience which creates an instance of the RegisterJobDefinitionRequest.Builder avoiding the
need to create one manually via RegisterJobDefinitionRequest.builder()
registerJobDefinitionRequest - A Consumer that will call methods on RegisterJobDefinitionRequest.Builder to create a
request.default CompletableFuture<SubmitJobResponse> submitJob(SubmitJobRequest submitJobRequest)
Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.
submitJobRequest - default CompletableFuture<SubmitJobResponse> submitJob(Consumer<SubmitJobRequest.Builder> submitJobRequest)
Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.
This is a convenience which creates an instance of the SubmitJobRequest.Builder avoiding the need to
create one manually via SubmitJobRequest.builder()
submitJobRequest - A Consumer that will call methods on SubmitJobRequest.Builder to create a request.default CompletableFuture<TerminateJobResponse> terminateJob(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 - default CompletableFuture<TerminateJobResponse> terminateJob(Consumer<TerminateJobRequest.Builder> 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.
This is a convenience which creates an instance of the TerminateJobRequest.Builder avoiding the need to
create one manually via TerminateJobRequest.builder()
terminateJobRequest - A Consumer that will call methods on TerminateJobRequest.Builder to create a request.default CompletableFuture<UpdateComputeEnvironmentResponse> updateComputeEnvironment(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest)
Updates an AWS Batch compute environment.
updateComputeEnvironmentRequest - default CompletableFuture<UpdateComputeEnvironmentResponse> updateComputeEnvironment(Consumer<UpdateComputeEnvironmentRequest.Builder> updateComputeEnvironmentRequest)
Updates an AWS Batch compute environment.
This is a convenience which creates an instance of the UpdateComputeEnvironmentRequest.Builder avoiding
the need to create one manually via UpdateComputeEnvironmentRequest.builder()
updateComputeEnvironmentRequest - A Consumer that will call methods on UpdateComputeEnvironmentRequest.Builder to create a
request.default CompletableFuture<UpdateJobQueueResponse> updateJobQueue(UpdateJobQueueRequest updateJobQueueRequest)
Updates a job queue.
updateJobQueueRequest - default CompletableFuture<UpdateJobQueueResponse> updateJobQueue(Consumer<UpdateJobQueueRequest.Builder> updateJobQueueRequest)
Updates a job queue.
This is a convenience which creates an instance of the UpdateJobQueueRequest.Builder avoiding the need to
create one manually via UpdateJobQueueRequest.builder()
updateJobQueueRequest - A Consumer that will call methods on UpdateJobQueueRequest.Builder to create a request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.