Package-level declarations
Types
An object that represents an Batch array job.
An object that represents the array properties of a job.
An object that represents the array properties of a job.
An object that represents the details of a container that's part of a job attempt.
An object that represents a job attempt.
An object that represents the details of a task.
An object that represents the details of a container that's part of a job attempt.
Base class for all service related exceptions thrown by the Batch client
Contains the parameters for CancelJob.
These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.
An object that represents an Batch compute environment.
The order that compute environments are tried in 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); Amazon EC2 and Fargate compute environments can't be mixed.
An object that represents an Batch compute resource. For more information, see Compute environments in the Batch User Guide.
An object that represents the attributes of a compute environment that can be updated. For more information, see Updating compute environments in the Batch User Guide.
Contains a list of consumable resources required by a job.
Information about a consumable resource required to run a job.
Current information about a consumable resource.
An object that represents the details of a container that's part of a job.
The overrides that should be sent to a container.
Container properties are used for Amazon ECS based job definitions. These properties to describe the container that's launched as part of a job.
An object that represents summary details of a container within a job.
Contains the parameters for CreateComputeEnvironment.
Contains the parameters for CreateJobQueue.
Contains the parameters for CreateSchedulingPolicy.
Contains the parameters for DeleteComputeEnvironment.
Contains the parameters for DeleteJobQueue.
Contains the parameters for DeleteSchedulingPolicy.
Contains the parameters for DescribeComputeEnvironments.
Contains the parameters for DescribeJobDefinitions.
Contains the parameters for DescribeJobQueues.
Contains the parameters for DescribeJobs.
Contains the parameters for DescribeSchedulingPolicies.
Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2 (Amazon Linux 2).
An object that contains the properties for the Amazon ECS resources of a job.
An object that contains the details for the Amazon ECS resources of a job.
An object that contains overrides for the Amazon ECS task definition of a job.
The details of a task definition that describes the container and volume definitions of an Amazon ECS task.
The properties for a task definition that describes the container and volume definitions of an Amazon ECS task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.
The authorization configuration details for the Amazon EFS file system.
This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see Amazon EFS Volumes in the Batch User Guide.
An object that represents the details for an attempt for a job attempt that an Amazon EKS container runs.
An object that represents the details of a job attempt for a job attempt by an Amazon EKS container.
Configuration for the Amazon EKS cluster that supports the Batch compute environment. The cluster must exist before the compute environment can be created.
EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties for a container node in the pod that's launched as part of a job. This can't be specified for Amazon ECS based job definitions.
The details for container properties that are returned by DescribeJobs for jobs that use Amazon EKS.
An environment variable.
Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API operation.
The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.
The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.
The volume mounts for a container for an Amazon EKS job. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.
Specifies the configuration of a Kubernetes emptyDir volume. An emptyDir volume is first created when a pod is assigned to a node. It exists as long as that pod is running on that node. The emptyDir volume is initially empty. All containers in the pod can read and write the files in the emptyDir volume. However, the emptyDir volume can be mounted at the same or different paths in each container. When a pod is removed from a node for any reason, the data in the emptyDir is deleted permanently. For more information, see emptyDir in the Kubernetes documentation.
Specifies the configuration of a Kubernetes hostPath volume. A hostPath volume mounts an existing file or directory from the host node's filesystem into your pod. For more information, see hostPath in the Kubernetes documentation.
Describes and uniquely identifies Kubernetes resources. For example, the compute environment that a pod runs in or the jobID for a job running in the pod. For more information, see Understanding Kubernetes Objects in the Kubernetes documentation.
A persistentVolumeClaim volume is used to mount a PersistentVolume into a Pod. PersistentVolumeClaims are a way for users to "claim" durable storage without knowing the details of the particular cloud environment. See the information about PersistentVolumes in the Kubernetes documentation.
The properties for the pod.
The details for the pod.
An object that contains overrides for the Kubernetes pod properties of a job.
An object that contains the properties for the Kubernetes resources of a job.
An object that contains the details for the Kubernetes resources of a job.
An object that contains overrides for the Kubernetes resources of a job.
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.
Specifies an array of up to 5 conditions to be met, and an action to take (RETRY or EXIT) if all conditions are met. If none of the EvaluateOnExit conditions in a RetryStrategy match, then the job is retried.
The fair-share scheduling policy details.
The platform configuration for jobs that are running on Fargate resources. Jobs that run on Amazon EC2 resources must not specify this parameter.
The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
Contains a list of the first 100 RUNNABLE jobs associated to a single job queue.
An object that represents summary details for the first 100 RUNNABLE jobs in a job queue.
Determine whether your data volume persists on the host container instance and where it's stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.
References a Kubernetes secret resource. This name of the secret must start and end with an alphanumeric character, is required to be lowercase, can include periods (.) and hyphens (-), and can't contain more than 253 characters.
An object that represents an Batch job definition.
An object that represents an Batch job dependency.
An object that represents the details for an Batch job queue.
Specifies an action that Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time.
An object that represents summary details of a job.
An object that represents a job timeout configuration.
A key-value pair object.
A filter name and value pair that's used to return a more specific list of results from a ListJobs or ListJobsByConsumableResource API operation.
An object that represents a launch template that's associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both.
An object that represents a launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.
Linux-specific modifications that are applied to the container, such as details for device mappings.
Current information about a consumable resource required by a job.
Contains the parameters for ListJobs.
Contains the parameters for ListSchedulingPolicies.
Contains the parameters for ListTagsForResource.
Log configuration options to send to a custom log driver for the container.
Details for 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 that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
An object that represents the elastic network interface for a multi-node parallel job node.
An object that represents the details of a multi-node parallel job node.
An object that represents any node overrides to a job definition that's used in a SubmitJob API operation.
An object that represents the node properties of a multi-node parallel job.
An object that represents the properties of a node that's associated with a multi-node parallel job.
The object that represents any node overrides to a job definition that's used in a SubmitJob API operation.
This is an object that represents the properties of the node range for a multi-node parallel job.
Contains the parameters for RegisterJobDefinition.
The repository credentials for private registry authentication.
The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
The retry strategy that's associated with a job. For more information, see Automated job retries in the Batch User Guide.
An object that represents the compute environment architecture for Batch jobs on Fargate.
An object that represents a scheduling policy.
An object that contains the details of a scheduling policy that's returned in a ListSchedulingPolicy action.
These errors are usually caused by a server issue.
Specifies the weights for the share identifiers for the fair-share policy. Share identifiers that aren't included have a default weight of 1.0.
Contains the parameters for SubmitJob.
Contains the parameters for TagResource.
A list of containers that this task depends on.
The details for the container in this task attempt.
The overrides that should be sent to a container.
Container properties are used for Amazon ECS-based job definitions. These properties to describe the container that's launched as part of a job.
An object that contains overrides for the task definition of a job.
Contains the parameters for TerminateJob.
Contains the parameters for UntagResource.
Contains the parameters for UpdateComputeEnvironment.
Contains the parameters for UpdateJobQueue.
Specifies the infrastructure update policy for the Amazon EC2 compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.
Contains the parameters for UpdateSchedulingPolicy.