AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing Batch AWS Batch enables you to run batch computing workloads on the AWS Cloud. Batch computing is a common way for developers, scientists, and engineers to access large amounts of compute resources, and AWS Batch removes the undifferentiated heavy lifting of configuring and managing the required infrastructure. AWS Batch will be familiar to users of traditional batch computing software. This service can efficiently provision resources in response to jobs submitted in order to eliminate capacity constraints, reduce compute costs, and deliver results quickly.

As a fully managed service, AWS Batch enables developers, scientists, and engineers to run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes the workload distribution based on the quantity and scale of the workloads. With AWS Batch, there is no need to install or manage batch computing software, which allows you to focus on analyzing results and solving problems. AWS Batch reduces operational complexities, saves time, and reduces costs, which makes it easy for developers, scientists, and engineers to run their batch jobs in the AWS Cloud.

Inheritance Hierarchy

Amazon.Batch.IAmazonBatch

Namespace: Amazon.Batch
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonBatch
         IAmazonService, IDisposable

The IAmazonBatch type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CancelJob(CancelJobRequest)

Cancels jobs in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are cancelled. Jobs that have progressed to STARTING or RUNNING are not cancelled (but the API operation still succeeds, even if no jobs are cancelled); these jobs must be terminated with the TerminateJob operation.

Public Method CancelJobAsync(CancelJobRequest, CancellationToken)

Initiates the asynchronous execution of the CancelJob operation.

Public Method CreateComputeEnvironment(CreateComputeEnvironmentRequest)

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments.

In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use a recent, approved version of the Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.

In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see Container Instance AMIs in the Amazon EC2 Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it and then manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS Container Instance in the Amazon EC2 Container Service Developer Guide.

Public Method CreateComputeEnvironmentAsync(CreateComputeEnvironmentRequest, CancellationToken)

Initiates the asynchronous execution of the CreateComputeEnvironment operation.

Public Method CreateJobQueue(CreateJobQueueRequest)

Creates an AWS 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 in which the AWS 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.

Public Method CreateJobQueueAsync(CreateJobQueueRequest, CancellationToken)

Initiates the asynchronous execution of the CreateJobQueue operation.

Public Method DeleteComputeEnvironment(DeleteComputeEnvironmentRequest)

Deletes an AWS 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.

Public Method DeleteComputeEnvironmentAsync(DeleteComputeEnvironmentRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteComputeEnvironment operation.

Public Method DeleteJobQueue(DeleteJobQueueRequest)

Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are terminated when you delete a job queue.

It is not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request.

Public Method DeleteJobQueueAsync(DeleteJobQueueRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteJobQueue operation.

Public Method DeregisterJobDefinition(DeregisterJobDefinitionRequest)

Deregisters an AWS Batch job definition.

Public Method DeregisterJobDefinitionAsync(DeregisterJobDefinitionRequest, CancellationToken)

Initiates the asynchronous execution of the DeregisterJobDefinition operation.

Public Method DescribeComputeEnvironments(DescribeComputeEnvironmentsRequest)

Describes one or more of your compute environments.

If you are using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into.

Public Method DescribeComputeEnvironmentsAsync(DescribeComputeEnvironmentsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeComputeEnvironments operation.

Public Method DescribeJobDefinitions(DescribeJobDefinitionsRequest)

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.

Public Method DescribeJobDefinitionsAsync(DescribeJobDefinitionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeJobDefinitions operation.

Public Method DescribeJobQueues(DescribeJobQueuesRequest)

Describes one or more of your job queues.

Public Method DescribeJobQueuesAsync(DescribeJobQueuesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeJobQueues operation.

Public Method DescribeJobs(DescribeJobsRequest)

Describes a list of AWS Batch jobs.

Public Method DescribeJobsAsync(DescribeJobsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeJobs operation.

Public Method ListJobs(ListJobsRequest)

Returns a list of task jobs for a specified job queue. You can filter the results by job status with the jobStatus parameter. If you do not specify a status, only RUNNING jobs are returned.

Public Method ListJobsAsync(ListJobsRequest, CancellationToken)

Initiates the asynchronous execution of the ListJobs operation.

Public Method RegisterJobDefinition(RegisterJobDefinitionRequest)

Registers an AWS Batch job definition.

Public Method RegisterJobDefinitionAsync(RegisterJobDefinitionRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterJobDefinition operation.

Public Method SubmitJob(SubmitJobRequest)

Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.

Public Method SubmitJobAsync(SubmitJobRequest, CancellationToken)

Initiates the asynchronous execution of the SubmitJob operation.

Public Method TerminateJob(TerminateJobRequest)

Terminates jobs 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.

Public Method TerminateJobAsync(TerminateJobRequest, CancellationToken)

Initiates the asynchronous execution of the TerminateJob operation.

Public Method UpdateComputeEnvironment(UpdateComputeEnvironmentRequest)

Updates an AWS Batch compute environment.

Public Method UpdateComputeEnvironmentAsync(UpdateComputeEnvironmentRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateComputeEnvironment operation.

Public Method UpdateJobQueue(UpdateJobQueueRequest)

Updates a job queue.

Public Method UpdateJobQueueAsync(UpdateJobQueueRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateJobQueue operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms