com.amazonaws.services.batch.AWSBatch Maven / Gradle / Ivy
/*
* Copyright 2015-2020 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.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.batch.model.*;
/**
* Interface for accessing AWS Batch.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.batch.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSBatch {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "batch";
/**
* Overrides the default endpoint for this client ("batch.us-east-1.amazonaws.com"). Callers can use this method to
* control which AWS region they want to work with.
*
* 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 {@link 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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection-
* choose-endpoint
*
* 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.
*
* @param 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 use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* An alternative to {@link AWSBatch#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
* {@link 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.
*
* @param region
* The region this client will communicate with. See {@link 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.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
*
* 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.
*
*
* @param cancelJobRequest
* @return Result of the CancelJob operation returned by the service.
* @throws 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 permissions to use the action or resource, or specifying an identifier that is not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.CancelJob
* @see AWS API
* Documentation
*/
CancelJobResult cancelJob(CancelJobRequest cancelJobRequest);
/**
*
* Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute
* environments.
*
*
* In a managed compute environment, AWS 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. You can choose to use Amazon EC2 On-Demand Instances or Spot
* Instances in your managed compute environment. You can optionally set a maximum price so that Spot Instances only
* launch when the Spot Instance price is below a specified percentage of the On-Demand price.
*
*
*
* Multi-node parallel jobs are not supported on Spot Instances.
*
*
*
* 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 Elastic 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. Then, manually 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.
*
*
*
* AWS Batch does not upgrade the AMIs in a compute environment after it is created (for example, when a newer
* version of the Amazon ECS-optimized AMI is available). You are responsible for the management of the guest
* operating system (including updates and security patches) and any additional application software or utilities
* that you install on the compute resources. To use a new AMI for your AWS Batch jobs:
*
*
* -
*
* Create a new compute environment with the new AMI.
*
*
* -
*
* Add the compute environment to an existing job queue.
*
*
* -
*
* Remove the old compute environment from your job queue.
*
*
* -
*
* Delete the old compute environment.
*
*
*
*
*
* @param createComputeEnvironmentRequest
* @return Result of the CreateComputeEnvironment operation returned by the service.
* @throws 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 permissions to use the action or resource, or specifying an identifier that is not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.CreateComputeEnvironment
* @see AWS
* API Documentation
*/
CreateComputeEnvironmentResult createComputeEnvironment(CreateComputeEnvironmentRequest createComputeEnvironmentRequest);
/**
*
* 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 Result of the CreateJobQueue operation returned by the service.
* @throws 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 permissions to use the action or resource, or specifying an identifier that is not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.CreateJobQueue
* @see AWS API
* Documentation
*/
CreateJobQueueResult createJobQueue(CreateJobQueueRequest createJobQueueRequest);
/**
*
* 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 Result of the DeleteComputeEnvironment operation returned by the service.
* @throws 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 permissions to use the action or resource, or specifying an identifier that is not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.DeleteComputeEnvironment
* @see AWS
* API Documentation
*/
DeleteComputeEnvironmentResult deleteComputeEnvironment(DeleteComputeEnvironmentRequest deleteComputeEnvironmentRequest);
/**
*
* 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.
*
*
* @param deleteJobQueueRequest
* @return Result of the DeleteJobQueue operation returned by the service.
* @throws 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 permissions to use the action or resource, or specifying an identifier that is not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.DeleteJobQueue
* @see AWS API
* Documentation
*/
DeleteJobQueueResult deleteJobQueue(DeleteJobQueueRequest deleteJobQueueRequest);
/**
*
* Deregisters an AWS Batch job definition. Job definitions will be permanently deleted after 180 days.
*
*
* @param deregisterJobDefinitionRequest
* @return Result of the DeregisterJobDefinition operation returned by the service.
* @throws 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 permissions to use the action or resource, or specifying an identifier that is not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.DeregisterJobDefinition
* @see AWS
* API Documentation
*/
DeregisterJobDefinitionResult deregisterJobDefinition(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest);
/**
*
* 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 Result of the DescribeComputeEnvironments operation returned by the service.
* @throws 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 permissions to use the action or resource, or specifying an identifier that is not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.DescribeComputeEnvironments
* @see AWS API Documentation
*/
DescribeComputeEnvironmentsResult describeComputeEnvironments(DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest);
/**
*
* 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 Result of the DescribeJobDefinitions operation returned by the service.
* @throws 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 permissions to use the action or resource, or specifying an identifier that is not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.DescribeJobDefinitions
* @see AWS
* API Documentation
*/
DescribeJobDefinitionsResult describeJobDefinitions(DescribeJobDefinitionsRequest describeJobDefinitionsRequest);
/**
*
* Describes one or more of your job queues.
*
*
* @param describeJobQueuesRequest
* @return Result of the DescribeJobQueues operation returned by the service.
* @throws 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 permissions to use the action or resource, or specifying an identifier that is not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.DescribeJobQueues
* @see AWS API
* Documentation
*/
DescribeJobQueuesResult describeJobQueues(DescribeJobQueuesRequest describeJobQueuesRequest);
/**
*
* Describes a list of AWS Batch jobs.
*
*
* @param describeJobsRequest
* @return Result of the DescribeJobs operation returned by the service.
* @throws 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 permissions to use the action or resource, or specifying an identifier that is not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.DescribeJobs
* @see AWS API
* Documentation
*/
DescribeJobsResult describeJobs(DescribeJobsRequest describeJobsRequest);
/**
*
* Returns a list of AWS Batch jobs.
*
*
* You must specify only one of the following:
*
*
* -
*
* 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 that job's nodes
*
*
* -
*
* an array job ID to return a list of that job's children
*
*
*
*
* You can filter the results by job status with the jobStatus parameter. If you do not specify a
* status, only RUNNING jobs are returned.
*
*
* @param listJobsRequest
* @return Result of the ListJobs operation returned by the service.
* @throws 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 permissions to use the action or resource, or specifying an identifier that is not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.ListJobs
* @see AWS API
* Documentation
*/
ListJobsResult listJobs(ListJobsRequest listJobsRequest);
/**
*
* Registers an AWS Batch job definition.
*
*
* @param registerJobDefinitionRequest
* @return Result of the RegisterJobDefinition operation returned by the service.
* @throws 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 permissions to use the action or resource, or specifying an identifier that is not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.RegisterJobDefinition
* @see AWS
* API Documentation
*/
RegisterJobDefinitionResult registerJobDefinition(RegisterJobDefinitionRequest registerJobDefinitionRequest);
/**
*
* Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters
* defined in the job definition.
*
*
* @param submitJobRequest
* @return Result of the SubmitJob operation returned by the service.
* @throws 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 permissions to use the action or resource, or specifying an identifier that is not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.SubmitJob
* @see AWS API
* Documentation
*/
SubmitJobResult submitJob(SubmitJobRequest submitJobRequest);
/**
*
* 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.
*
*
* @param terminateJobRequest
* @return Result of the TerminateJob operation returned by the service.
* @throws 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 permissions to use the action or resource, or specifying an identifier that is not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.TerminateJob
* @see AWS API
* Documentation
*/
TerminateJobResult terminateJob(TerminateJobRequest terminateJobRequest);
/**
*
* Updates an AWS Batch compute environment.
*
*
* @param updateComputeEnvironmentRequest
* @return Result of the UpdateComputeEnvironment operation returned by the service.
* @throws 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 permissions to use the action or resource, or specifying an identifier that is not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.UpdateComputeEnvironment
* @see AWS
* API Documentation
*/
UpdateComputeEnvironmentResult updateComputeEnvironment(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest);
/**
*
* Updates a job queue.
*
*
* @param updateJobQueueRequest
* @return Result of the UpdateJobQueue operation returned by the service.
* @throws 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 permissions to use the action or resource, or specifying an identifier that is not
* valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.UpdateJobQueue
* @see AWS API
* Documentation
*/
UpdateJobQueueResult updateJobQueue(UpdateJobQueueRequest updateJobQueueRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}