/* * Copyright 2018-2023 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.services.batch.model.*; /** * Interface for accessing AWS Batch asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.batch.AbstractAWSBatchAsync} 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 d, 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 AWSBatchAsync extends 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. *

* * @param cancelJobRequest * Contains the parameters for CancelJob. * @return A Java Future containing the result of the CancelJob operation returned by the service. * @sample AWSBatchAsync.CancelJob * @see AWS API * Documentation */ java.util.concurrent.Future cancelJobAsync(CancelJobRequest cancelJobRequest); /** *

* 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. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CancelJob operation returned by the service. * @sample AWSBatchAsyncHandler.CancelJob * @see AWS API * Documentation */ java.util.concurrent.Future cancelJobAsync(CancelJobRequest cancelJobRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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: *

*
    *
  1. *

    * Create a new compute environment with the new AMI. *

    *
    2. *
  2. *

    * Add the compute environment to an existing job queue. *

    *
    3. *
  3. *

    * Remove the earlier compute environment from your job queue. *

    *
    4. *
  4. *

    * Delete the earlier compute environment. *

    *
    5. *
*

* 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 or * SPOT_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 A Java Future containing the result of the CreateComputeEnvironment operation returned by the service. * @sample AWSBatchAsync.CreateComputeEnvironment * @see AWS * API Documentation */ java.util.concurrent.Future createComputeEnvironmentAsync(CreateComputeEnvironmentRequest createComputeEnvironmentRequest); /** *

* 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: *

*
    *
  1. *

    * Create a new compute environment with the new AMI. *

    *
    2. *
  2. *

    * Add the compute environment to an existing job queue. *

    *
    3. *
  3. *

    * Remove the earlier compute environment from your job queue. *

    *
    4. *
  4. *

    * Delete the earlier compute environment. *

    *
    5. *
*

* 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 or * SPOT_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. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateComputeEnvironment operation returned by the service. * @sample AWSBatchAsyncHandler.CreateComputeEnvironment * @see AWS * API Documentation */ java.util.concurrent.Future createComputeEnvironmentAsync(CreateComputeEnvironmentRequest createComputeEnvironmentRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the CreateJobQueue operation returned by the service. * @sample AWSBatchAsync.CreateJobQueue * @see AWS API * Documentation */ java.util.concurrent.Future createJobQueueAsync(CreateJobQueueRequest createJobQueueRequest); /** *

* 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. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateJobQueue operation returned by the service. * @sample AWSBatchAsyncHandler.CreateJobQueue * @see AWS API * Documentation */ java.util.concurrent.Future createJobQueueAsync(CreateJobQueueRequest createJobQueueRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Creates an Batch scheduling policy. *

* * @param createSchedulingPolicyRequest * Contains the parameters for CreateSchedulingPolicy. * @return A Java Future containing the result of the CreateSchedulingPolicy operation returned by the service. * @sample AWSBatchAsync.CreateSchedulingPolicy * @see AWS * API Documentation */ java.util.concurrent.Future createSchedulingPolicyAsync(CreateSchedulingPolicyRequest createSchedulingPolicyRequest); /** *

* Creates an Batch scheduling policy. *

* * @param createSchedulingPolicyRequest * Contains the parameters for CreateSchedulingPolicy. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateSchedulingPolicy operation returned by the service. * @sample AWSBatchAsyncHandler.CreateSchedulingPolicy * @see AWS * API Documentation */ java.util.concurrent.Future createSchedulingPolicyAsync(CreateSchedulingPolicyRequest createSchedulingPolicyRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the DeleteComputeEnvironment operation returned by the service. * @sample AWSBatchAsync.DeleteComputeEnvironment * @see AWS * API Documentation */ java.util.concurrent.Future deleteComputeEnvironmentAsync(DeleteComputeEnvironmentRequest deleteComputeEnvironmentRequest); /** *

* 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. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteComputeEnvironment operation returned by the service. * @sample AWSBatchAsyncHandler.DeleteComputeEnvironment * @see AWS * API Documentation */ java.util.concurrent.Future deleteComputeEnvironmentAsync(DeleteComputeEnvironmentRequest deleteComputeEnvironmentRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the DeleteJobQueue operation returned by the service. * @sample AWSBatchAsync.DeleteJobQueue * @see AWS API * Documentation */ java.util.concurrent.Future deleteJobQueueAsync(DeleteJobQueueRequest deleteJobQueueRequest); /** *

* 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. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteJobQueue operation returned by the service. * @sample AWSBatchAsyncHandler.DeleteJobQueue * @see AWS API * Documentation */ java.util.concurrent.Future deleteJobQueueAsync(DeleteJobQueueRequest deleteJobQueueRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the DeleteSchedulingPolicy operation returned by the service. * @sample AWSBatchAsync.DeleteSchedulingPolicy * @see AWS * API Documentation */ java.util.concurrent.Future deleteSchedulingPolicyAsync(DeleteSchedulingPolicyRequest deleteSchedulingPolicyRequest); /** *

* 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. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteSchedulingPolicy operation returned by the service. * @sample AWSBatchAsyncHandler.DeleteSchedulingPolicy * @see AWS * API Documentation */ java.util.concurrent.Future deleteSchedulingPolicyAsync(DeleteSchedulingPolicyRequest deleteSchedulingPolicyRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days. *

* * @param deregisterJobDefinitionRequest * @return A Java Future containing the result of the DeregisterJobDefinition operation returned by the service. * @sample AWSBatchAsync.DeregisterJobDefinition * @see AWS * API Documentation */ java.util.concurrent.Future deregisterJobDefinitionAsync(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest); /** *

* Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days. *

* * @param deregisterJobDefinitionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeregisterJobDefinition operation returned by the service. * @sample AWSBatchAsyncHandler.DeregisterJobDefinition * @see AWS * API Documentation */ java.util.concurrent.Future deregisterJobDefinitionAsync(DeregisterJobDefinitionRequest deregisterJobDefinitionRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the DescribeComputeEnvironments operation returned by the service. * @sample AWSBatchAsync.DescribeComputeEnvironments * @see AWS API Documentation */ java.util.concurrent.Future describeComputeEnvironmentsAsync( DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest); /** *

* 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. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeComputeEnvironments operation returned by the service. * @sample AWSBatchAsyncHandler.DescribeComputeEnvironments * @see AWS API Documentation */ java.util.concurrent.Future describeComputeEnvironmentsAsync( DescribeComputeEnvironmentsRequest describeComputeEnvironmentsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the DescribeJobDefinitions operation returned by the service. * @sample AWSBatchAsync.DescribeJobDefinitions * @see AWS * API Documentation */ java.util.concurrent.Future describeJobDefinitionsAsync(DescribeJobDefinitionsRequest describeJobDefinitionsRequest); /** *

* 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. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeJobDefinitions operation returned by the service. * @sample AWSBatchAsyncHandler.DescribeJobDefinitions * @see AWS * API Documentation */ java.util.concurrent.Future describeJobDefinitionsAsync(DescribeJobDefinitionsRequest describeJobDefinitionsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Describes one or more of your job queues. *

* * @param describeJobQueuesRequest * Contains the parameters for DescribeJobQueues. * @return A Java Future containing the result of the DescribeJobQueues operation returned by the service. * @sample AWSBatchAsync.DescribeJobQueues * @see AWS API * Documentation */ java.util.concurrent.Future describeJobQueuesAsync(DescribeJobQueuesRequest describeJobQueuesRequest); /** *

* Describes one or more of your job queues. *

* * @param describeJobQueuesRequest * Contains the parameters for DescribeJobQueues. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeJobQueues operation returned by the service. * @sample AWSBatchAsyncHandler.DescribeJobQueues * @see AWS API * Documentation */ java.util.concurrent.Future describeJobQueuesAsync(DescribeJobQueuesRequest describeJobQueuesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Describes a list of Batch jobs. *

* * @param describeJobsRequest * Contains the parameters for DescribeJobs. * @return A Java Future containing the result of the DescribeJobs operation returned by the service. * @sample AWSBatchAsync.DescribeJobs * @see AWS API * Documentation */ java.util.concurrent.Future describeJobsAsync(DescribeJobsRequest describeJobsRequest); /** *

* Describes a list of Batch jobs. *

* * @param describeJobsRequest * Contains the parameters for DescribeJobs. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeJobs operation returned by the service. * @sample AWSBatchAsyncHandler.DescribeJobs * @see AWS API * Documentation */ java.util.concurrent.Future describeJobsAsync(DescribeJobsRequest describeJobsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Describes one or more of your scheduling policies. *

* * @param describeSchedulingPoliciesRequest * Contains the parameters for DescribeSchedulingPolicies. * @return A Java Future containing the result of the DescribeSchedulingPolicies operation returned by the service. * @sample AWSBatchAsync.DescribeSchedulingPolicies * @see AWS API Documentation */ java.util.concurrent.Future describeSchedulingPoliciesAsync( DescribeSchedulingPoliciesRequest describeSchedulingPoliciesRequest); /** *

* Describes one or more of your scheduling policies. *

* * @param describeSchedulingPoliciesRequest * Contains the parameters for DescribeSchedulingPolicies. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeSchedulingPolicies operation returned by the service. * @sample AWSBatchAsyncHandler.DescribeSchedulingPolicies * @see AWS API Documentation */ java.util.concurrent.Future describeSchedulingPoliciesAsync( DescribeSchedulingPoliciesRequest describeSchedulingPoliciesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the ListJobs operation returned by the service. * @sample AWSBatchAsync.ListJobs * @see AWS API * Documentation */ java.util.concurrent.Future listJobsAsync(ListJobsRequest listJobsRequest); /** *

* 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. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListJobs operation returned by the service. * @sample AWSBatchAsyncHandler.ListJobs * @see AWS API * Documentation */ java.util.concurrent.Future listJobsAsync(ListJobsRequest listJobsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns a list of Batch scheduling policies. *

* * @param listSchedulingPoliciesRequest * Contains the parameters for ListSchedulingPolicies. * @return A Java Future containing the result of the ListSchedulingPolicies operation returned by the service. * @sample AWSBatchAsync.ListSchedulingPolicies * @see AWS * API Documentation */ java.util.concurrent.Future listSchedulingPoliciesAsync(ListSchedulingPoliciesRequest listSchedulingPoliciesRequest); /** *

* Returns a list of Batch scheduling policies. *

* * @param listSchedulingPoliciesRequest * Contains the parameters for ListSchedulingPolicies. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListSchedulingPolicies operation returned by the service. * @sample AWSBatchAsyncHandler.ListSchedulingPolicies * @see AWS * API Documentation */ java.util.concurrent.Future listSchedulingPoliciesAsync(ListSchedulingPoliciesRequest listSchedulingPoliciesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSBatchAsync.ListTagsForResource * @see AWS API * Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* 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. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSBatchAsyncHandler.ListTagsForResource * @see AWS API * Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Registers an Batch job definition. *

* * @param registerJobDefinitionRequest * Contains the parameters for RegisterJobDefinition. * @return A Java Future containing the result of the RegisterJobDefinition operation returned by the service. * @sample AWSBatchAsync.RegisterJobDefinition * @see AWS * API Documentation */ java.util.concurrent.Future registerJobDefinitionAsync(RegisterJobDefinitionRequest registerJobDefinitionRequest); /** *

* Registers an Batch job definition. *

* * @param registerJobDefinitionRequest * Contains the parameters for RegisterJobDefinition. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the RegisterJobDefinition operation returned by the service. * @sample AWSBatchAsyncHandler.RegisterJobDefinition * @see AWS * API Documentation */ java.util.concurrent.Future registerJobDefinitionAsync(RegisterJobDefinitionRequest registerJobDefinitionRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the SubmitJob operation returned by the service. * @sample AWSBatchAsync.SubmitJob * @see AWS API * Documentation */ java.util.concurrent.Future submitJobAsync(SubmitJobRequest submitJobRequest); /** *

* 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. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the SubmitJob operation returned by the service. * @sample AWSBatchAsyncHandler.SubmitJob * @see AWS API * Documentation */ java.util.concurrent.Future submitJobAsync(SubmitJobRequest submitJobRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSBatchAsync.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest); /** *

* 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. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSBatchAsyncHandler.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the TerminateJob operation returned by the service. * @sample AWSBatchAsync.TerminateJob * @see AWS API * Documentation */ java.util.concurrent.Future terminateJobAsync(TerminateJobRequest terminateJobRequest); /** *

* 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. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TerminateJob operation returned by the service. * @sample AWSBatchAsyncHandler.TerminateJob * @see AWS API * Documentation */ java.util.concurrent.Future terminateJobAsync(TerminateJobRequest terminateJobRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Deletes specified tags from an Batch resource. *

* * @param untagResourceRequest * Contains the parameters for UntagResource. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSBatchAsync.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest); /** *

* Deletes specified tags from an Batch resource. *

* * @param untagResourceRequest * Contains the parameters for UntagResource. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSBatchAsyncHandler.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Updates an Batch compute environment. *

* * @param updateComputeEnvironmentRequest * Contains the parameters for UpdateComputeEnvironment. * @return A Java Future containing the result of the UpdateComputeEnvironment operation returned by the service. * @sample AWSBatchAsync.UpdateComputeEnvironment * @see AWS * API Documentation */ java.util.concurrent.Future updateComputeEnvironmentAsync(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest); /** *

* Updates an Batch compute environment. *

* * @param updateComputeEnvironmentRequest * Contains the parameters for UpdateComputeEnvironment. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateComputeEnvironment operation returned by the service. * @sample AWSBatchAsyncHandler.UpdateComputeEnvironment * @see AWS * API Documentation */ java.util.concurrent.Future updateComputeEnvironmentAsync(UpdateComputeEnvironmentRequest updateComputeEnvironmentRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Updates a job queue. *

* * @param updateJobQueueRequest * Contains the parameters for UpdateJobQueue. * @return A Java Future containing the result of the UpdateJobQueue operation returned by the service. * @sample AWSBatchAsync.UpdateJobQueue * @see AWS API * Documentation */ java.util.concurrent.Future updateJobQueueAsync(UpdateJobQueueRequest updateJobQueueRequest); /** *

* Updates a job queue. *

* * @param updateJobQueueRequest * Contains the parameters for UpdateJobQueue. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateJobQueue operation returned by the service. * @sample AWSBatchAsyncHandler.UpdateJobQueue * @see AWS API * Documentation */ java.util.concurrent.Future updateJobQueueAsync(UpdateJobQueueRequest updateJobQueueRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Updates a scheduling policy. *

* * @param updateSchedulingPolicyRequest * Contains the parameters for UpdateSchedulingPolicy. * @return A Java Future containing the result of the UpdateSchedulingPolicy operation returned by the service. * @sample AWSBatchAsync.UpdateSchedulingPolicy * @see AWS * API Documentation */ java.util.concurrent.Future updateSchedulingPolicyAsync(UpdateSchedulingPolicyRequest updateSchedulingPolicyRequest); /** *

* Updates a scheduling policy. *

* * @param updateSchedulingPolicyRequest * Contains the parameters for UpdateSchedulingPolicy. * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateSchedulingPolicy operation returned by the service. * @sample AWSBatchAsyncHandler.UpdateSchedulingPolicy * @see AWS * API Documentation */ java.util.concurrent.Future updateSchedulingPolicyAsync(UpdateSchedulingPolicyRequest updateSchedulingPolicyRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }