@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSBatch extends Object implements AWSBatch
AWSBatch. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
CancelJobResult |
cancelJob(CancelJobRequest request)
Cancels a job in an AWS Batch job queue.
|
CreateComputeEnvironmentResult |
createComputeEnvironment(CreateComputeEnvironmentRequest request)
Creates an AWS Batch compute environment.
|
CreateJobQueueResult |
createJobQueue(CreateJobQueueRequest request)
Creates an AWS Batch job queue.
|
DeleteComputeEnvironmentResult |
deleteComputeEnvironment(DeleteComputeEnvironmentRequest request)
Deletes an AWS Batch compute environment.
|
DeleteJobQueueResult |
deleteJobQueue(DeleteJobQueueRequest request)
Deletes the specified job queue.
|
DeregisterJobDefinitionResult |
deregisterJobDefinition(DeregisterJobDefinitionRequest request)
Deregisters an AWS Batch job definition.
|
DescribeComputeEnvironmentsResult |
describeComputeEnvironments(DescribeComputeEnvironmentsRequest request)
Describes one or more of your compute environments.
|
DescribeJobDefinitionsResult |
describeJobDefinitions(DescribeJobDefinitionsRequest request)
Describes a list of job definitions.
|
DescribeJobQueuesResult |
describeJobQueues(DescribeJobQueuesRequest request)
Describes one or more of your job queues.
|
DescribeJobsResult |
describeJobs(DescribeJobsRequest request)
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 request)
Returns a list of task jobs for a specified job queue.
|
RegisterJobDefinitionResult |
registerJobDefinition(RegisterJobDefinitionRequest request)
Registers an AWS Batch job definition.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("batch.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSBatch.setEndpoint(String), sets the regional endpoint for this client's service
calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
SubmitJobResult |
submitJob(SubmitJobRequest request)
Submits an AWS Batch job from a job definition.
|
TerminateJobResult |
terminateJob(TerminateJobRequest request)
Terminates a job in a job queue.
|
UpdateComputeEnvironmentResult |
updateComputeEnvironment(UpdateComputeEnvironmentRequest request)
Updates an AWS Batch compute environment.
|
UpdateJobQueueResult |
updateJobQueue(UpdateJobQueueRequest request)
Updates a job queue.
|
public void setEndpoint(String endpoint)
AWSBatch
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.
setEndpoint in interface AWSBatchendpoint - 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.public void setRegion(Region region)
AWSBatchAWSBatch.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.
setRegion in interface AWSBatchregion - 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)public CancelJobResult cancelJob(CancelJobRequest request)
AWSBatch
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 AWSBatchpublic CreateComputeEnvironmentResult createComputeEnvironment(CreateComputeEnvironmentRequest request)
AWSBatch
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 AWSBatchpublic CreateJobQueueResult createJobQueue(CreateJobQueueRequest request)
AWSBatchCreates 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 AWSBatchpublic DeleteComputeEnvironmentResult deleteComputeEnvironment(DeleteComputeEnvironmentRequest request)
AWSBatchDeletes 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 AWSBatchpublic DeleteJobQueueResult deleteJobQueue(DeleteJobQueueRequest request)
AWSBatchDeletes 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 AWSBatchpublic DeregisterJobDefinitionResult deregisterJobDefinition(DeregisterJobDefinitionRequest request)
AWSBatchDeregisters an AWS Batch job definition.
deregisterJobDefinition in interface AWSBatchpublic DescribeComputeEnvironmentsResult describeComputeEnvironments(DescribeComputeEnvironmentsRequest request)
AWSBatchDescribes 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 AWSBatchpublic DescribeJobDefinitionsResult describeJobDefinitions(DescribeJobDefinitionsRequest request)
AWSBatch
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 AWSBatchpublic DescribeJobQueuesResult describeJobQueues(DescribeJobQueuesRequest request)
AWSBatchDescribes one or more of your job queues.
describeJobQueues in interface AWSBatchpublic DescribeJobsResult describeJobs(DescribeJobsRequest request)
AWSBatchDescribes a list of AWS Batch jobs.
describeJobs in interface AWSBatchpublic ListJobsResult listJobs(ListJobsRequest request)
AWSBatch
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 AWSBatchpublic RegisterJobDefinitionResult registerJobDefinition(RegisterJobDefinitionRequest request)
AWSBatchRegisters an AWS Batch job definition.
registerJobDefinition in interface AWSBatchpublic SubmitJobResult submitJob(SubmitJobRequest request)
AWSBatchSubmits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.
submitJob in interface AWSBatchpublic TerminateJobResult terminateJob(TerminateJobRequest request)
AWSBatch
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 AWSBatchpublic UpdateComputeEnvironmentResult updateComputeEnvironment(UpdateComputeEnvironmentRequest request)
AWSBatchUpdates an AWS Batch compute environment.
updateComputeEnvironment in interface AWSBatchpublic UpdateJobQueueResult updateJobQueue(UpdateJobQueueRequest request)
AWSBatchUpdates a job queue.
updateJobQueue in interface AWSBatchpublic void shutdown()
AWSBatchpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSBatchResponse 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.
getCachedResponseMetadata in interface AWSBatchrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.