Package-level declarations

Types

Link copied to clipboard

Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of the batch computing to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts a familiar batch computing software approach. You can use Batch to efficiently provision resources, and work toward eliminating capacity constraints, reducing your overall compute costs, and delivering results more quickly.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard
inline suspend fun BatchClient.cancelJob(crossinline block: CancelJobRequest.Builder.() -> Unit): CancelJobResponse

Cancels a job in an Batch job queue. Jobs that are in a SUBMITTED, PENDING, or RUNNABLE state are cancelled and the job status is updated to FAILED.

Link copied to clipboard

Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use EC2 resources.

Link copied to clipboard

Creates an Batch consumable resource.

Link copied to clipboard

Creates an 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.

Link copied to clipboard

Creates an Batch scheduling policy.

Link copied to clipboard

Deletes an Batch compute environment.

Link copied to clipboard

Deletes the specified consumable resource.

Link copied to clipboard

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.

Link copied to clipboard

Deletes the specified scheduling policy.

Link copied to clipboard

Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.

Link copied to clipboard

Describes one or more of your compute environments.

Link copied to clipboard

Returns a description of the specified consumable resource.

Link copied to clipboard

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.

Link copied to clipboard

Describes one or more of your job queues.

Link copied to clipboard
inline suspend fun BatchClient.describeJobs(crossinline block: DescribeJobsRequest.Builder.() -> Unit): DescribeJobsResponse

Describes a list of Batch jobs.

Link copied to clipboard

Describes one or more of your scheduling policies.

Link copied to clipboard

Provides a list of the first 100 RUNNABLE jobs associated to a single job queue.

Link copied to clipboard

Returns a list of Batch consumable resources.

Link copied to clipboard
inline suspend fun BatchClient.listJobs(crossinline block: ListJobsRequest.Builder.() -> Unit): ListJobsResponse

Returns a list of Batch jobs.

Link copied to clipboard

Returns a list of Batch jobs that require a specific consumable resource.

Link copied to clipboard

Returns a list of Batch scheduling policies.

Link copied to clipboard

Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

Link copied to clipboard

Registers an Batch job definition.

Link copied to clipboard
inline suspend fun BatchClient.submitJob(crossinline block: SubmitJobRequest.Builder.() -> Unit): SubmitJobResponse

Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the resourceRequirements objects in the job definition are the exception. They can't be overridden this way using the memory and vcpus parameters. Rather, you must specify updates to job definition parameters in a resourceRequirements object that's included in the containerOverrides parameter.

Link copied to clipboard
inline suspend fun BatchClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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 that are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

Link copied to clipboard
inline suspend fun BatchClient.terminateJob(crossinline block: TerminateJobRequest.Builder.() -> Unit): TerminateJobResponse

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.

Link copied to clipboard

Deletes specified tags from an Batch resource.

Link copied to clipboard

Updates an Batch compute environment.

Link copied to clipboard

Updates a consumable resource.

Link copied to clipboard

Updates a job queue.

Link copied to clipboard

Updates a scheduling policy.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.