@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 | Constructor and Description |
|---|---|
protected |
AbstractAWSBatch() |
| Modifier and Type | Method and Description |
|---|---|
CancelJobResult |
cancelJob(CancelJobRequest request)
Cancels a job in an Batch job queue.
|
CreateComputeEnvironmentResult |
createComputeEnvironment(CreateComputeEnvironmentRequest request)
Creates an Batch compute environment.
|
CreateJobQueueResult |
createJobQueue(CreateJobQueueRequest request)
Creates an Batch job queue.
|
DeleteComputeEnvironmentResult |
deleteComputeEnvironment(DeleteComputeEnvironmentRequest request)
Deletes an Batch compute environment.
|
DeleteJobQueueResult |
deleteJobQueue(DeleteJobQueueRequest request)
Deletes the specified job queue.
|
DeregisterJobDefinitionResult |
deregisterJobDefinition(DeregisterJobDefinitionRequest request)
Deregisters an 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 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 Batch jobs.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags for an Batch resource.
|
RegisterJobDefinitionResult |
registerJobDefinition(RegisterJobDefinitionRequest request)
Registers an 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 Batch job from a job definition.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Associates the specified tags to a resource with the specified
resourceArn. |
TerminateJobResult |
terminateJob(TerminateJobRequest request)
Terminates a job in a job queue.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Deletes specified tags from an Batch resource.
|
UpdateComputeEnvironmentResult |
updateComputeEnvironment(UpdateComputeEnvironmentRequest request)
Updates an 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: 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.
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 Batch job queue. Jobs that are in the SUBMITTED, PENDING, or
RUNNABLE state are canceled. Jobs that have progressed to STARTING or
RUNNING aren't canceled, but the API operation still succeeds, even if no job is canceled. These
jobs must be terminated with the TerminateJob operation.
cancelJob in interface AWSBatchrequest - Contains the parameters for CancelJob.public CreateComputeEnvironmentResult createComputeEnvironment(CreateComputeEnvironmentRequest request)
AWSBatch
Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute
environments. MANAGED compute environments can use Amazon EC2 or Fargate resources.
UNMANAGED compute environments can only use EC2 resources.
In a managed compute environment, 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. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price.
Multi-node parallel jobs aren't supported on Spot Instances.
In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, 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.
Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible for managing the guest operating system (including its 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 Batch jobs, complete these steps:
Create a new compute environment with the new AMI.
Add the compute environment to an existing job queue.
Remove the earlier compute environment from your job queue.
Delete the earlier compute environment.
createComputeEnvironment in interface AWSBatchrequest - Contains the parameters for CreateComputeEnvironment.public CreateJobQueueResult createJobQueue(CreateJobQueueRequest request)
AWSBatchCreates an 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 that the 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 AWSBatchrequest - Contains the parameters for CreateJobQueue.public DeleteComputeEnvironmentResult deleteComputeEnvironment(DeleteComputeEnvironmentRequest request)
AWSBatchDeletes an 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. Compute environments that use Fargate resources must terminate all active
jobs on that compute environment before deleting the compute environment. If this isn't done, the compute
environment enters an invalid state.
deleteComputeEnvironment in interface AWSBatchrequest - Contains the parameters for DeleteComputeEnvironment.public 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 eventually terminated when you delete a job queue. The jobs are terminated at a rate of about 16 jobs each second.
It's not necessary to disassociate compute environments from a queue before submitting a
DeleteJobQueue request.
deleteJobQueue in interface AWSBatchrequest - Contains the parameters for DeleteJobQueue.public DeregisterJobDefinitionResult deregisterJobDefinition(DeregisterJobDefinitionRequest request)
AWSBatchDeregisters an Batch job definition. Job definitions are permanently deleted after 180 days.
deregisterJobDefinition in interface AWSBatchpublic DescribeComputeEnvironmentsResult describeComputeEnvironments(DescribeComputeEnvironmentsRequest request)
AWSBatchDescribes one or more of your compute environments.
If you're 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 AWSBatchrequest - Contains the parameters for DescribeComputeEnvironments.public 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 AWSBatchrequest - Contains the parameters for DescribeJobDefinitions.public DescribeJobQueuesResult describeJobQueues(DescribeJobQueuesRequest request)
AWSBatchDescribes one or more of your job queues.
describeJobQueues in interface AWSBatchrequest - Contains the parameters for DescribeJobQueues.public DescribeJobsResult describeJobs(DescribeJobsRequest request)
AWSBatchDescribes a list of Batch jobs.
describeJobs in interface AWSBatchrequest - Contains the parameters for DescribeJobs.public ListJobsResult listJobs(ListJobsRequest request)
AWSBatchReturns a list of Batch jobs.
You must specify only one of the following items:
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 nodes for that job
An array job ID to return a list of the children for that job
You can filter the results by job status with the jobStatus parameter. If you don't specify a
status, only RUNNING jobs are returned.
listJobs in interface AWSBatchrequest - Contains the parameters for ListJobs.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSBatchLists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
listTagsForResource in interface AWSBatchpublic RegisterJobDefinitionResult registerJobDefinition(RegisterJobDefinitionRequest request)
AWSBatchRegisters an Batch job definition.
registerJobDefinition in interface AWSBatchrequest - Contains the parameters for RegisterJobDefinition.public SubmitJobResult submitJob(SubmitJobRequest request)
AWSBatch
Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override
parameters defined in the job definition. vCPU and memory requirements that are specified in the
ResourceRequirements objects in the job definition are the exception. They can't be overridden this
way using the memory and vcpus parameters. Rather, you must specify updates to job
definition parameters in a ResourceRequirements object that's included in the
containerOverrides parameter.
Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.
submitJob in interface AWSBatchrequest - Contains the parameters for SubmitJob.public TagResourceResult tagResource(TagResourceRequest request)
AWSBatch
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a
resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags
that are associated with that resource are deleted as well. Batch resources that support tags are compute
environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP)
jobs are not supported.
tagResource 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 AWSBatchrequest - Contains the parameters for TerminateJob.public UntagResourceResult untagResource(UntagResourceRequest request)
AWSBatchDeletes specified tags from an Batch resource.
untagResource in interface AWSBatchpublic UpdateComputeEnvironmentResult updateComputeEnvironment(UpdateComputeEnvironmentRequest request)
AWSBatchUpdates an Batch compute environment.
updateComputeEnvironment in interface AWSBatchrequest - Contains the parameters for UpdateComputeEnvironment.public UpdateJobQueueResult updateJobQueue(UpdateJobQueueRequest request)
AWSBatchUpdates a job queue.
updateJobQueue in interface AWSBatchrequest - Contains the parameters for UpdateJobQueue.public 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 © 2021. All rights reserved.