| Class | Description |
|---|---|
| ArrayProperties |
An object representing an AWS Batch array job.
|
| ArrayPropertiesDetail |
An object representing the array properties of a job.
|
| ArrayPropertiesSummary |
An object representing the array properties of a job.
|
| AttemptContainerDetail |
An object representing the details of a container that is part of a job attempt.
|
| AttemptDetail |
An object representing a job attempt.
|
| CancelJobRequest | |
| CancelJobResult | |
| ComputeEnvironmentDetail |
An object representing an AWS Batch compute environment.
|
| ComputeEnvironmentOrder |
The order in which compute environments are tried for job placement within a queue.
|
| ComputeResource |
An object representing an AWS Batch compute resource.
|
| ComputeResourceUpdate |
An object representing the attributes of a compute environment that can be updated.
|
| ContainerDetail |
An object representing the details of a container that is part of a job.
|
| ContainerOverrides |
The overrides that should be sent to a container.
|
| ContainerProperties |
Container properties are used in job definitions to describe the container that is launched as part of a job.
|
| ContainerSummary |
An object representing summary details of a container within a job.
|
| CreateComputeEnvironmentRequest | |
| CreateComputeEnvironmentResult | |
| CreateJobQueueRequest | |
| CreateJobQueueResult | |
| DeleteComputeEnvironmentRequest | |
| DeleteComputeEnvironmentResult | |
| DeleteJobQueueRequest | |
| DeleteJobQueueResult | |
| DeregisterJobDefinitionRequest | |
| DeregisterJobDefinitionResult | |
| DescribeComputeEnvironmentsRequest | |
| DescribeComputeEnvironmentsResult | |
| DescribeJobDefinitionsRequest | |
| DescribeJobDefinitionsResult | |
| DescribeJobQueuesRequest | |
| DescribeJobQueuesResult | |
| DescribeJobsRequest | |
| DescribeJobsResult | |
| Device |
An object representing a container instance host device.
|
| EvaluateOnExit |
Specifies a set of conditions to be met, and an action to take (
RETRY or EXIT) if all
conditions are met. |
| Host |
Determine whether your data volume persists on the host container instance and where it is stored.
|
| 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.
|
| JobQueueDetail |
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.
|
| KeyValuePair |
A key-value pair object.
|
| LaunchTemplateSpecification |
An object representing a launch template associated with a compute resource.
|
| LinuxParameters |
Linux-specific modifications that are applied to the container, such as details for device mappings.
|
| ListJobsRequest | |
| ListJobsResult | |
| ListTagsForResourceRequest | |
| ListTagsForResourceResult | |
| LogConfiguration |
Log configuration options to send to a custom log driver for the container.
|
| MountPoint |
Details on a Docker volume mount point that is used in a job's container properties.
|
| NetworkInterface |
An object representing the elastic network interface for a multi-node parallel job node.
|
| NodeDetails |
An object representing the details of a multi-node parallel job node.
|
| NodeOverrides |
Object representing any node overrides to a job definition that is used in a SubmitJob API operation.
|
| NodeProperties |
An object representing the node properties of a multi-node parallel job.
|
| NodePropertiesSummary |
An object representing the properties of a node that is associated with a multi-node parallel job.
|
| NodePropertyOverride |
Object representing any node overrides to a job definition that is used in a SubmitJob API operation.
|
| NodeRangeProperty |
An object representing the properties of the node range for a multi-node parallel job.
|
| RegisterJobDefinitionRequest | |
| RegisterJobDefinitionResult | |
| ResourceRequirement |
The type and amount of a resource to assign to a container.
|
| RetryStrategy |
The retry strategy associated with a job.
|
| Secret |
An object representing the secret to expose to your container.
|
| SubmitJobRequest | |
| SubmitJobResult | |
| TagResourceRequest | |
| TagResourceResult | |
| TerminateJobRequest | |
| TerminateJobResult | |
| Tmpfs |
The container path, mount options, and size of the tmpfs mount.
|
| Ulimit |
The
ulimit settings to pass to the container. |
| UntagResourceRequest | |
| UntagResourceResult | |
| UpdateComputeEnvironmentRequest | |
| UpdateComputeEnvironmentResult | |
| UpdateJobQueueRequest | |
| UpdateJobQueueResult | |
| Volume |
A data volume used in a job's container properties.
|
| Enum | Description |
|---|---|
| ArrayJobDependency | |
| CEState | |
| CEStatus | |
| CEType | |
| CRAllocationStrategy | |
| CRType | |
| DeviceCgroupPermission | |
| JobDefinitionType | |
| JobStatus | |
| JQState | |
| JQStatus | |
| LogDriver | |
| ResourceType | |
| RetryAction |
| Exception | Description |
|---|---|
| AWSBatchException |
Base exception for all service exceptions thrown by AWS Batch
|
| ClientException |
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that
doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
|
| ServerException |
These errors are usually caused by a server issue.
|