Batch class

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 utilizes the advantages of this computing workload to remove the undifferentiated heavy lifting of configuring and managing required infrastructure, while also adopting 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 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.

Constructors

Batch({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

cancelJob({required String jobId, required String reason}) → Future<void>
Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are canceled. Jobs that have progressed to STARTING or RUNNING are not canceled (but the API operation still succeeds, even if no job is canceled); these jobs must be terminated with the TerminateJob operation.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createComputeEnvironment({required String computeEnvironmentName, required String serviceRole, required CEType type, ComputeResource? computeResources, CEState? state, Map<String, String>? tags}) → Future<CreateComputeEnvironmentResponse>
Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources. UNMANAGED compute environments can only use EC2 resources.
createJobQueue({required List<ComputeEnvironmentOrder> computeEnvironmentOrder, required String jobQueueName, required int priority, JQState? state, Map<String, String>? tags}) → Future<CreateJobQueueResponse>
Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.
deleteComputeEnvironment({required String computeEnvironment}) → Future<void>
Deletes an AWS Batch compute environment.
deleteJobQueue({required String jobQueue}) → Future<void>
Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are eventually terminated when you delete a job queue. The jobs are terminated at a rate of about 16 jobs each second.
deregisterJobDefinition({required String jobDefinition}) → Future<void>
Deregisters an AWS Batch job definition. Job definitions are permanently deleted after 180 days.
describeComputeEnvironments({List<String>? computeEnvironments, int? maxResults, String? nextToken}) → Future<DescribeComputeEnvironmentsResponse>
Describes one or more of your compute environments.
describeJobDefinitions({String? jobDefinitionName, List<String>? jobDefinitions, int? maxResults, String? nextToken, String? status}) → Future<DescribeJobDefinitionsResponse>
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.
describeJobQueues({List<String>? jobQueues, int? maxResults, String? nextToken}) → Future<DescribeJobQueuesResponse>
Describes one or more of your job queues.
describeJobs({required List<String> jobs}) → Future<DescribeJobsResponse>
Describes a list of AWS Batch jobs.
listJobs({String? arrayJobId, String? jobQueue, JobStatus? jobStatus, int? maxResults, String? multiNodeJobId, String? nextToken}) → Future<ListJobsResponse>
Returns a list of AWS Batch jobs.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Lists the tags for an AWS Batch resource. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerJobDefinition({required String jobDefinitionName, required JobDefinitionType type, ContainerProperties? containerProperties, NodeProperties? nodeProperties, Map<String, String>? parameters, List<PlatformCapability>? platformCapabilities, bool? propagateTags, RetryStrategy? retryStrategy, Map<String, String>? tags, JobTimeout? timeout}) → Future<RegisterJobDefinitionResponse>
Registers an AWS Batch job definition.
submitJob({required String jobDefinition, required String jobName, required String jobQueue, ArrayProperties? arrayProperties, ContainerOverrides? containerOverrides, List<JobDependency>? dependsOn, NodeOverrides? nodeOverrides, Map<String, String>? parameters, bool? propagateTags, RetryStrategy? retryStrategy, Map<String, String>? tags, JobTimeout? timeout}) → Future<SubmitJobResponse>
Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.
tagResource({required String resourceArn, required Map<String, String> tags}) → Future<void>
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are deleted as well. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
terminateJob({required String jobId, required String reason}) → Future<void>
Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Deletes specified tags from an AWS Batch resource.
updateComputeEnvironment({required String computeEnvironment, ComputeResourceUpdate? computeResources, String? serviceRole, CEState? state}) → Future<UpdateComputeEnvironmentResponse>
Updates an AWS Batch compute environment.
updateJobQueue({required String jobQueue, List<ComputeEnvironmentOrder>? computeEnvironmentOrder, int? priority, JQState? state}) → Future<UpdateJobQueueResponse>
Updates a job queue.

Operators

operator ==(Object other) → bool
The equality operator.
inherited