AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline\nhandles the details of scheduling and ensuring that data dependencies are met so that your application\ncan focus on processing the data.
\n\nAWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner.\nAWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing\ndatabase queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use\nAWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide\ncustom data management.
\n\nAWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline\nand define data sources, schedules, dependencies, and the transforms to be performed on the data.\nUse the second set in your task runner application to receive the next task ready for processing.\nThe logic for performing the task, such as querying the data, running data analysis, or converting\nthe data from one format to another, is contained within the task runner. The task runner performs\nthe task assigned to it by the web service, reporting progress to the web service as it does so.\nWhen the task is done, the task runner reports the final success or failure of the task to the web service.
\n\n## Installing\n\nTo install this package, use the CLI of your favorite package manager:\n\n- `npm install @aws-sdk/client-data-pipeline`\n- `yarn add @aws-sdk/client-data-pipeline`\n- `pnpm add @aws-sdk/client-data-pipeline`\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands.\nTo send a request, you only need to import the `DataPipelineClient` and\nthe commands you need, for example `ListPipelinesCommand`:\n\n```js\n// ES5 example\nconst { DataPipelineClient, ListPipelinesCommand } = require(\"@aws-sdk/client-data-pipeline\");\n```\n\n```ts\n// ES6+ example\nimport { DataPipelineClient, ListPipelinesCommand } from \"@aws-sdk/client-data-pipeline\";\n```\n\n### Usage\n\nTo send a request:\n\n- Instantiate a client with configuration (e.g. credentials, region).\n - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.\n - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.\n- Instantiate a command with input parameters.\n- Call the `send` operation on the client, providing the command object as input.\n\n```js\nconst client = new DataPipelineClient({ region: \"REGION\" });\n\nconst params = { /** input parameters */ };\nconst command = new ListPipelinesCommand(params);\n```\n\n#### Async/await\n\nWe recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)\noperator to wait for the promise returned by send operation as follows:\n\n```js\n// async/await.\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n // error handling.\n} finally {\n // finally.\n}\n```\n\n#### Promises\n\nYou can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).\n\n```js\nclient\n .send(command)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n })\n .finally(() => {\n // finally.\n });\n```\n\n#### Aggregated client\n\nThe aggregated client class is exported from the same package, but without the \"Client\" suffix.\n\n`DataPipeline` extends `DataPipelineClient` and additionally supports all operations, waiters, and paginators as methods.\nThis style may be familiar to you from the AWS SDK for JavaScript v2.\n\nIf you are bundling the AWS SDK, we recommend using only the bare-bones client (`DataPipelineClient`).\nMore details are in the blog post on\n[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).\n\n```ts\nimport { DataPipeline } from \"@aws-sdk/client-data-pipeline\";\n\nconst client = new DataPipeline({ region: \"REGION\" });\n\n// async/await.\ntry {\n const data = await client.listPipelines(params);\n // process data.\n} catch (error) {\n // error handling.\n}\n\n// Promises.\nclient\n .listPipelines(params)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n });\n\n// callbacks (not recommended).\nclient.listPipelines(params, (err, data) => {\n // process err and data.\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information,\nas well as response metadata (e.g. request id).\n\n```js\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n const { requestId, cfId, extendedRequestId } = error.$metadata;\n console.log({ requestId, cfId, extendedRequestId });\n /**\n * The keys within exceptions are also parsed.\n * You can access them by specifying exception names:\n * if (error.name === 'SomeServiceException') {\n * const value = error.specialKeyInException;\n * }\n */\n}\n```\n\nSee also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).\n\n## Getting Help\n\nPlease use these community resources for getting help.\nWe use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.\n\n- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)\n or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).\n- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)\n on AWS Developer Blog.\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`.\n- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3).\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose).\n\nTo test your universal JavaScript code in Node.js, browser and react-native environments,\nvisit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-data-pipeline` package is updated.\nTo contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n## Client Commands (Operations List)\n\n