aws_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.

Summary

Functions

• cancel_job(Client, Input)
  Cancels a job in an AWS Batch job queue.
• cancel_job(Client, Input0, Options)
• create_compute_environment(Client, Input)
  Creates an AWS Batch compute environment.
• create_compute_environment(Client, Input0, Options)
• create_job_queue(Client, Input)
  Creates an AWS Batch job queue.
• create_job_queue(Client, Input0, Options)
• delete_compute_environment(Client, Input)
  Deletes an AWS Batch compute environment.
• delete_compute_environment(Client, Input0, Options)
• delete_job_queue(Client, Input)
  Deletes the specified job queue.
• delete_job_queue(Client, Input0, Options)
• deregister_job_definition(Client, Input)
  Deregisters an AWS Batch job definition.
• deregister_job_definition(Client, Input0, Options)
• describe_compute_environments(Client, Input)
  Describes one or more of your compute environments.
• describe_compute_environments(Client, Input0, Options)
• describe_job_definitions(Client, Input)
  Describes a list of job definitions.
• describe_job_definitions(Client, Input0, Options)
• describe_job_queues(Client, Input)
  Describes one or more of your job queues.
• describe_job_queues(Client, Input0, Options)
• describe_jobs(Client, Input)
  Describes a list of AWS Batch jobs.
• describe_jobs(Client, Input0, Options)
• list_jobs(Client, Input)
  Returns a list of AWS Batch jobs.
• list_jobs(Client, Input0, Options)
• register_job_definition(Client, Input)
  Registers an AWS Batch job definition.
• register_job_definition(Client, Input0, Options)
• submit_job(Client, Input)
  Submits an AWS Batch job from a job definition.
• submit_job(Client, Input0, Options)
• terminate_job(Client, Input)
  Terminates a job in a job queue.
• terminate_job(Client, Input0, Options)
• update_compute_environment(Client, Input)
  Updates an AWS Batch compute environment.
• update_compute_environment(Client, Input0, Options)
• update_job_queue(Client, Input)
  Updates a job queue.
• update_job_queue(Client, Input0, Options)

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.

Multi-node parallel jobs are not supported on Spot Instances. 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. 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.

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.

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.