Expand description
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.
If you’re using the service, you’re probably looking for BatchClient and Batch.
Structs§
- Array
Properties An object representing an AWS Batch array job.
- Array
Properties Detail An object representing the array properties of a job.
- Array
Properties Summary An object representing the array properties of a job.
- Attempt
Container Detail An object representing the details of a container that is part of a job attempt.
- Attempt
Detail An object representing a job attempt.
- Batch
Client - A client for the AWS Batch API.
- Cancel
JobRequest - Cancel
JobResponse - Compute
Environment Detail An object representing an AWS Batch compute environment.
- Compute
Environment Order 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.
- Compute
Resource An object representing an AWS Batch compute resource.
- Compute
Resource Update An object representing the attributes of a compute environment that can be updated.
- Container
Detail An object representing the details of a container that is part of a job.
- Container
Overrides The overrides that should be sent to a container.
- Container
Properties Container properties are used in job definitions to describe the container that is launched as part of a job.
- Container
Summary An object representing summary details of a container within a job.
- Create
Compute Environment Request - Create
Compute Environment Response - Create
JobQueue Request - Create
JobQueue Response - Delete
Compute Environment Request - Delete
Compute Environment Response - Delete
JobQueue Request - Delete
JobQueue Response - Deregister
JobDefinition Request - Deregister
JobDefinition Response - Describe
Compute Environments Request - Describe
Compute Environments Response - Describe
JobDefinitions Request - Describe
JobDefinitions Response - Describe
JobQueues Request - Describe
JobQueues Response - Describe
Jobs Request - Describe
Jobs Response - Device
An object representing a container instance host device.
- Host
Determine whether your data volume persists on the host container instance and where it is stored. If this 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.
- JobQueue
Detail An object representing the details of an AWS Batch job queue.
- JobSummary
An object representing summary details of a job.
- JobTimeout
An object representing a job timeout configuration.
- KeyValue
Pair A key-value pair object.
- Launch
Template Specification An object representing a launch template associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both.
- Linux
Parameters Linux-specific modifications that are applied to the container, such as details for device mappings.
- List
Jobs Request - List
Jobs Response - Mount
Point Details on a Docker volume mount point that is used in a job's container properties. This parameter maps to
Volumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run.- Network
Interface An object representing the elastic network interface for a multi-node parallel job node.
- Node
Details An object representing the details of a multi-node parallel job node.
- Node
Overrides Object representing any node overrides to a job definition that is used in a SubmitJob API operation.
- Node
Properties An object representing the node properties of a multi-node parallel job.
- Node
Properties Summary An object representing the properties of a node that is associated with a multi-node parallel job.
- Node
Property Override Object representing any node overrides to a job definition that is used in a SubmitJob API operation.
- Node
Range Property An object representing the properties of the node range for a multi-node parallel job.
- Register
JobDefinition Request - Register
JobDefinition Response - Resource
Requirement The type and amount of a resource to assign to a container. Currently, the only supported resource type is
GPU.- Retry
Strategy The retry strategy associated with a job.
- Submit
JobRequest - Submit
JobResponse - Terminate
JobRequest - Terminate
JobResponse - Ulimit
The
ulimitsettings to pass to the container.- Update
Compute Environment Request - Update
Compute Environment Response - Update
JobQueue Request - Update
JobQueue Response - Volume
A data volume used in a job's container properties.
Enums§
- Cancel
JobError - Errors returned by CancelJob
- Create
Compute Environment Error - Errors returned by CreateComputeEnvironment
- Create
JobQueue Error - Errors returned by CreateJobQueue
- Delete
Compute Environment Error - Errors returned by DeleteComputeEnvironment
- Delete
JobQueue Error - Errors returned by DeleteJobQueue
- Deregister
JobDefinition Error - Errors returned by DeregisterJobDefinition
- Describe
Compute Environments Error - Errors returned by DescribeComputeEnvironments
- Describe
JobDefinitions Error - Errors returned by DescribeJobDefinitions
- Describe
JobQueues Error - Errors returned by DescribeJobQueues
- Describe
Jobs Error - Errors returned by DescribeJobs
- List
Jobs Error - Errors returned by ListJobs
- Register
JobDefinition Error - Errors returned by RegisterJobDefinition
- Submit
JobError - Errors returned by SubmitJob
- Terminate
JobError - Errors returned by TerminateJob
- Update
Compute Environment Error - Errors returned by UpdateComputeEnvironment
- Update
JobQueue Error - Errors returned by UpdateJobQueue
Traits§
- Batch
- Trait representing the capabilities of the AWS Batch API. AWS Batch clients implement this trait.