/* * Copyright 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. */ /* * Do not modify this file. This file is generated from the batch-2016-08-10.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.Batch.Model; namespace Amazon.Batch { /// /// Interface for accessing Batch /// /// 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. /// /// public partial interface IAmazonBatch : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// IBatchPaginatorFactory Paginators { get; } #endif #region CancelJob /// /// 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. /// /// /// Container for the necessary parameters to execute the CancelJob service method. /// /// The response from the CancelJob service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for CancelJob Operation CancelJobResponse CancelJob(CancelJobRequest request); /// /// Initiates the asynchronous execution of the CancelJob operation. /// /// /// Container for the necessary parameters to execute the CancelJob operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelJob /// operation. /// REST API Reference for CancelJob Operation IAsyncResult BeginCancelJob(CancelJobRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CancelJob operation. /// /// /// The IAsyncResult returned by the call to BeginCancelJob. /// /// Returns a CancelJobResult from Batch. /// REST API Reference for CancelJob Operation CancelJobResponse EndCancelJob(IAsyncResult asyncResult); #endregion #region CreateComputeEnvironment /// /// 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. /// /// Add the compute environment to an existing job queue. /// ///
  3. /// /// Remove the earlier compute environment from your job queue. /// ///
  4. /// /// 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: /// /// /// /// 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. /// /// /// /// Container for the necessary parameters to execute the CreateComputeEnvironment service method. /// /// The response from the CreateComputeEnvironment service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for CreateComputeEnvironment Operation CreateComputeEnvironmentResponse CreateComputeEnvironment(CreateComputeEnvironmentRequest request); /// /// Initiates the asynchronous execution of the CreateComputeEnvironment operation. /// /// /// Container for the necessary parameters to execute the CreateComputeEnvironment operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateComputeEnvironment /// operation. /// REST API Reference for CreateComputeEnvironment Operation IAsyncResult BeginCreateComputeEnvironment(CreateComputeEnvironmentRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateComputeEnvironment operation. /// /// /// The IAsyncResult returned by the call to BeginCreateComputeEnvironment. /// /// Returns a CreateComputeEnvironmentResult from Batch. /// REST API Reference for CreateComputeEnvironment Operation CreateComputeEnvironmentResponse EndCreateComputeEnvironment(IAsyncResult asyncResult); #endregion #region CreateJobQueue /// /// 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. /// /// /// Container for the necessary parameters to execute the CreateJobQueue service method. /// /// The response from the CreateJobQueue service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for CreateJobQueue Operation CreateJobQueueResponse CreateJobQueue(CreateJobQueueRequest request); /// /// Initiates the asynchronous execution of the CreateJobQueue operation. /// /// /// Container for the necessary parameters to execute the CreateJobQueue operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateJobQueue /// operation. /// REST API Reference for CreateJobQueue Operation IAsyncResult BeginCreateJobQueue(CreateJobQueueRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateJobQueue operation. /// /// /// The IAsyncResult returned by the call to BeginCreateJobQueue. /// /// Returns a CreateJobQueueResult from Batch. /// REST API Reference for CreateJobQueue Operation CreateJobQueueResponse EndCreateJobQueue(IAsyncResult asyncResult); #endregion #region CreateSchedulingPolicy /// /// Creates an Batch scheduling policy. /// /// Container for the necessary parameters to execute the CreateSchedulingPolicy service method. /// /// The response from the CreateSchedulingPolicy service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for CreateSchedulingPolicy Operation CreateSchedulingPolicyResponse CreateSchedulingPolicy(CreateSchedulingPolicyRequest request); /// /// Initiates the asynchronous execution of the CreateSchedulingPolicy operation. /// /// /// Container for the necessary parameters to execute the CreateSchedulingPolicy operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateSchedulingPolicy /// operation. /// REST API Reference for CreateSchedulingPolicy Operation IAsyncResult BeginCreateSchedulingPolicy(CreateSchedulingPolicyRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateSchedulingPolicy operation. /// /// /// The IAsyncResult returned by the call to BeginCreateSchedulingPolicy. /// /// Returns a CreateSchedulingPolicyResult from Batch. /// REST API Reference for CreateSchedulingPolicy Operation CreateSchedulingPolicyResponse EndCreateSchedulingPolicy(IAsyncResult asyncResult); #endregion #region DeleteComputeEnvironment /// /// 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. /// /// /// Container for the necessary parameters to execute the DeleteComputeEnvironment service method. /// /// The response from the DeleteComputeEnvironment service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DeleteComputeEnvironment Operation DeleteComputeEnvironmentResponse DeleteComputeEnvironment(DeleteComputeEnvironmentRequest request); /// /// Initiates the asynchronous execution of the DeleteComputeEnvironment operation. /// /// /// Container for the necessary parameters to execute the DeleteComputeEnvironment operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteComputeEnvironment /// operation. /// REST API Reference for DeleteComputeEnvironment Operation IAsyncResult BeginDeleteComputeEnvironment(DeleteComputeEnvironmentRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteComputeEnvironment operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteComputeEnvironment. /// /// Returns a DeleteComputeEnvironmentResult from Batch. /// REST API Reference for DeleteComputeEnvironment Operation DeleteComputeEnvironmentResponse EndDeleteComputeEnvironment(IAsyncResult asyncResult); #endregion #region DeleteJobQueue /// /// 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. /// /// /// Container for the necessary parameters to execute the DeleteJobQueue service method. /// /// The response from the DeleteJobQueue service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DeleteJobQueue Operation DeleteJobQueueResponse DeleteJobQueue(DeleteJobQueueRequest request); /// /// Initiates the asynchronous execution of the DeleteJobQueue operation. /// /// /// Container for the necessary parameters to execute the DeleteJobQueue operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteJobQueue /// operation. /// REST API Reference for DeleteJobQueue Operation IAsyncResult BeginDeleteJobQueue(DeleteJobQueueRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteJobQueue operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteJobQueue. /// /// Returns a DeleteJobQueueResult from Batch. /// REST API Reference for DeleteJobQueue Operation DeleteJobQueueResponse EndDeleteJobQueue(IAsyncResult asyncResult); #endregion #region DeleteSchedulingPolicy /// /// Deletes the specified scheduling policy. /// /// /// /// You can't delete a scheduling policy that's used in any job queues. /// /// /// Container for the necessary parameters to execute the DeleteSchedulingPolicy service method. /// /// The response from the DeleteSchedulingPolicy service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DeleteSchedulingPolicy Operation DeleteSchedulingPolicyResponse DeleteSchedulingPolicy(DeleteSchedulingPolicyRequest request); /// /// Initiates the asynchronous execution of the DeleteSchedulingPolicy operation. /// /// /// Container for the necessary parameters to execute the DeleteSchedulingPolicy operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSchedulingPolicy /// operation. /// REST API Reference for DeleteSchedulingPolicy Operation IAsyncResult BeginDeleteSchedulingPolicy(DeleteSchedulingPolicyRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteSchedulingPolicy operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteSchedulingPolicy. /// /// Returns a DeleteSchedulingPolicyResult from Batch. /// REST API Reference for DeleteSchedulingPolicy Operation DeleteSchedulingPolicyResponse EndDeleteSchedulingPolicy(IAsyncResult asyncResult); #endregion #region DeregisterJobDefinition /// /// Deregisters an Batch job definition. Job definitions are permanently deleted after /// 180 days. /// /// Container for the necessary parameters to execute the DeregisterJobDefinition service method. /// /// The response from the DeregisterJobDefinition service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DeregisterJobDefinition Operation DeregisterJobDefinitionResponse DeregisterJobDefinition(DeregisterJobDefinitionRequest request); /// /// Initiates the asynchronous execution of the DeregisterJobDefinition operation. /// /// /// Container for the necessary parameters to execute the DeregisterJobDefinition operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeregisterJobDefinition /// operation. /// REST API Reference for DeregisterJobDefinition Operation IAsyncResult BeginDeregisterJobDefinition(DeregisterJobDefinitionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeregisterJobDefinition operation. /// /// /// The IAsyncResult returned by the call to BeginDeregisterJobDefinition. /// /// Returns a DeregisterJobDefinitionResult from Batch. /// REST API Reference for DeregisterJobDefinition Operation DeregisterJobDefinitionResponse EndDeregisterJobDefinition(IAsyncResult asyncResult); #endregion #region DescribeComputeEnvironments /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeComputeEnvironments service method. /// /// The response from the DescribeComputeEnvironments service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeComputeEnvironments Operation DescribeComputeEnvironmentsResponse DescribeComputeEnvironments(DescribeComputeEnvironmentsRequest request); /// /// Initiates the asynchronous execution of the DescribeComputeEnvironments operation. /// /// /// Container for the necessary parameters to execute the DescribeComputeEnvironments operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeComputeEnvironments /// operation. /// REST API Reference for DescribeComputeEnvironments Operation IAsyncResult BeginDescribeComputeEnvironments(DescribeComputeEnvironmentsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeComputeEnvironments operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeComputeEnvironments. /// /// Returns a DescribeComputeEnvironmentsResult from Batch. /// REST API Reference for DescribeComputeEnvironments Operation DescribeComputeEnvironmentsResponse EndDescribeComputeEnvironments(IAsyncResult asyncResult); #endregion #region DescribeJobDefinitions /// /// Describes a list of job definitions. You can specify a status (such as /// ACTIVE) to only return job definitions that match that status. /// /// Container for the necessary parameters to execute the DescribeJobDefinitions service method. /// /// The response from the DescribeJobDefinitions service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeJobDefinitions Operation DescribeJobDefinitionsResponse DescribeJobDefinitions(DescribeJobDefinitionsRequest request); /// /// Initiates the asynchronous execution of the DescribeJobDefinitions operation. /// /// /// Container for the necessary parameters to execute the DescribeJobDefinitions operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeJobDefinitions /// operation. /// REST API Reference for DescribeJobDefinitions Operation IAsyncResult BeginDescribeJobDefinitions(DescribeJobDefinitionsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeJobDefinitions operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeJobDefinitions. /// /// Returns a DescribeJobDefinitionsResult from Batch. /// REST API Reference for DescribeJobDefinitions Operation DescribeJobDefinitionsResponse EndDescribeJobDefinitions(IAsyncResult asyncResult); #endregion #region DescribeJobQueues /// /// Describes one or more of your job queues. /// /// Container for the necessary parameters to execute the DescribeJobQueues service method. /// /// The response from the DescribeJobQueues service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeJobQueues Operation DescribeJobQueuesResponse DescribeJobQueues(DescribeJobQueuesRequest request); /// /// Initiates the asynchronous execution of the DescribeJobQueues operation. /// /// /// Container for the necessary parameters to execute the DescribeJobQueues operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeJobQueues /// operation. /// REST API Reference for DescribeJobQueues Operation IAsyncResult BeginDescribeJobQueues(DescribeJobQueuesRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeJobQueues operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeJobQueues. /// /// Returns a DescribeJobQueuesResult from Batch. /// REST API Reference for DescribeJobQueues Operation DescribeJobQueuesResponse EndDescribeJobQueues(IAsyncResult asyncResult); #endregion #region DescribeJobs /// /// Describes a list of Batch jobs. /// /// Container for the necessary parameters to execute the DescribeJobs service method. /// /// The response from the DescribeJobs service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeJobs Operation DescribeJobsResponse DescribeJobs(DescribeJobsRequest request); /// /// Initiates the asynchronous execution of the DescribeJobs operation. /// /// /// Container for the necessary parameters to execute the DescribeJobs operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeJobs /// operation. /// REST API Reference for DescribeJobs Operation IAsyncResult BeginDescribeJobs(DescribeJobsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeJobs operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeJobs. /// /// Returns a DescribeJobsResult from Batch. /// REST API Reference for DescribeJobs Operation DescribeJobsResponse EndDescribeJobs(IAsyncResult asyncResult); #endregion #region DescribeSchedulingPolicies /// /// Describes one or more of your scheduling policies. /// /// Container for the necessary parameters to execute the DescribeSchedulingPolicies service method. /// /// The response from the DescribeSchedulingPolicies service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for DescribeSchedulingPolicies Operation DescribeSchedulingPoliciesResponse DescribeSchedulingPolicies(DescribeSchedulingPoliciesRequest request); /// /// Initiates the asynchronous execution of the DescribeSchedulingPolicies operation. /// /// /// Container for the necessary parameters to execute the DescribeSchedulingPolicies operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSchedulingPolicies /// operation. /// REST API Reference for DescribeSchedulingPolicies Operation IAsyncResult BeginDescribeSchedulingPolicies(DescribeSchedulingPoliciesRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeSchedulingPolicies operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeSchedulingPolicies. /// /// Returns a DescribeSchedulingPoliciesResult from Batch. /// REST API Reference for DescribeSchedulingPolicies Operation DescribeSchedulingPoliciesResponse EndDescribeSchedulingPolicies(IAsyncResult asyncResult); #endregion #region ListJobs /// /// Returns a list of Batch jobs. /// /// /// /// You must specify only one of the following items: /// /// /// /// You can filter the results by job status with the jobStatus parameter. /// If you don't specify a status, only RUNNING jobs are returned. /// /// /// Container for the necessary parameters to execute the ListJobs service method. /// /// The response from the ListJobs service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListJobs Operation ListJobsResponse ListJobs(ListJobsRequest request); /// /// Initiates the asynchronous execution of the ListJobs operation. /// /// /// Container for the necessary parameters to execute the ListJobs operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListJobs /// operation. /// REST API Reference for ListJobs Operation IAsyncResult BeginListJobs(ListJobsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListJobs operation. /// /// /// The IAsyncResult returned by the call to BeginListJobs. /// /// Returns a ListJobsResult from Batch. /// REST API Reference for ListJobs Operation ListJobsResponse EndListJobs(IAsyncResult asyncResult); #endregion #region ListSchedulingPolicies /// /// Returns a list of Batch scheduling policies. /// /// Container for the necessary parameters to execute the ListSchedulingPolicies service method. /// /// The response from the ListSchedulingPolicies service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListSchedulingPolicies Operation ListSchedulingPoliciesResponse ListSchedulingPolicies(ListSchedulingPoliciesRequest request); /// /// Initiates the asynchronous execution of the ListSchedulingPolicies operation. /// /// /// Container for the necessary parameters to execute the ListSchedulingPolicies operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSchedulingPolicies /// operation. /// REST API Reference for ListSchedulingPolicies Operation IAsyncResult BeginListSchedulingPolicies(ListSchedulingPoliciesRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListSchedulingPolicies operation. /// /// /// The IAsyncResult returned by the call to BeginListSchedulingPolicies. /// /// Returns a ListSchedulingPoliciesResult from Batch. /// REST API Reference for ListSchedulingPolicies Operation ListSchedulingPoliciesResponse EndListSchedulingPolicies(IAsyncResult asyncResult); #endregion #region ListTagsForResource /// /// 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. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request); /// /// Initiates the asynchronous execution of the ListTagsForResource operation. /// /// /// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource /// operation. /// REST API Reference for ListTagsForResource Operation IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListTagsForResource operation. /// /// /// The IAsyncResult returned by the call to BeginListTagsForResource. /// /// Returns a ListTagsForResourceResult from Batch. /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #endregion #region RegisterJobDefinition /// /// Registers an Batch job definition. /// /// Container for the necessary parameters to execute the RegisterJobDefinition service method. /// /// The response from the RegisterJobDefinition service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for RegisterJobDefinition Operation RegisterJobDefinitionResponse RegisterJobDefinition(RegisterJobDefinitionRequest request); /// /// Initiates the asynchronous execution of the RegisterJobDefinition operation. /// /// /// Container for the necessary parameters to execute the RegisterJobDefinition operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterJobDefinition /// operation. /// REST API Reference for RegisterJobDefinition Operation IAsyncResult BeginRegisterJobDefinition(RegisterJobDefinitionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the RegisterJobDefinition operation. /// /// /// The IAsyncResult returned by the call to BeginRegisterJobDefinition. /// /// Returns a RegisterJobDefinitionResult from Batch. /// REST API Reference for RegisterJobDefinition Operation RegisterJobDefinitionResponse EndRegisterJobDefinition(IAsyncResult asyncResult); #endregion #region SubmitJob /// /// 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. /// /// /// /// Container for the necessary parameters to execute the SubmitJob service method. /// /// The response from the SubmitJob service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for SubmitJob Operation SubmitJobResponse SubmitJob(SubmitJobRequest request); /// /// Initiates the asynchronous execution of the SubmitJob operation. /// /// /// Container for the necessary parameters to execute the SubmitJob operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSubmitJob /// operation. /// REST API Reference for SubmitJob Operation IAsyncResult BeginSubmitJob(SubmitJobRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the SubmitJob operation. /// /// /// The IAsyncResult returned by the call to BeginSubmitJob. /// /// Returns a SubmitJobResult from Batch. /// REST API Reference for SubmitJob Operation SubmitJobResponse EndSubmitJob(IAsyncResult asyncResult); #endregion #region TagResource /// /// 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. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// The response from the TagResource service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for TagResource Operation TagResourceResponse TagResource(TagResourceRequest request); /// /// Initiates the asynchronous execution of the TagResource operation. /// /// /// Container for the necessary parameters to execute the TagResource operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource /// operation. /// REST API Reference for TagResource Operation IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the TagResource operation. /// /// /// The IAsyncResult returned by the call to BeginTagResource. /// /// Returns a TagResourceResult from Batch. /// REST API Reference for TagResource Operation TagResourceResponse EndTagResource(IAsyncResult asyncResult); #endregion #region TerminateJob /// /// 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. /// /// Container for the necessary parameters to execute the TerminateJob service method. /// /// The response from the TerminateJob service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for TerminateJob Operation TerminateJobResponse TerminateJob(TerminateJobRequest request); /// /// Initiates the asynchronous execution of the TerminateJob operation. /// /// /// Container for the necessary parameters to execute the TerminateJob operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTerminateJob /// operation. /// REST API Reference for TerminateJob Operation IAsyncResult BeginTerminateJob(TerminateJobRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the TerminateJob operation. /// /// /// The IAsyncResult returned by the call to BeginTerminateJob. /// /// Returns a TerminateJobResult from Batch. /// REST API Reference for TerminateJob Operation TerminateJobResponse EndTerminateJob(IAsyncResult asyncResult); #endregion #region UntagResource /// /// Deletes specified tags from an Batch resource. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// The response from the UntagResource service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for UntagResource Operation UntagResourceResponse UntagResource(UntagResourceRequest request); /// /// Initiates the asynchronous execution of the UntagResource operation. /// /// /// Container for the necessary parameters to execute the UntagResource operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource /// operation. /// REST API Reference for UntagResource Operation IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UntagResource operation. /// /// /// The IAsyncResult returned by the call to BeginUntagResource. /// /// Returns a UntagResourceResult from Batch. /// REST API Reference for UntagResource Operation UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion #region UpdateComputeEnvironment /// /// Updates an Batch compute environment. /// /// Container for the necessary parameters to execute the UpdateComputeEnvironment service method. /// /// The response from the UpdateComputeEnvironment service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for UpdateComputeEnvironment Operation UpdateComputeEnvironmentResponse UpdateComputeEnvironment(UpdateComputeEnvironmentRequest request); /// /// Initiates the asynchronous execution of the UpdateComputeEnvironment operation. /// /// /// Container for the necessary parameters to execute the UpdateComputeEnvironment operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateComputeEnvironment /// operation. /// REST API Reference for UpdateComputeEnvironment Operation IAsyncResult BeginUpdateComputeEnvironment(UpdateComputeEnvironmentRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateComputeEnvironment operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateComputeEnvironment. /// /// Returns a UpdateComputeEnvironmentResult from Batch. /// REST API Reference for UpdateComputeEnvironment Operation UpdateComputeEnvironmentResponse EndUpdateComputeEnvironment(IAsyncResult asyncResult); #endregion #region UpdateJobQueue /// /// Updates a job queue. /// /// Container for the necessary parameters to execute the UpdateJobQueue service method. /// /// The response from the UpdateJobQueue service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for UpdateJobQueue Operation UpdateJobQueueResponse UpdateJobQueue(UpdateJobQueueRequest request); /// /// Initiates the asynchronous execution of the UpdateJobQueue operation. /// /// /// Container for the necessary parameters to execute the UpdateJobQueue operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateJobQueue /// operation. /// REST API Reference for UpdateJobQueue Operation IAsyncResult BeginUpdateJobQueue(UpdateJobQueueRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateJobQueue operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateJobQueue. /// /// Returns a UpdateJobQueueResult from Batch. /// REST API Reference for UpdateJobQueue Operation UpdateJobQueueResponse EndUpdateJobQueue(IAsyncResult asyncResult); #endregion #region UpdateSchedulingPolicy /// /// Updates a scheduling policy. /// /// Container for the necessary parameters to execute the UpdateSchedulingPolicy service method. /// /// The response from the UpdateSchedulingPolicy service method, as returned by Batch. /// /// 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. /// /// /// These errors are usually caused by a server issue. /// /// REST API Reference for UpdateSchedulingPolicy Operation UpdateSchedulingPolicyResponse UpdateSchedulingPolicy(UpdateSchedulingPolicyRequest request); /// /// Initiates the asynchronous execution of the UpdateSchedulingPolicy operation. /// /// /// Container for the necessary parameters to execute the UpdateSchedulingPolicy operation on AmazonBatchClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateSchedulingPolicy /// operation. /// REST API Reference for UpdateSchedulingPolicy Operation IAsyncResult BeginUpdateSchedulingPolicy(UpdateSchedulingPolicyRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateSchedulingPolicy operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateSchedulingPolicy. /// /// Returns a UpdateSchedulingPolicyResult from Batch. /// REST API Reference for UpdateSchedulingPolicy Operation UpdateSchedulingPolicyResponse EndUpdateSchedulingPolicy(IAsyncResult asyncResult); #endregion } }