aws_batch
Using AWS Batch, you can run batch computing workloads on the AWS Cloud.
Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. AWS Batch utilizes the advantages of this computing workload to remove the undifferentiated heavy lifting of configuring and managing required infrastructure, while also adopting a familiar batch computing software approach. Given these advantages, AWS Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively helping to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.
As a fully managed service, AWS Batch can run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads. With AWS Batch, there's no need to install or manage batch computing software. This means that you can focus your time and energy on analyzing results and solving your specific problems.Summary
Functions
-
cancel_job(Client, Input)
Cancels a job in an AWS Batch job queue.
- cancel_job(Client, Input0, Options0)
-
create_compute_environment(Client, Input)
Creates an AWS Batch compute environment.
- create_compute_environment(Client, Input0, Options0)
-
create_job_queue(Client, Input)
Creates an AWS Batch job queue.
- create_job_queue(Client, Input0, Options0)
-
delete_compute_environment(Client, Input)
Deletes an AWS Batch compute environment.
- delete_compute_environment(Client, Input0, Options0)
-
delete_job_queue(Client, Input)
Deletes the specified job queue.
- delete_job_queue(Client, Input0, Options0)
-
deregister_job_definition(Client, Input)
Deregisters an AWS Batch job definition.
- deregister_job_definition(Client, Input0, Options0)
-
describe_compute_environments(Client, Input)
Describes one or more of your compute environments.
- describe_compute_environments(Client, Input0, Options0)
-
describe_job_definitions(Client, Input)
Describes a list of job definitions.
- describe_job_definitions(Client, Input0, Options0)
-
describe_job_queues(Client, Input)
Describes one or more of your job queues.
- describe_job_queues(Client, Input0, Options0)
-
describe_jobs(Client, Input)
Describes a list of AWS Batch jobs.
- describe_jobs(Client, Input0, Options0)
-
list_jobs(Client, Input)
Returns a list of AWS Batch jobs.
- list_jobs(Client, Input0, Options0)
-
list_tags_for_resource(Client, ResourceArn)
Lists the tags for an AWS Batch resource.
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
-
register_job_definition(Client, Input)
Registers an AWS Batch job definition.
- register_job_definition(Client, Input0, Options0)
-
submit_job(Client, Input)
Submits an AWS Batch job from a job definition.
- submit_job(Client, Input0, Options0)
-
tag_resource(Client, ResourceArn, Input)
Associates the specified tags to a resource with the specified
resourceArn
. - tag_resource(Client, ResourceArn, Input0, Options0)
-
terminate_job(Client, Input)
Terminates a job in a job queue.
- terminate_job(Client, Input0, Options0)
-
untag_resource(Client, ResourceArn, Input)
Deletes specified tags from an AWS Batch resource.
- untag_resource(Client, ResourceArn, Input0, Options0)
-
update_compute_environment(Client, Input)
Updates an AWS Batch compute environment.
- update_compute_environment(Client, Input0, Options0)
-
update_job_queue(Client, Input)
Updates a job queue.
- update_job_queue(Client, Input0, Options0)
Functions
cancel_job(Client, Input)
Cancels a job in an AWS Batch job queue.
Jobs that are in theSUBMITTED
, PENDING
, or RUNNABLE
state are
canceled. Jobs that have progressed to STARTING
or RUNNING
are not
canceled (but the API operation still succeeds, even if no job is
canceled); these jobs must be terminated with the TerminateJob
operation.
cancel_job(Client, Input0, Options0)
create_compute_environment(Client, Input)
Creates an AWS Batch compute environment.
You can create MANAGED
or UNMANAGED
compute environments. MANAGED
compute environments can use Amazon EC2 or AWS Fargate resources.
UNMANAGED
compute environments can only use EC2 resources.
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 either to use EC2 On-Demand Instances and EC2 Spot Instances, or to 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 are not supported on Spot Instances.
In an unmanaged compute environment, you can manage your own EC2 compute
resources and have a lot of flexibility with how you configure your
compute resources. For example, you can use custom AMI. However, you need
to verify 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's 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.
AWS Batch doesn't upgrade the AMIs in a compute environment after it's created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS-optimized AMI is available. Therefore, you're responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs, complete these steps:
Create a new compute environment with the new AMI.
Add the compute environment to an existing job queue.
Remove the earlier compute environment from your job queue.
Delete the earlier compute environment.create_compute_environment(Client, Input0, Options0)
create_job_queue(Client, Input)
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.create_job_queue(Client, Input0, Options0)
delete_compute_environment(Client, Input)
Deletes an AWS Batch compute environment.
Before you can delete a compute environment, you must set its state toDISABLED
with the UpdateComputeEnvironment
API operation and
disassociate it from any job queues with the UpdateJobQueue
API
operation. Compute environments that use AWS Fargate resources must
terminate all active jobs on that compute environment before deleting the
compute environment. If this isn't done, the compute environment will end
up in an invalid state.
delete_compute_environment(Client, Input0, Options0)
delete_job_queue(Client, Input)
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.
DeleteJobQueue
request.
delete_job_queue(Client, Input0, Options0)
deregister_job_definition(Client, Input)
Deregisters an AWS Batch job definition.
Job definitions are permanently deleted after 180 days.deregister_job_definition(Client, Input0, Options0)
describe_compute_environments(Client, Input)
Describes one or more of your compute environments.
If you're using an unmanaged compute environment, you can use theDescribeComputeEnvironment
operation to determine the ecsClusterArn
that you should launch your Amazon ECS container instances into.
describe_compute_environments(Client, Input0, Options0)
describe_job_definitions(Client, Input)
Describes a list of job definitions.
You can specify astatus
(such as ACTIVE
) to only return job
definitions that match that status.
describe_job_definitions(Client, Input0, Options0)
describe_job_queues(Client, Input)
Describes one or more of your job queues.
describe_job_queues(Client, Input0, Options0)
describe_jobs(Client, Input)
Describes a list of AWS Batch jobs.
describe_jobs(Client, Input0, Options0)
list_jobs(Client, Input)
Returns a list of AWS Batch jobs.
You must specify only one of the following items:
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
jobStatus
parameter. If you don't specify a status, only RUNNING
jobs are
returned.
list_jobs(Client, Input0, Options0)
list_tags_for_resource(Client, ResourceArn)
Lists the tags for an AWS Batch resource.
AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
register_job_definition(Client, Input)
Registers an AWS Batch job definition.
register_job_definition(Client, Input0, Options0)
submit_job(Client, Input)
Submits an AWS Batch job from a job definition.
Parameters specified during SubmitJob
override parameters defined in the
job definition.
submit_job(Client, Input0, Options0)
tag_resource(Client, ResourceArn, Input)
Associates the specified tags to a resource with the specified
resourceArn
.
tag_resource(Client, ResourceArn, Input0, Options0)
terminate_job(Client, Input)
Terminates a job in a job queue.
Jobs that are in theSTARTING
or RUNNING
state are terminated, which
causes them to transition to FAILED
. Jobs that have not progressed to
the STARTING
state are cancelled.
terminate_job(Client, Input0, Options0)
untag_resource(Client, ResourceArn, Input)
Deletes specified tags from an AWS Batch resource.
untag_resource(Client, ResourceArn, Input0, Options0)
update_compute_environment(Client, Input)
Updates an AWS Batch compute environment.
update_compute_environment(Client, Input0, Options0)
update_job_queue(Client, Input)
Updates a job queue.