@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
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 AWSBatch
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.public void setRegion(Region region)
AWSBatch
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
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 AWSBatch
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)
public CancelJobResult cancelJob(CancelJobRequest request)
AWSBatch
Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED
or PENDING
are
canceled. A job inRUNNABLE
remains in RUNNABLE
until it reaches the head of the job
queue. Then the job status is updated to FAILED
.
A PENDING
job is canceled after all dependency jobs are completed. Therefore, it may take longer
than expected to cancel a job in PENDING
status.
When you try to cancel an array parent job in PENDING
, Batch attempts to cancel all child jobs. The
array parent job is canceled when all child jobs are completed.
Jobs that progressed to the STARTING
or RUNNING
state aren't canceled. However, the API
operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob
operation.
cancelJob
in interface AWSBatch
request
- 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 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.
To create a compute environment that uses EKS resources, the caller must have permissions to call
eks:DescribeCluster
.
Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is available. You're responsible for the management of the guest operating system. This includes any updates and security patches. You're also responsible for any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to 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.
In April 2022, Batch added enhanced support for updating compute environments. For more information, see Updating compute environments. To use the enhanced updating of compute environments to update AMIs, follow these rules:
Either don't set the service role (serviceRole
) parameter or set it to the
AWSBatchServiceRole service-linked role.
Set the allocation strategy (allocationStrategy
) parameter to BEST_FIT_PROGRESSIVE
,
SPOT_CAPACITY_OPTIMIZED
, or SPOT_PRICE_CAPACITY_OPTIMIZED
.
Set the update to latest image version (updateToLatestImageVersion
) parameter to true
.
The updateToLatestImageVersion
parameter is used when you update a compute environment. This
parameter is ignored when you create a compute environment.
Don't specify an AMI ID in imageId
, imageIdOverride
(in
ec2Configuration
), or in the launch template (launchTemplate
). In that case, Batch
selects the latest Amazon ECS optimized AMI that's supported by Batch at the time the infrastructure update is
initiated. Alternatively, you can specify the AMI ID in the imageId
or imageIdOverride
parameters, or the launch template identified by the LaunchTemplate
properties. Changing any of
these properties starts an infrastructure update. If the AMI ID is specified in the launch template, it can't be
replaced by specifying an AMI ID in either the imageId
or imageIdOverride
parameters.
It can only be replaced by specifying a different launch template, or if the launch template version is set to
$Default
or $Latest
, by setting either a new default version for the launch template
(if $Default
) or by adding a new version to the launch template (if $Latest
).
If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be re-selected.
If the version
setting in the launch template (launchTemplate
) is set to
$Latest
or $Default
, the latest or default version of the launch template is evaluated
up at the time of the infrastructure update, even if the launchTemplate
wasn't updated.
createComputeEnvironment
in interface AWSBatch
request
- Contains the parameters for CreateComputeEnvironment
.public CreateJobQueueResult createJobQueue(CreateJobQueueRequest request)
AWSBatch
Creates 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 AWSBatch
request
- Contains the parameters for CreateJobQueue
.public CreateSchedulingPolicyResult createSchedulingPolicy(CreateSchedulingPolicyRequest request)
AWSBatch
Creates an Batch scheduling policy.
createSchedulingPolicy
in interface AWSBatch
request
- Contains the parameters for CreateSchedulingPolicy
.public DeleteComputeEnvironmentResult deleteComputeEnvironment(DeleteComputeEnvironmentRequest request)
AWSBatch
Deletes 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 AWSBatch
request
- Contains the parameters for DeleteComputeEnvironment
.public DeleteJobQueueResult deleteJobQueue(DeleteJobQueueRequest request)
AWSBatch
Deletes 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 AWSBatch
request
- Contains the parameters for DeleteJobQueue
.public DeleteSchedulingPolicyResult deleteSchedulingPolicy(DeleteSchedulingPolicyRequest request)
AWSBatch
Deletes the specified scheduling policy.
You can't delete a scheduling policy that's used in any job queues.
deleteSchedulingPolicy
in interface AWSBatch
request
- Contains the parameters for DeleteSchedulingPolicy
.public DeregisterJobDefinitionResult deregisterJobDefinition(DeregisterJobDefinitionRequest request)
AWSBatch
Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.
deregisterJobDefinition
in interface AWSBatch
public DescribeComputeEnvironmentsResult describeComputeEnvironments(DescribeComputeEnvironmentsRequest request)
AWSBatch
Describes 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 launch your Amazon ECS container instances into.
describeComputeEnvironments
in interface AWSBatch
request
- 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 AWSBatch
request
- Contains the parameters for DescribeJobDefinitions
.public DescribeJobQueuesResult describeJobQueues(DescribeJobQueuesRequest request)
AWSBatch
Describes one or more of your job queues.
describeJobQueues
in interface AWSBatch
request
- Contains the parameters for DescribeJobQueues
.public DescribeJobsResult describeJobs(DescribeJobsRequest request)
AWSBatch
Describes a list of Batch jobs.
describeJobs
in interface AWSBatch
request
- Contains the parameters for DescribeJobs
.public DescribeSchedulingPoliciesResult describeSchedulingPolicies(DescribeSchedulingPoliciesRequest request)
AWSBatch
Describes one or more of your scheduling policies.
describeSchedulingPolicies
in interface AWSBatch
request
- Contains the parameters for DescribeSchedulingPolicies
.public GetJobQueueSnapshotResult getJobQueueSnapshot(GetJobQueueSnapshotRequest request)
AWSBatch
Provides a list of the first 100 RUNNABLE
jobs associated to a single job queue.
getJobQueueSnapshot
in interface AWSBatch
public ListJobsResult listJobs(ListJobsRequest request)
AWSBatch
Returns 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 AWSBatch
request
- Contains the parameters for ListJobs
.public ListSchedulingPoliciesResult listSchedulingPolicies(ListSchedulingPoliciesRequest request)
AWSBatch
Returns a list of Batch scheduling policies.
listSchedulingPolicies
in interface AWSBatch
request
- Contains the parameters for ListSchedulingPolicies
.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSBatch
Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.
listTagsForResource
in interface AWSBatch
request
- Contains the parameters for ListTagsForResource
.public RegisterJobDefinitionResult registerJobDefinition(RegisterJobDefinitionRequest request)
AWSBatch
Registers an Batch job definition.
registerJobDefinition
in interface AWSBatch
request
- 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.
Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.
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 AWSBatch
request
- 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, job queues, and scheduling policies. ARNs for child jobs of array and
multi-node parallel (MNP) jobs aren't supported.
tagResource
in interface AWSBatch
request
- Contains the parameters for TagResource
.public 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 AWSBatch
request
- Contains the parameters for TerminateJob
.public UntagResourceResult untagResource(UntagResourceRequest request)
AWSBatch
Deletes specified tags from an Batch resource.
untagResource
in interface AWSBatch
request
- Contains the parameters for UntagResource
.public UpdateComputeEnvironmentResult updateComputeEnvironment(UpdateComputeEnvironmentRequest request)
AWSBatch
Updates an Batch compute environment.
updateComputeEnvironment
in interface AWSBatch
request
- Contains the parameters for UpdateComputeEnvironment
.public UpdateJobQueueResult updateJobQueue(UpdateJobQueueRequest request)
AWSBatch
Updates a job queue.
updateJobQueue
in interface AWSBatch
request
- Contains the parameters for UpdateJobQueue
.public UpdateSchedulingPolicyResult updateSchedulingPolicy(UpdateSchedulingPolicyRequest request)
AWSBatch
Updates a scheduling policy.
updateSchedulingPolicy
in interface AWSBatch
request
- Contains the parameters for UpdateSchedulingPolicy
.public void shutdown()
AWSBatch
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSBatch
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.
getCachedResponseMetadata
in interface AWSBatch
request
- The originally executed request.