@aws-sdk/client-databrew

Description

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

Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew
simplifies data preparation tasks, targeting data issues that are hard to spot and
time-consuming to fix. DataBrew empowers users of all technical levels to visualize the
data and perform one-click data transformations, with no coding required.

Installing

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

Getting Started

$3

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

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

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

$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 DataBrewClient({ 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-databrew";
const client = new AWS.DataBrew({ 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-databrew` 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)

BatchDeleteRecipeVersion

Command API Reference / Input / Output

CreateDataset

Command API Reference / Input / Output

CreateProfileJob

Command API Reference / Input / Output

CreateProject

Command API Reference / Input / Output

CreateRecipe

Command API Reference / Input / Output

CreateRecipeJob

Command API Reference / Input / Output

CreateRuleset

Command API Reference / Input / Output

CreateSchedule

Command API Reference / Input / Output

DeleteDataset

Command API Reference / Input / Output

DeleteJob

Command API Reference / Input / Output

DeleteProject

Command API Reference / Input / Output

DeleteRecipeVersion

Command API Reference / Input / Output

DeleteRuleset

Command API Reference / Input / Output

DeleteSchedule

Command API Reference / Input / Output

DescribeDataset

Command API Reference / Input / Output

DescribeJob

Command API Reference / Input / Output

DescribeJobRun

Command API Reference / Input / Output

DescribeProject

Command API Reference / Input / Output

DescribeRecipe

Command API Reference / Input / Output

DescribeRuleset

Command API Reference / Input / Output

DescribeSchedule

Command API Reference / Input / Output

ListDatasets

Command API Reference / Input / Output

ListJobRuns

Command API Reference / Input / Output

ListJobs

Command API Reference / Input / Output

ListProjects

Command API Reference / Input / Output

ListRecipes

Command API Reference / Input / Output

ListRecipeVersions

Command API Reference / Input / Output

ListRulesets

Command API Reference / Input / Output

ListSchedules

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

PublishRecipe

Command API Reference / Input / Output

SendProjectSessionAction

Command API Reference / Input / Output

StartJobRun

Command API Reference / Input / Output

StartProjectSession

Command API Reference / Input / Output

StopJobRun

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateDataset

Command API Reference / Input / Output

UpdateProfileJob

Command API Reference / Input / Output

UpdateProject

Command API Reference / Input / Output

UpdateRecipe

Command API Reference / Input / Output

UpdateRecipeJob

Command API Reference / Input / Output

UpdateRuleset

Command API Reference / Input / Output

UpdateSchedule

Command API Reference / Input / Output