| Class | Description |
|---|---|
| ArrayProperties |
An object representing an 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's part of a job attempt.
|
| AttemptDetail |
An object representing a job attempt.
|
| CancelJobRequest |
Contains the parameters for
CancelJob. |
| CancelJobResult | |
| ComputeEnvironmentDetail |
An object representing an Batch compute environment.
|
| ComputeEnvironmentOrder |
The order in which compute environments are tried for job placement within a queue.
|
| ComputeResource |
An object representing an 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's 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's launched as part of a job.
|
| ContainerSummary |
An object representing 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 representing a container instance host device.
|
| Ec2Configuration |
Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment.
|
| 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.
|
| EvaluateOnExit |
Specifies a set of 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.
|
| Host |
Determine whether your data volume persists on the host container instance and where it is stored.
|
| JobDefinition |
An object representing an Batch job definition.
|
| JobDependency |
An object representing an Batch job dependency.
|
| JobDetail |
An object representing an Batch job.
|
| JobQueueDetail |
An object representing the details of an 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.
|
| 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 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 |
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 on 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 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's 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's associated with a multi-node parallel job.
|
| NodePropertyOverride |
Object representing any node overrides to a job definition that's used in a SubmitJob API operation.
|
| NodeRangeProperty |
An object representing the properties of the node range for a multi-node parallel job.
|
| RegisterJobDefinitionRequest |
Contains the parameters for
RegisterJobDefinition. |
| RegisterJobDefinitionResult | |
| ResourceRequirement |
The type and amount of a resource to assign to a container.
|
| RetryStrategy |
The retry strategy associated with a job.
|
| 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 representing 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 | |
| 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 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, 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's not valid.
|
| ServerException |
These errors are usually caused by a server issue.
|
Copyright © 2022. All rights reserved.