@aws-sdk/client-firehose
Advanced tools
AWS SDK for JavaScript Firehose Client for Node.js, Browser and React Native
@aws-sdk/client-firehose is a part of the AWS SDK for JavaScript, which allows developers to interact with Amazon Kinesis Data Firehose. This service is used for reliably loading streaming data into data lakes, data stores, and analytics services. The package provides methods to create, manage, and delete delivery streams, as well as to send data to these streams.
Create Delivery Stream
This feature allows you to create a new delivery stream in Amazon Kinesis Data Firehose. The code sample demonstrates how to create a delivery stream with an S3 destination configuration.
const { FirehoseClient, CreateDeliveryStreamCommand } = require('@aws-sdk/client-firehose');
const client = new FirehoseClient({ region: 'us-west-2' });
const params = {
DeliveryStreamName: 'example-stream',
S3DestinationConfiguration: {
BucketARN: 'arn:aws:s3:::example-bucket',
RoleARN: 'arn:aws:iam::123456789012:role/firehose_delivery_role'
}
};
const run = async () => {
try {
const data = await client.send(new CreateDeliveryStreamCommand(params));
console.log('Delivery Stream Created', data);
} catch (err) {
console.error(err);
}
};
run();Put Record
This feature allows you to send a single data record to a delivery stream. The code sample demonstrates how to put a record into a specified delivery stream.
const { FirehoseClient, PutRecordCommand } = require('@aws-sdk/client-firehose');
const client = new FirehoseClient({ region: 'us-west-2' });
const params = {
DeliveryStreamName: 'example-stream',
Record: {
Data: Buffer.from('example data')
}
};
const run = async () => {
try {
const data = await client.send(new PutRecordCommand(params));
console.log('Record Sent', data);
} catch (err) {
console.error(err);
}
};
run();Delete Delivery Stream
This feature allows you to delete an existing delivery stream. The code sample demonstrates how to delete a specified delivery stream.
const { FirehoseClient, DeleteDeliveryStreamCommand } = require('@aws-sdk/client-firehose');
const client = new FirehoseClient({ region: 'us-west-2' });
const params = {
DeliveryStreamName: 'example-stream'
};
const run = async () => {
try {
const data = await client.send(new DeleteDeliveryStreamCommand(params));
console.log('Delivery Stream Deleted', data);
} catch (err) {
console.error(err);
}
};
run();@aws-sdk/client-kinesis is another package from the AWS SDK for JavaScript that allows you to interact with Amazon Kinesis Data Streams. While @aws-sdk/client-firehose is focused on loading streaming data into destinations like S3, Redshift, and Elasticsearch, @aws-sdk/client-kinesis is more focused on real-time processing of streaming data.
kinesis-client is a third-party package that provides a simplified interface for interacting with Amazon Kinesis Data Streams. It offers basic functionalities like putting records and getting records from streams. However, it lacks the comprehensive feature set and official support provided by the AWS SDK packages.
aws-sdk is the older, monolithic AWS SDK for JavaScript that includes support for all AWS services, including Kinesis Data Firehose. While it provides similar functionalities, the modular @aws-sdk/client-firehose package offers a more lightweight and modern approach, allowing developers to include only the specific services they need.
AWS SDK for JavaScript Firehose Client for Node.js, Browser and React Native.
Amazon Data Firehose
Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.
Amazon Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch Service, Amazon Redshift, Splunk, and various other supported destinations.
To install the this package, simply type add or install @aws-sdk/client-firehose using your favorite package manager:
npm install @aws-sdk/client-firehoseyarn add @aws-sdk/client-firehosepnpm add @aws-sdk/client-firehoseThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the FirehoseClient and
the commands you need, for example ListDeliveryStreamsCommand:
// ES5 example
const { FirehoseClient, ListDeliveryStreamsCommand } = require("@aws-sdk/client-firehose");
// ES6+ example
import { FirehoseClient, ListDeliveryStreamsCommand } from "@aws-sdk/client-firehose";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new FirehoseClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListDeliveryStreamsCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// 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.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
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
import * as AWS from "@aws-sdk/client-firehose";
const client = new AWS.Firehose({ region: "REGION" });
// async/await.
try {
const data = await client.listDeliveryStreams(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listDeliveryStreams(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listDeliveryStreams(params, (err, data) => {
// process err and data.
});
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 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;
* }
*/
}
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.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-firehose package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.621.0 (2024-07-30)
homepage links to use the main branch (#6336) (e332230)FAQs
AWS SDK for JavaScript Firehose Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-firehose receives a total of 585,034 weekly downloads. As such, @aws-sdk/client-firehose popularity was classified as popular.
We found that @aws-sdk/client-firehose demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.
Product
Socket now supports uv.lock files to ensure consistent, secure dependency resolution for Python projects and enhance supply chain security.
Research
Security News
Socket researchers have discovered multiple malicious npm packages targeting Solana private keys, abusing Gmail to exfiltrate the data and drain Solana wallets.