272 lines
11 KiB
Markdown
272 lines
11 KiB
Markdown
<!-- generated file, do not edit directly -->
|
|
|
|
# @aws-sdk/client-firehose
|
|
|
|
## Description
|
|
|
|
AWS SDK for JavaScript Firehose Client for Node.js, Browser and React Native.
|
|
|
|
<fullname>Amazon Data Firehose</fullname>
|
|
<note>
|
|
<p>Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.</p>
|
|
</note>
|
|
<p>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.</p>
|
|
|
|
## Installing
|
|
|
|
To install this package, use the CLI of your favorite package manager:
|
|
|
|
- `npm install @aws-sdk/client-firehose`
|
|
- `yarn add @aws-sdk/client-firehose`
|
|
- `pnpm add @aws-sdk/client-firehose`
|
|
|
|
## Getting Started
|
|
|
|
### Import
|
|
|
|
The 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`:
|
|
|
|
```js
|
|
// ES5 example
|
|
const { FirehoseClient, ListDeliveryStreamsCommand } = require("@aws-sdk/client-firehose");
|
|
```
|
|
|
|
```ts
|
|
// ES6+ example
|
|
import { FirehoseClient, ListDeliveryStreamsCommand } from "@aws-sdk/client-firehose";
|
|
```
|
|
|
|
### Usage
|
|
|
|
To send a request:
|
|
|
|
- Instantiate a client with configuration (e.g. credentials, region).
|
|
- See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
|
|
- See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
|
|
- Instantiate a command with input parameters.
|
|
- Call the `send` operation on the client, providing the command object as input.
|
|
|
|
```js
|
|
const client = new FirehoseClient({ region: "REGION" });
|
|
|
|
const params = { /** input parameters */ };
|
|
const command = new ListDeliveryStreamsCommand(params);
|
|
```
|
|
|
|
#### Async/await
|
|
|
|
We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/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.
|
|
}
|
|
```
|
|
|
|
#### Promises
|
|
|
|
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
|
|
|
|
```js
|
|
client
|
|
.send(command)
|
|
.then((data) => {
|
|
// process data.
|
|
})
|
|
.catch((error) => {
|
|
// error handling.
|
|
})
|
|
.finally(() => {
|
|
// finally.
|
|
});
|
|
```
|
|
|
|
#### Aggregated client
|
|
|
|
The aggregated client class is exported from the same package, but without the "Client" suffix.
|
|
|
|
`Firehose` extends `FirehoseClient` and additionally supports all operations, waiters, and paginators as methods.
|
|
This style may be familiar to you from the AWS SDK for JavaScript v2.
|
|
|
|
If you are bundling the AWS SDK, we recommend using only the bare-bones client (`FirehoseClient`).
|
|
More details are in the blog post on
|
|
[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
|
|
|
|
```ts
|
|
import { Firehose } from "@aws-sdk/client-firehose";
|
|
|
|
const client = new 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 (not recommended).
|
|
client.listDeliveryStreams(params, (err, data) => {
|
|
// process err and data.
|
|
});
|
|
```
|
|
|
|
### Troubleshooting
|
|
|
|
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;
|
|
* }
|
|
*/
|
|
}
|
|
```
|
|
|
|
See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
|
|
|
|
## Getting Help
|
|
|
|
Please use these community resources for getting help.
|
|
We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
|
|
|
|
- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
|
|
- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
|
|
on AWS Developer Blog.
|
|
- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`.
|
|
- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3).
|
|
- 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).
|
|
|
|
To test your universal JavaScript code in Node.js, browser and react-native environments,
|
|
visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).
|
|
|
|
## Contributing
|
|
|
|
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](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).
|
|
|
|
## License
|
|
|
|
This SDK is distributed under the
|
|
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
|
|
see LICENSE for more information.
|
|
|
|
## Client Commands (Operations List)
|
|
|
|
<details>
|
|
<summary>
|
|
CreateDeliveryStream
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/firehose/command/CreateDeliveryStreamCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/CreateDeliveryStreamCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/CreateDeliveryStreamCommandOutput/)
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
DeleteDeliveryStream
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/firehose/command/DeleteDeliveryStreamCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/DeleteDeliveryStreamCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/DeleteDeliveryStreamCommandOutput/)
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
DescribeDeliveryStream
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/firehose/command/DescribeDeliveryStreamCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/DescribeDeliveryStreamCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/DescribeDeliveryStreamCommandOutput/)
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
ListDeliveryStreams
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/firehose/command/ListDeliveryStreamsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/ListDeliveryStreamsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/ListDeliveryStreamsCommandOutput/)
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
ListTagsForDeliveryStream
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/firehose/command/ListTagsForDeliveryStreamCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/ListTagsForDeliveryStreamCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/ListTagsForDeliveryStreamCommandOutput/)
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
PutRecord
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/firehose/command/PutRecordCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/PutRecordCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/PutRecordCommandOutput/)
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
PutRecordBatch
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/firehose/command/PutRecordBatchCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/PutRecordBatchCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/PutRecordBatchCommandOutput/)
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
StartDeliveryStreamEncryption
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/firehose/command/StartDeliveryStreamEncryptionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/StartDeliveryStreamEncryptionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/StartDeliveryStreamEncryptionCommandOutput/)
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
StopDeliveryStreamEncryption
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/firehose/command/StopDeliveryStreamEncryptionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/StopDeliveryStreamEncryptionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/StopDeliveryStreamEncryptionCommandOutput/)
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
TagDeliveryStream
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/firehose/command/TagDeliveryStreamCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/TagDeliveryStreamCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/TagDeliveryStreamCommandOutput/)
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
UntagDeliveryStream
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/firehose/command/UntagDeliveryStreamCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/UntagDeliveryStreamCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/UntagDeliveryStreamCommandOutput/)
|
|
</details>
|
|
<details>
|
|
<summary>
|
|
UpdateDestination
|
|
</summary>
|
|
|
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/firehose/command/UpdateDestinationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/UpdateDestinationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-firehose/Interface/UpdateDestinationCommandOutput/)
|
|
</details>
|