This package has been deprecated

Author message:

The package @aws-sdk/client-data-pipeline-node has been renamed to @aws-sdk/client-data-pipeline. Please install the renamed package.

@aws-sdk/client-data-pipeline-node

Description

AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so that your application can focus on processing the data.

AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management.

AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data. Use the second set in your task runner application to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service.

Installing

To install the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-data-pipeline-node

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(DataPipelineClient) and the commands you need, for example ActivatePipelineCommand:

//JavaScript
const {
  DataPipelineClient
} = require("@aws-sdk/client-data-pipeline-node/DataPipelineClient");
const {
  ActivatePipelineCommand
} = require("@aws-sdk/client-data-pipeline-node/commands/ActivatePipelineCommand");

//TypeScript
import { DataPipelineClient } from "@aws-sdk/client-data-pipeline-node/DataPipelineClient";
import { ActivatePipelineCommand } from "@aws-sdk/client-data-pipeline-node/commands/ActivatePipelineCommand";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
• 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.

const dataPipeline = new DataPipelineClient({region: 'region'});
//clients can be shared by different commands
const params = {
  pipelineId: /**a string value*/,
};
const activatePipelineCommand = new ActivatePipelineCommand(params);
dataPipeline.send(activatePipelineCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await dataPipeline.send(activatePipelineCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
dataPipeline.send(activatePipelineCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-data-pipeline-node/DataPipeline";
const dataPipeline = new AWS.DataPipeline({ region: "region" });
dataPipeline.activatePipeline(params, (err, data) => {
  //do something
});

Troubleshooting

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

try {
  const data = await dataPipeline.send(activatePipelineCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.

• Ask a question on StackOverflow and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-data-pipeline-node' package is updated. To contribute to SDK you can checkout our code generator package.

License

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