@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSBatchClient extends AmazonWebServiceClient implements AWSBatch
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSBatchClient()
Deprecated.
|
AWSBatchClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSBatchClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSBatchClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSBatchClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSBatchClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSBatchClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSBatchClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdown@Deprecated public AWSBatchClient()
AWSBatchClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSBatchClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to AWS Batch (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSBatchClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSBatchClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSBatchClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS Batch (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSBatchClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSBatchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS Batch (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSBatchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to AWS Batch (ex: proxy settings,
retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AWSBatchClientBuilder builder()
public CancelJobResult cancelJob(CancelJobRequest request)
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.
cancelJob in interface AWSBatchcancelJobRequest - 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.public CreateComputeEnvironmentResult createComputeEnvironment(CreateComputeEnvironmentRequest request)
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.
createComputeEnvironment in interface AWSBatchcreateComputeEnvironmentRequest - 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.public CreateJobQueueResult createJobQueue(CreateJobQueueRequest request)
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.
createJobQueue in interface AWSBatchcreateJobQueueRequest - 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.public DeleteComputeEnvironmentResult deleteComputeEnvironment(DeleteComputeEnvironmentRequest request)
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.
deleteComputeEnvironment in interface AWSBatchdeleteComputeEnvironmentRequest - 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.public DeleteJobQueueResult deleteJobQueue(DeleteJobQueueRequest request)
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.
deleteJobQueue in interface AWSBatchdeleteJobQueueRequest - 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.public DeregisterJobDefinitionResult deregisterJobDefinition(DeregisterJobDefinitionRequest request)
Deregisters an AWS Batch job definition.
deregisterJobDefinition in interface AWSBatchderegisterJobDefinitionRequest - 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.public DescribeComputeEnvironmentsResult describeComputeEnvironments(DescribeComputeEnvironmentsRequest request)
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.
describeComputeEnvironments in interface AWSBatchdescribeComputeEnvironmentsRequest - 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.public DescribeJobDefinitionsResult describeJobDefinitions(DescribeJobDefinitionsRequest request)
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
return job definitions that match that status.
describeJobDefinitions in interface AWSBatchdescribeJobDefinitionsRequest - 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.public DescribeJobQueuesResult describeJobQueues(DescribeJobQueuesRequest request)
Describes one or more of your job queues.
describeJobQueues in interface AWSBatchdescribeJobQueuesRequest - 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.public DescribeJobsResult describeJobs(DescribeJobsRequest request)
Describes a list of AWS Batch jobs.
describeJobs in interface AWSBatchdescribeJobsRequest - 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.public ListJobsResult listJobs(ListJobsRequest request)
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.
listJobs in interface AWSBatchlistJobsRequest - 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.public RegisterJobDefinitionResult registerJobDefinition(RegisterJobDefinitionRequest request)
Registers an AWS Batch job definition.
registerJobDefinition in interface AWSBatchregisterJobDefinitionRequest - 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.public SubmitJobResult submitJob(SubmitJobRequest request)
Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.
submitJob in interface AWSBatchsubmitJobRequest - 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.public TerminateJobResult terminateJob(TerminateJobRequest request)
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.
terminateJob in interface AWSBatchterminateJobRequest - 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.public UpdateComputeEnvironmentResult updateComputeEnvironment(UpdateComputeEnvironmentRequest request)
Updates an AWS Batch compute environment.
updateComputeEnvironment in interface AWSBatchupdateComputeEnvironmentRequest - 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.public UpdateJobQueueResult updateJobQueue(UpdateJobQueueRequest request)
Updates a job queue.
updateJobQueue in interface AWSBatchupdateJobQueueRequest - 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.public 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 the request.
getCachedResponseMetadata in interface AWSBatchrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.