@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSBatch
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSBatch 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CancelJobResult |
cancelJob(CancelJobRequest cancelJobRequest)
Cancels a job in an AWS Batch job queue.
|
CreateComputeEnvironmentResult |
createComputeEnvironment(CreateComputeEnvironmentRequest createComputeEnvironmentRequest)
Creates an AWS Batch compute environment.
|
CreateJobQueueResult |
createJobQueue(CreateJobQueueRequest createJobQueueRequest)
Creates an AWS Batch job queue.
|
DeleteComputeEnvironmentResult |
deleteComputeEnvironment(DeleteComputeEnvironmentRequest deleteComputeEnvironmentRequest)
Deletes an AWS Batch compute environment.
|
DeleteJobQueueResult |
deleteJobQueue(DeleteJobQueueRequest deleteJobQueueRequest)
Deletes the specified job queue.
|
DeregisterJobDefinitionResult |
deregisterJobDefinition(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest)
Deregisters an AWS Batch job definition.
|
DescribeComputeEnvironmentsResult |
describeComputeEnvironments(DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest)
Describes one or more of your compute environments.
|
DescribeJobDefinitionsResult |
describeJobDefinitions(DescribeJobDefinitionsRequest describeJobDefinitionsRequest)
Describes a list of job definitions.
|
DescribeJobQueuesResult |
describeJobQueues(DescribeJobQueuesRequest describeJobQueuesRequest)
Describes one or more of your job queues.
|
DescribeJobsResult |
describeJobs(DescribeJobsRequest describeJobsRequest)
Describes a list of AWS Batch jobs.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListJobsResult |
listJobs(ListJobsRequest listJobsRequest)
Returns a list of task jobs for a specified job queue.
|
RegisterJobDefinitionResult |
registerJobDefinition(RegisterJobDefinitionRequest registerJobDefinitionRequest)
Registers an AWS Batch job definition.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
SubmitJobResult |
submitJob(SubmitJobRequest submitJobRequest)
Submits an AWS Batch job from a job definition.
|
TerminateJobResult |
terminateJob(TerminateJobRequest terminateJobRequest)
Terminates a job in a job queue.
|
UpdateComputeEnvironmentResult |
updateComputeEnvironment(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest)
Updates an AWS Batch compute environment.
|
UpdateJobQueueResult |
updateJobQueue(UpdateJobQueueRequest updateJobQueueRequest)
Updates a job queue.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "batch.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "batch.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this
client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "batch.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"batch.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)setEndpoint(String), sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)CancelJobResult 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 - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.ServerException - These errors are usually caused by a server issue.CreateComputeEnvironmentResult 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 - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.ServerException - These errors are usually caused by a server issue.CreateJobQueueResult 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 - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.ServerException - These errors are usually caused by a server issue.DeleteComputeEnvironmentResult 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 - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.ServerException - These errors are usually caused by a server issue.DeleteJobQueueResult 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 - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.ServerException - These errors are usually caused by a server issue.DeregisterJobDefinitionResult deregisterJobDefinition(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest)
Deregisters an AWS Batch job definition.
deregisterJobDefinitionRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.ServerException - These errors are usually caused by a server issue.DescribeComputeEnvironmentsResult 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 - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.ServerException - These errors are usually caused by a server issue.DescribeJobDefinitionsResult 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 - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.ServerException - These errors are usually caused by a server issue.DescribeJobQueuesResult describeJobQueues(DescribeJobQueuesRequest describeJobQueuesRequest)
Describes one or more of your job queues.
describeJobQueuesRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.ServerException - These errors are usually caused by a server issue.DescribeJobsResult describeJobs(DescribeJobsRequest describeJobsRequest)
Describes a list of AWS Batch jobs.
describeJobsRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.ServerException - These errors are usually caused by a server issue.ListJobsResult 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 - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.ServerException - These errors are usually caused by a server issue.RegisterJobDefinitionResult registerJobDefinition(RegisterJobDefinitionRequest registerJobDefinitionRequest)
Registers an AWS Batch job definition.
registerJobDefinitionRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.ServerException - These errors are usually caused by a server issue.SubmitJobResult submitJob(SubmitJobRequest submitJobRequest)
Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.
submitJobRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.ServerException - These errors are usually caused by a server issue.TerminateJobResult 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 - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.ServerException - These errors are usually caused by a server issue.UpdateComputeEnvironmentResult updateComputeEnvironment(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest)
Updates an AWS Batch compute environment.
updateComputeEnvironmentRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.ServerException - These errors are usually caused by a server issue.UpdateJobQueueResult updateJobQueue(UpdateJobQueueRequest updateJobQueueRequest)
Updates a job queue.
updateJobQueueRequest - ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.ServerException - These errors are usually caused by a server issue.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.