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.

Classes

NameDescription
Class ArrayProperties

An object representing an AWS Batch array job.

Class ArrayPropertiesDetail

An object representing the array properties of a job.

Class ArrayPropertiesSummary

An object representing the array properties of a job.

Class AttemptContainerDetail

An object representing the details of a container that is part of a job attempt.

Class AttemptDetail

An object representing a job attempt.

Class CancelJobRequest

Container for the parameters to the CancelJob operation. Cancels a job 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 job is cancelled); these jobs must be terminated with the TerminateJob operation.

Class CancelJobResponse

This is the response object from the CancelJob operation.

Class ClientException

Batch exception

Class ComputeEnvironmentDetail

An object representing an AWS Batch compute environment.

Class ComputeEnvironmentOrder

The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

Class ComputeResource

An object representing an AWS Batch compute resource.

Class ComputeResourceUpdate

An object representing the attributes of a compute environment that can be updated.

Class ContainerDetail

An object representing the details of a container that is part of a job.

Class ContainerOverrides

The overrides that should be sent to a container.

Class ContainerProperties

Container properties are used in job definitions to describe the container that is launched as part of a job.

Class ContainerSummary

An object representing summary details of a container within a job.

Class CreateComputeEnvironmentRequest

Container for the parameters to the CreateComputeEnvironment operation. 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 Elastic 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 Elastic Container Service Developer Guide.

Class CreateComputeEnvironmentResponse

This is the response object from the CreateComputeEnvironment operation.

Class CreateJobQueueRequest

Container for the parameters to the CreateJobQueue operation. 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.

Class CreateJobQueueResponse

This is the response object from the CreateJobQueue operation.

Class DeleteComputeEnvironmentRequest

Container for the parameters to the DeleteComputeEnvironment operation. 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.

Class DeleteComputeEnvironmentResponse

This is the response object from the DeleteComputeEnvironment operation.

Class DeleteJobQueueRequest

Container for the parameters to the DeleteJobQueue operation. 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.

Class DeleteJobQueueResponse

This is the response object from the DeleteJobQueue operation.

Class DeregisterJobDefinitionRequest

Container for the parameters to the DeregisterJobDefinition operation. Deregisters an AWS Batch job definition.

Class DeregisterJobDefinitionResponse

This is the response object from the DeregisterJobDefinition operation.

Class DescribeComputeEnvironmentsRequest

Container for the parameters to the DescribeComputeEnvironments operation. 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.

Class DescribeComputeEnvironmentsResponse

This is the response object from the DescribeComputeEnvironments operation.

Class DescribeJobDefinitionsRequest

Container for the parameters to the DescribeJobDefinitions operation. Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.

Class DescribeJobDefinitionsResponse

This is the response object from the DescribeJobDefinitions operation.

Class DescribeJobQueuesRequest

Container for the parameters to the DescribeJobQueues operation. Describes one or more of your job queues.

Class DescribeJobQueuesResponse

This is the response object from the DescribeJobQueues operation.

Class DescribeJobsRequest

Container for the parameters to the DescribeJobs operation. Describes a list of AWS Batch jobs.

Class DescribeJobsResponse

This is the response object from the DescribeJobs operation.

Class Host

The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.

Class JobDefinition

An object representing an AWS Batch job definition.

Class JobDependency

An object representing an AWS Batch job dependency.

Class JobDetail

An object representing an AWS Batch job.

Class JobQueueDetail

An object representing the details of an AWS Batch job queue.

Class JobSummary

An object representing summary details of a job.

Class KeyValuePair

A key-value pair object.

Class ListJobsRequest

Container for the parameters to the ListJobs operation. 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.

Class ListJobsResponse

This is the response object from the ListJobs operation.

Class MountPoint

Details on a Docker volume mount point that is used in a job's container properties.

Class RegisterJobDefinitionRequest

Container for the parameters to the RegisterJobDefinition operation. Registers an AWS Batch job definition.

Class RegisterJobDefinitionResponse

This is the response object from the RegisterJobDefinition operation.

Class RetryStrategy

The retry strategy associated with a job.

Class ServerException

Batch exception

Class SubmitJobRequest

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

Class SubmitJobResponse

This is the response object from the SubmitJob operation.

Class TerminateJobRequest

Container for the parameters to the TerminateJob operation. 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.

Class TerminateJobResponse

This is the response object from the TerminateJob operation.

Class Ulimit

The ulimit settings to pass to the container.

Class UpdateComputeEnvironmentRequest

Container for the parameters to the UpdateComputeEnvironment operation. Updates an AWS Batch compute environment.

Class UpdateComputeEnvironmentResponse

This is the response object from the UpdateComputeEnvironment operation.

Class UpdateJobQueueRequest

Container for the parameters to the UpdateJobQueue operation. Updates a job queue.

Class UpdateJobQueueResponse

This is the response object from the UpdateJobQueue operation.

Class Volume

A data volume used in a job's container properties.