| Class | Description |
|---|---|
| ArrayProperties |
An object that represents an Batch array job.
|
| ArrayPropertiesDetail |
An object that represents the array properties of a job.
|
| ArrayPropertiesSummary |
An object that represents the array properties of a job.
|
| AttemptContainerDetail |
An object that represents the details of a container that's part of a job attempt.
|
| AttemptDetail |
An object that represents a job attempt.
|
| AttemptEcsTaskDetails |
An object that represents the details of a task.
|
| AttemptTaskContainerDetails |
An object that represents the details of a container that's part of a job attempt.
|
| CancelJobRequest |
Contains the parameters for
CancelJob. |
| CancelJobResult | |
| ComputeEnvironmentDetail |
An object that represents an Batch compute environment.
|
| ComputeEnvironmentOrder |
The order that compute environments are tried in for job placement within a queue.
|
| ComputeResource |
An object that represents an Batch compute resource.
|
| ComputeResourceUpdate |
An object that represents the attributes of a compute environment that can be updated.
|
| ContainerDetail |
An object that represents the details of a container that's part of a job.
|
| ContainerOverrides |
The overrides that should be sent to a container.
|
| ContainerProperties |
Container properties are used for Amazon ECS based job definitions.
|
| ContainerSummary |
An object that represents summary details of a container within a job.
|
| CreateComputeEnvironmentRequest |
Contains the parameters for
CreateComputeEnvironment. |
| CreateComputeEnvironmentResult | |
| CreateJobQueueRequest |
Contains the parameters for
CreateJobQueue. |
| CreateJobQueueResult | |
| CreateSchedulingPolicyRequest |
Contains the parameters for
CreateSchedulingPolicy. |
| CreateSchedulingPolicyResult | |
| DeleteComputeEnvironmentRequest |
Contains the parameters for
DeleteComputeEnvironment. |
| DeleteComputeEnvironmentResult | |
| DeleteJobQueueRequest |
Contains the parameters for
DeleteJobQueue. |
| DeleteJobQueueResult | |
| DeleteSchedulingPolicyRequest |
Contains the parameters for
DeleteSchedulingPolicy. |
| DeleteSchedulingPolicyResult | |
| DeregisterJobDefinitionRequest | |
| DeregisterJobDefinitionResult | |
| DescribeComputeEnvironmentsRequest |
Contains the parameters for
DescribeComputeEnvironments. |
| DescribeComputeEnvironmentsResult | |
| DescribeJobDefinitionsRequest |
Contains the parameters for
DescribeJobDefinitions. |
| DescribeJobDefinitionsResult | |
| DescribeJobQueuesRequest |
Contains the parameters for
DescribeJobQueues. |
| DescribeJobQueuesResult | |
| DescribeJobsRequest |
Contains the parameters for
DescribeJobs. |
| DescribeJobsResult | |
| DescribeSchedulingPoliciesRequest |
Contains the parameters for
DescribeSchedulingPolicies. |
| DescribeSchedulingPoliciesResult | |
| Device |
An object that represents a container instance host device.
|
| Ec2Configuration |
Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment.
|
| EcsProperties |
An object that contains the properties for the Amazon ECS resources of a job.
|
| EcsPropertiesDetail |
An object that contains the details for the Amazon ECS resources of a job.
|
| EcsPropertiesOverride |
An object that contains overrides for the Amazon ECS task definition of a job.
|
| EcsTaskDetails |
The details of a task definition that describes the container and volume definitions of an Amazon ECS task.
|
| EcsTaskProperties |
The properties for a task definition that describes the container and volume definitions of an Amazon ECS task.
|
| EFSAuthorizationConfig |
The authorization configuration details for the Amazon EFS file system.
|
| EFSVolumeConfiguration |
This is used when you're using an Amazon Elastic File System file system for job storage.
|
| EksAttemptContainerDetail |
An object that represents the details for an attempt for a job attempt that an Amazon EKS container runs.
|
| EksAttemptDetail |
An object that represents the details of a job attempt for a job attempt by an Amazon EKS container.
|
| EksConfiguration |
Configuration for the Amazon EKS cluster that supports the Batch compute environment.
|
| EksContainer |
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.
|
| EksContainerDetail |
The details for container properties that are returned by
DescribeJobs for jobs that use Amazon EKS. |
| EksContainerEnvironmentVariable |
An environment variable.
|
| EksContainerOverride |
Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API operation.
|
| EksContainerResourceRequirements |
The type and amount of resources to assign to a container.
|
| EksContainerSecurityContext |
The security context for a job.
|
| EksContainerVolumeMount |
The volume mounts for a container for an Amazon EKS job.
|
| EksEmptyDir |
Specifies the configuration of a Kubernetes
emptyDir volume. |
| EksHostPath |
Specifies the configuration of a Kubernetes
hostPath volume. |
| EksMetadata |
Describes and uniquely identifies Kubernetes resources.
|
| EksPodProperties |
The properties for the pod.
|
| EksPodPropertiesDetail |
The details for the pod.
|
| EksPodPropertiesOverride |
An object that contains overrides for the Kubernetes pod properties of a job.
|
| EksProperties |
An object that contains the properties for the Kubernetes resources of a job.
|
| EksPropertiesDetail |
An object that contains the details for the Kubernetes resources of a job.
|
| EksPropertiesOverride |
An object that contains overrides for the Kubernetes resources of a job.
|
| EksSecret |
Specifies the configuration of a Kubernetes
secret volume. |
| EksVolume |
Specifies an Amazon EKS volume for a job definition.
|
| EphemeralStorage |
The amount of ephemeral storage to allocate for the task.
|
| EvaluateOnExit |
Specifies an array of up to 5 conditions to be met, and an action to take (
RETRY or EXIT)
if all conditions are met. |
| FairsharePolicy |
The fair share policy for a scheduling policy.
|
| FargatePlatformConfiguration |
The platform configuration for jobs that are running on Fargate resources.
|
| FrontOfQueueDetail |
Contains a list of the first 100
RUNNABLE jobs associated to a single job queue. |
| FrontOfQueueJobSummary |
An object that represents summary details for the first 100
RUNNABLE jobs in a job queue. |
| GetJobQueueSnapshotRequest | |
| GetJobQueueSnapshotResult | |
| Host |
Determine whether your data volume persists on the host container instance and where it's stored.
|
| ImagePullSecret |
References a Kubernetes secret resource.
|
| JobDefinition |
An object that represents an Batch job definition.
|
| JobDependency |
An object that represents an Batch job dependency.
|
| JobDetail |
An object that represents an Batch job.
|
| JobQueueDetail |
An object that represents the details for an Batch job queue.
|
| JobStateTimeLimitAction |
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.
|
| JobSummary |
An object that represents summary details of a job.
|
| JobTimeout |
An object that represents a job timeout configuration.
|
| KeyValuePair |
A key-value pair object.
|
| KeyValuesPair |
A filter name and value pair that's used to return a more specific list of results from a
ListJobs API
operation. |
| LaunchTemplateSpecification |
An object that represents a launch template that's associated with a compute resource.
|
| LinuxParameters |
Linux-specific modifications that are applied to the container, such as details for device mappings.
|
| ListJobsRequest |
Contains the parameters for
ListJobs. |
| ListJobsResult | |
| ListSchedulingPoliciesRequest |
Contains the parameters for
ListSchedulingPolicies. |
| ListSchedulingPoliciesResult | |
| ListTagsForResourceRequest |
Contains the parameters for
ListTagsForResource. |
| ListTagsForResourceResult | |
| LogConfiguration |
Log configuration options to send to a custom log driver for the container.
|
| MountPoint |
Details for a Docker volume mount point that's used in a job's container properties.
|
| NetworkConfiguration |
The network configuration for jobs that are running on Fargate resources.
|
| NetworkInterface |
An object that represents the elastic network interface for a multi-node parallel job node.
|
| NodeDetails |
An object that represents the details of a multi-node parallel job node.
|
| NodeOverrides |
An object that represents any node overrides to a job definition that's used in a SubmitJob API operation.
|
| NodeProperties |
An object that represents the node properties of a multi-node parallel job.
|
| NodePropertiesSummary |
An object that represents the properties of a node that's associated with a multi-node parallel job.
|
| NodePropertyOverride |
The object that represents any node overrides to a job definition that's used in a SubmitJob API operation.
|
| NodeRangeProperty |
This is an object that represents the properties of the node range for a multi-node parallel job.
|
| RegisterJobDefinitionRequest |
Contains the parameters for
RegisterJobDefinition. |
| RegisterJobDefinitionResult | |
| RepositoryCredentials |
The repository credentials for private registry authentication.
|
| ResourceRequirement |
The type and amount of a resource to assign to a container.
|
| RetryStrategy |
The retry strategy that's associated with a job.
|
| RuntimePlatform |
An object that represents the compute environment architecture for Batch jobs on Fargate.
|
| SchedulingPolicyDetail |
An object that represents a scheduling policy.
|
| SchedulingPolicyListingDetail |
An object that contains the details of a scheduling policy that's returned in a
ListSchedulingPolicy
action. |
| Secret |
An object that represents the secret to expose to your container.
|
| ShareAttributes |
Specifies the weights for the fair share identifiers for the fair share policy.
|
| SubmitJobRequest |
Contains the parameters for
SubmitJob. |
| SubmitJobResult | |
| TagResourceRequest |
Contains the parameters for
TagResource. |
| TagResourceResult | |
| TaskContainerDependency |
A list of containers that this task depends on.
|
| TaskContainerDetails |
The details for the container in this task attempt.
|
| TaskContainerOverrides |
The overrides that should be sent to a container.
|
| TaskContainerProperties |
Container properties are used for Amazon ECS-based job definitions.
|
| TaskPropertiesOverride |
An object that contains overrides for the task definition of a job.
|
| TerminateJobRequest |
Contains the parameters for
TerminateJob. |
| TerminateJobResult | |
| Tmpfs |
The container path, mount options, and size of the
tmpfs mount. |
| Ulimit |
The
ulimit settings to pass to the container. |
| UntagResourceRequest |
Contains the parameters for
UntagResource. |
| UntagResourceResult | |
| UpdateComputeEnvironmentRequest |
Contains the parameters for
UpdateComputeEnvironment. |
| UpdateComputeEnvironmentResult | |
| UpdateJobQueueRequest |
Contains the parameters for
UpdateJobQueue. |
| UpdateJobQueueResult | |
| UpdatePolicy |
Specifies the infrastructure update policy for the compute environment.
|
| UpdateSchedulingPolicyRequest |
Contains the parameters for
UpdateSchedulingPolicy. |
| UpdateSchedulingPolicyResult | |
| Volume |
A data volume that's used in a job's container properties.
|
| Exception | Description |
|---|---|
| AWSBatchException |
Base exception for all service exceptions thrown by AWS Batch
|
| ClientException |
These errors are usually caused by a client action.
|
| ServerException |
These errors are usually caused by a server issue.
|