Crate rusoto_batch
source · [−]Expand description
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 uses the advantages of this computing workload to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts 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 you 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.
If you’re using the service, you’re probably looking for BatchClient and Batch.
Structs
An object representing an AWS Batch array job.
An object representing the array properties of a job.
An object representing the array properties of a job.
An object representing the details of a container that's part of a job attempt.
An object representing a job attempt.
A client for the AWS Batch API.
Contains the parameters for CancelJob.
An object representing an AWS Batch compute environment.
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 environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.
All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.
An object representing an AWS Batch compute resource. For more information, see Compute Environments in the AWS Batch User Guide.
An object representing the attributes of a compute environment that can be updated. For more information, see Compute Environments in the AWS Batch User Guide.
An object representing the details of a container that's part of a job.
The overrides that should be sent to a container.
Container properties are used in job definitions to describe the container that's launched as part of a job.
An object representing summary details of a container within a job.
Contains the parameters for CreateComputeEnvironment.
Contains the parameters for CreateJobQueue.
Contains the parameters for DeleteComputeEnvironment.
Contains the parameters for DeleteJobQueue.
Contains the parameters for DescribeComputeEnvironments.
Contains the parameters for DescribeJobDefinitions.
Contains the parameters for DescribeJobQueues.
Contains the parameters for DescribeJobs.
An object representing a container instance host device.
This object isn't applicable to jobs running on Fargate resources and shouldn't be provided.
The authorization configuration details for the Amazon EFS file system.
This parameter is specified when you are using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS Volumes in the AWS Batch User Guide.
Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If Ec2Configuration isn't specified, the default is currently ECSAL1 (<a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimizedAMI.html#alami">Amazon Linux) for non-GPU, non-Graviton instances. Starting on March 31, 2021, this default will be changing to ECSAL2 (<a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimizedAMI.html#al2ami">Amazon Linux 2).
This object isn't applicable to jobs running on Fargate resources.
Specifies a set of conditions to be met, and an action to take (RETRY or EXIT) if all conditions are met.
The platform configuration for jobs running on Fargate resources. For jobs that run on EC2 resources, you shouldn't specify this parameter.
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 isn't guaranteed to persist after the containers associated with it stop running.
An object representing an AWS Batch job definition.
An object representing an AWS Batch job dependency.
An object representing an AWS Batch job.
An object representing the details of an AWS Batch job queue.
An object representing summary details of a job.
An object representing a job timeout configuration.
A key-value pair object.
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.
If security groups are specified using both the securityGroupIds parameter of CreateComputeEnvironment and the launch template, the values in the securityGroupIds parameter of CreateComputeEnvironment will be used.
This object isn't applicable to jobs running on Fargate resources.
Linux-specific modifications that are applied to the container, such as details for device mappings.
Contains the parameters for ListJobs.
Log configuration options to send to a custom log driver for the container.
Details on a Docker volume mount point that's used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
An object representing the elastic network interface for a multi-node parallel job node.
An object representing the details of a multi-node parallel job node.
Object representing any node overrides to a job definition that's used in a SubmitJob API operation.
This isn't applicable to jobs running on Fargate resources and shouldn't be provided; use containerOverrides instead.
An object representing the node properties of a multi-node parallel job.
An object representing the properties of a node that's associated with a multi-node parallel job.
Object representing any node overrides to a job definition that's used in a SubmitJob API operation.
An object representing the properties of the node range for a multi-node parallel job.
Contains the parameters for RegisterJobDefinition.
The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
The retry strategy associated with a job. For more information, see Automated job retries in the AWS Batch User Guide.
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
-
To inject sensitive data into your containers as environment variables, use the
secretscontainer definition parameter. -
To reference sensitive information in the log configuration of a container, use the
secretOptionscontainer definition parameter.
For more information, see Specifying sensitive data in the AWS Batch User Guide.
Contains the parameters for SubmitJob.
Contains the parameters for TerminateJob.
The container path, mount options, and size of the tmpfs mount.
This object isn't applicable to jobs running on Fargate resources.
The ulimit settings to pass to the container.
This object isn't applicable to jobs running on Fargate resources.
Contains the parameters for UpdateComputeEnvironment.
Contains the parameters for UpdateJobQueue.
A data volume used in a job's container properties.
Enums
Errors returned by CancelJob
Errors returned by CreateComputeEnvironment
Errors returned by CreateJobQueue
Errors returned by DeleteComputeEnvironment
Errors returned by DeleteJobQueue
Errors returned by DeregisterJobDefinition
Errors returned by DescribeComputeEnvironments
Errors returned by DescribeJobDefinitions
Errors returned by DescribeJobQueues
Errors returned by DescribeJobs
Errors returned by ListJobs
Errors returned by ListTagsForResource
Errors returned by RegisterJobDefinition
Errors returned by SubmitJob
Errors returned by TagResource
Errors returned by TerminateJob
Errors returned by UntagResource
Errors returned by UpdateComputeEnvironment
Errors returned by UpdateJobQueue
Traits
Trait representing the capabilities of the AWS Batch API. AWS Batch clients implement this trait.