C# (CSharp) Amazon.Batch.Model Namespace

Nested Namespaces

Amazon.Batch.Model.Internal

Classes

Name Description
CancelJobRequest Container for the parameters to the CancelJob operation. 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.
ClientException
ComputeEnvironmentDetail An object representing an AWS Batch compute environment.
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.
ComputeResource An object representing an AWS Batch compute resource.
ComputeResourceUpdate An object representing the attributes of a compute environment that can be updated.
ContainerDetail An object representing the details of a container that is part of a job.
ContainerOverrides The overrides that should be sent to a container.
ContainerProperties Container properties are used in job definitions to describe the container that is launched as part of a job.
CreateComputeEnvironmentRequest Container for the parameters to the CreateComputeEnvironment operation. Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGEDcompute 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 the latest 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.

CreateComputeEnvironmentResponse This is the response object from the CreateComputeEnvironment operation.
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.

CreateJobQueueResponse This is the response object from the CreateJobQueue operation.
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.

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 and terminate any jobs that have not completed with the TerminateJob.

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

DeregisterJobDefinitionRequest Container for the parameters to the DeregisterJobDefinition operation. Deregisters an AWS Batch job definition.
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.

DescribeComputeEnvironmentsResponse This is the response object from the DescribeComputeEnvironments operation.
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.
DescribeJobDefinitionsResponse This is the response object from the DescribeJobDefinitions operation.
DescribeJobQueuesRequest Container for the parameters to the DescribeJobQueues operation. Describes one or more of your job queues.
DescribeJobQueuesResponse This is the response object from the DescribeJobQueues operation.
DescribeJobsRequest Container for the parameters to the DescribeJobs operation. Describes a list of AWS Batch jobs.
DescribeJobsResponse This is the response object from the DescribeJobs operation.
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.
JobDefinition An object representing an AWS Batch job definition.
JobDependency An object representing an AWS Batch job dependency.
JobDetail An object representing an AWS Batch job.
JobQueueDetail An object representing the details of an AWS Batch job queue.
JobSummary An object representing summary details of a job.
KeyValuePair A key-value pair object.
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.
ListJobsResponse This is the response object from the ListJobs operation.
MountPoint Details on a volume mount point that is used in a job's container properties.
RegisterJobDefinitionRequest Container for the parameters to the RegisterJobDefinition operation. Registers an AWS Batch job definition.
RegisterJobDefinitionResponse This is the response object from the RegisterJobDefinition operation.
ServerException
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.
SubmitJobResponse This is the response object from the SubmitJob operation.
TerminateJobRequest Container for the parameters to the TerminateJob operation. 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.
Ulimit The ulimit settings to pass to the container.
UpdateComputeEnvironmentRequest Container for the parameters to the UpdateComputeEnvironment operation. Updates an AWS Batch compute environment.
UpdateComputeEnvironmentResponse This is the response object from the UpdateComputeEnvironment operation.
UpdateJobQueueRequest Container for the parameters to the UpdateJobQueue operation. Updates a job queue.
UpdateJobQueueResponse This is the response object from the UpdateJobQueue operation.
Volume A data volume used in a job's container properties.