com.amazonaws.services.batch.AWSBatch Maven / Gradle / Ivy
Show all versions of aws-java-sdk-batch Show documentation
/*
* Copyright 2019-2024 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.
*
*
* Batch
*
* Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common
* means for developers, scientists, and engineers to access large amounts of compute resources. Batch uses the
* advantages of the batch computing to remove the undifferentiated heavy lifting of configuring and managing required
* infrastructure. At the same time, it also adopts a familiar batch computing software approach. You can use Batch to
* efficiently provision resources, and work toward eliminating capacity constraints, reducing your overall compute
* costs, and delivering results more quickly.
*
*
* As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically provisions
* compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads.
* With Batch, there's no need to install or manage batch computing software. This means that you can focus on analyzing
* results and solving your specific problems instead.
*
*/
@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 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.
*
*
* @param cancelJobRequest
* Contains the parameters for CancelJob.
* @return Result of the CancelJob operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's 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 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.
*
*
*
* @param createComputeEnvironmentRequest
* Contains the parameters for CreateComputeEnvironment.
* @return Result of the CreateComputeEnvironment operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's 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 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.
*
*
* @param createJobQueueRequest
* Contains the parameters for CreateJobQueue.
* @return Result of the CreateJobQueue operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's not valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.CreateJobQueue
* @see AWS API
* Documentation
*/
CreateJobQueueResult createJobQueue(CreateJobQueueRequest createJobQueueRequest);
/**
*
* Creates an Batch scheduling policy.
*
*
* @param createSchedulingPolicyRequest
* Contains the parameters for CreateSchedulingPolicy.
* @return Result of the CreateSchedulingPolicy operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's not valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.CreateSchedulingPolicy
* @see AWS
* API Documentation
*/
CreateSchedulingPolicyResult createSchedulingPolicy(CreateSchedulingPolicyRequest createSchedulingPolicyRequest);
/**
*
* 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.
*
*
* @param deleteComputeEnvironmentRequest
* Contains the parameters for DeleteComputeEnvironment.
* @return Result of the DeleteComputeEnvironment operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's 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 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.
*
*
* @param deleteJobQueueRequest
* Contains the parameters for DeleteJobQueue.
* @return Result of the DeleteJobQueue operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's not valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.DeleteJobQueue
* @see AWS API
* Documentation
*/
DeleteJobQueueResult deleteJobQueue(DeleteJobQueueRequest deleteJobQueueRequest);
/**
*
* Deletes the specified scheduling policy.
*
*
* You can't delete a scheduling policy that's used in any job queues.
*
*
* @param deleteSchedulingPolicyRequest
* Contains the parameters for DeleteSchedulingPolicy.
* @return Result of the DeleteSchedulingPolicy operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's not valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.DeleteSchedulingPolicy
* @see AWS
* API Documentation
*/
DeleteSchedulingPolicyResult deleteSchedulingPolicy(DeleteSchedulingPolicyRequest deleteSchedulingPolicyRequest);
/**
*
* Deregisters an Batch job definition. Job definitions are 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. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's 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'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.
*
*
* @param describeComputeEnvironmentsRequest
* Contains the parameters for DescribeComputeEnvironments.
* @return Result of the DescribeComputeEnvironments operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's 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
* Contains the parameters for DescribeJobDefinitions.
* @return Result of the DescribeJobDefinitions operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's 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
* Contains the parameters for DescribeJobQueues.
* @return Result of the DescribeJobQueues operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's 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 Batch jobs.
*
*
* @param describeJobsRequest
* Contains the parameters for DescribeJobs.
* @return Result of the DescribeJobs operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's not valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.DescribeJobs
* @see AWS API
* Documentation
*/
DescribeJobsResult describeJobs(DescribeJobsRequest describeJobsRequest);
/**
*
* Describes one or more of your scheduling policies.
*
*
* @param describeSchedulingPoliciesRequest
* Contains the parameters for DescribeSchedulingPolicies.
* @return Result of the DescribeSchedulingPolicies operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's not valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.DescribeSchedulingPolicies
* @see AWS API Documentation
*/
DescribeSchedulingPoliciesResult describeSchedulingPolicies(DescribeSchedulingPoliciesRequest describeSchedulingPoliciesRequest);
/**
*
* Provides a list of the first 100 RUNNABLE jobs associated to a single job queue.
*
*
* @param getJobQueueSnapshotRequest
* @return Result of the GetJobQueueSnapshot operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's not valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.GetJobQueueSnapshot
* @see AWS API
* Documentation
*/
GetJobQueueSnapshotResult getJobQueueSnapshot(GetJobQueueSnapshotRequest getJobQueueSnapshotRequest);
/**
*
* 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.
*
*
* @param listJobsRequest
* Contains the parameters for ListJobs.
* @return Result of the ListJobs operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's not valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.ListJobs
* @see AWS API
* Documentation
*/
ListJobsResult listJobs(ListJobsRequest listJobsRequest);
/**
*
* Returns a list of Batch scheduling policies.
*
*
* @param listSchedulingPoliciesRequest
* Contains the parameters for ListSchedulingPolicies.
* @return Result of the ListSchedulingPolicies operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's not valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.ListSchedulingPolicies
* @see AWS
* API Documentation
*/
ListSchedulingPoliciesResult listSchedulingPolicies(ListSchedulingPoliciesRequest listSchedulingPoliciesRequest);
/**
*
* 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.
*
*
* @param listTagsForResourceRequest
* Contains the parameters for ListTagsForResource.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's not valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.ListTagsForResource
* @see AWS API
* Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Registers an Batch job definition.
*
*
* @param registerJobDefinitionRequest
* Contains the parameters for RegisterJobDefinition.
* @return Result of the RegisterJobDefinition operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's 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 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.
*
*
*
* @param submitJobRequest
* Contains the parameters for SubmitJob.
* @return Result of the SubmitJob operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's not valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.SubmitJob
* @see AWS API
* Documentation
*/
SubmitJobResult submitJob(SubmitJobRequest submitJobRequest);
/**
*
* 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.
*
*
* @param tagResourceRequest
* Contains the parameters for TagResource.
* @return Result of the TagResource operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's not valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* 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
* Contains the parameters for TerminateJob.
* @return Result of the TerminateJob operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's not valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.TerminateJob
* @see AWS API
* Documentation
*/
TerminateJobResult terminateJob(TerminateJobRequest terminateJobRequest);
/**
*
* Deletes specified tags from an Batch resource.
*
*
* @param untagResourceRequest
* Contains the parameters for UntagResource.
* @return Result of the UntagResource operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's not valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates an Batch compute environment.
*
*
* @param updateComputeEnvironmentRequest
* Contains the parameters for UpdateComputeEnvironment.
* @return Result of the UpdateComputeEnvironment operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's 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
* Contains the parameters for UpdateJobQueue.
* @return Result of the UpdateJobQueue operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's not valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.UpdateJobQueue
* @see AWS API
* Documentation
*/
UpdateJobQueueResult updateJobQueue(UpdateJobQueueRequest updateJobQueueRequest);
/**
*
* Updates a scheduling policy.
*
*
* @param updateSchedulingPolicyRequest
* Contains the parameters for UpdateSchedulingPolicy.
* @return Result of the UpdateSchedulingPolicy operation returned by the service.
* @throws ClientException
* These errors are usually caused by a client action. One example cause is using an action or resource on
* behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying
* an identifier that's not valid.
* @throws ServerException
* These errors are usually caused by a server issue.
* @sample AWSBatch.UpdateSchedulingPolicy
* @see AWS
* API Documentation
*/
UpdateSchedulingPolicyResult updateSchedulingPolicy(UpdateSchedulingPolicyRequest updateSchedulingPolicyRequest);
/**
* 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);
}