@aws-sdk/client-batch

Description

AWS SDK for JavaScript Batch Client for Node.js, Browser and React Native.

Batch

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.

As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically
provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific
workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus
on analyzing results and solving your specific problems instead.

Installing

To install this package, simply type add or install @aws-sdk/client-batch
using your favorite package manager:
- npm install @aws-sdk/client-batch
- yarn add @aws-sdk/client-batch
- pnpm add @aws-sdk/client-batch

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the BatchClient and
the commands you need, for example ListJobsCommand:

``js
// ES5 example
const { BatchClient, ListJobsCommand } = require("@aws-sdk/client-batch");
`

`ts
// ES6+ example
import { BatchClient, ListJobsCommand } from "@aws-sdk/client-batch";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new BatchClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListJobsCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-batch";
const client = new AWS.Batch({ region: "REGION" });

// async/await.
try {
const data = await client.listJobs(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listJobs(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listJobs(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-batch` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

CancelJob

Command API Reference / Input / Output

CreateComputeEnvironment

Command API Reference / Input / Output

CreateConsumableResource

Command API Reference / Input / Output

CreateJobQueue

Command API Reference / Input / Output

CreateSchedulingPolicy

Command API Reference / Input / Output

CreateServiceEnvironment

Command API Reference / Input / Output

DeleteComputeEnvironment

Command API Reference / Input / Output

DeleteConsumableResource

Command API Reference / Input / Output

DeleteJobQueue

Command API Reference / Input / Output

DeleteSchedulingPolicy

Command API Reference / Input / Output

DeleteServiceEnvironment

Command API Reference / Input / Output

DeregisterJobDefinition

Command API Reference / Input / Output

DescribeComputeEnvironments

Command API Reference / Input / Output

DescribeConsumableResource

Command API Reference / Input / Output

DescribeJobDefinitions

Command API Reference / Input / Output

DescribeJobQueues

Command API Reference / Input / Output

DescribeJobs

Command API Reference / Input / Output

DescribeSchedulingPolicies

Command API Reference / Input / Output

DescribeServiceEnvironments

Command API Reference / Input / Output

DescribeServiceJob

Command API Reference / Input / Output

GetJobQueueSnapshot

Command API Reference / Input / Output

ListConsumableResources

Command API Reference / Input / Output

ListJobs

Command API Reference / Input / Output

ListJobsByConsumableResource

Command API Reference / Input / Output

ListSchedulingPolicies

Command API Reference / Input / Output

ListServiceJobs

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

RegisterJobDefinition

Command API Reference / Input / Output

SubmitJob

Command API Reference / Input / Output

SubmitServiceJob

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

TerminateJob

Command API Reference / Input / Output

TerminateServiceJob

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateComputeEnvironment

Command API Reference / Input / Output

UpdateConsumableResource

Command API Reference / Input / Output

UpdateJobQueue

Command API Reference / Input / Output

UpdateSchedulingPolicy

Command API Reference / Input / Output

UpdateServiceEnvironment

Command API Reference / Input / Output