@aws-sdk/client-firehose

What is @aws-sdk/client-firehose?

@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.

What are @aws-sdk/client-firehose's main functionalities?

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();

Other packages similar to @aws-sdk/client-firehose

@aws-sdk/client-kinesis

@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

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

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.

README

@aws-sdk/client-firehose

For SDK usage, please step to SDK readme.

Changelog

1.0.0-rc.7 (2020-11-20)

Bug Fixes

• abort-controller: make AbortSignal WHATWG Spec compliant (#1699) (723ec4d)
• codegen: add aws-iam-traits dependency (#1686) (d6fb1f6)
• fetch-http-handler: omit body for HEAD/GET methods (#1698) (778b305)
• node-http-handler: throw TimeoutError for Node.js timeouts (#1693) (96f61bb)
• change paginators to export paginateOperationName (#1692) (6d02935)

Features

• update clients as of 11/18/2020 (#1700) (8adfed1)
• api-reference: add typedoc plugins for api reference (#1694) (2cb016f)
• ci: add GitHub Action to test codegen (#1684) (41e9359)
• node-http-handler: update timeout code and tests (#1691) (9e58bbb)
• service-error-classification: add 429 response as Throttling (#1690) (9a62c0a)

BREAKING CHANGES

• change paginators to export paginateOperationName to be consistent with verb nouns across AWS