aws-elixir v0.6.0 AWS.Batch View Source
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.
Link to this section Summary
Functions
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.
Creates an AWS Batch compute environment. You can create MANAGED or
UNMANAGED compute environments.
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.
Deletes an AWS Batch compute environment.
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.
Deregisters an AWS Batch job definition. Job definitions will be permanently deleted after 180 days.
Describes one or more of your compute environments.
Describes a list of job definitions. You can specify a status (such as
ACTIVE) to only return job definitions that match that status.
Describes one or more of your job queues.
Describes a list of AWS Batch jobs.
Returns a list of AWS Batch jobs.
Registers an AWS Batch job definition.
Submits an AWS Batch job from a job definition. Parameters specified during
SubmitJob override parameters defined in the job definition.
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.
Updates an AWS Batch compute environment.
Updates a job queue.
Link to this section Functions
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.
Creates an AWS Batch compute environment. You can create MANAGED or
UNMANAGED compute environments.
In a managed compute environment, AWS 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. You can choose to use Amazon EC2 On-Demand Instances or Spot Instances in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage of the On-Demand price.
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. 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.
- Create a new compute environment with the new AMI.
- Add the compute environment to an existing job queue.
- Remove the old compute environment from your job queue.
- Delete the old compute environment.
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.
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.
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.
Deregisters an AWS Batch job definition. Job definitions will be permanently deleted after 180 days.
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.
Describes a list of job definitions. You can specify a status (such as
ACTIVE) to only return job definitions that match that status.
Describes one or more of your job queues.
Describes a list of AWS Batch jobs.
Returns a list of AWS Batch jobs.
You must specify only one of the following:
- 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 that job's nodes
- an array job ID to return a list of that job's children
Registers an AWS Batch job definition.
Submits an AWS Batch job from a job definition. Parameters specified during
SubmitJob override parameters defined in the job definition.
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.
Updates an AWS Batch compute environment.
Updates a job queue.