Navigation Guide
You are on the package index page for the Client of a service. Return to the Client landing page

@aws-sdk/client-firehose

Description

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.

Installation

NPM

npm install @aws-sdk/client-firehose

Yarn

yarn add @aws-sdk/client-firehose

pnpm

pnpm add @aws-sdk/client-firehose

Types

Type Name	Type
_Record	Interface
AmazonOpenSearchServerlessBufferingHints	Interface
AmazonOpenSearchServerlessDestinationConfiguration	Interface
AmazonOpenSearchServerlessDestinationDescription	Interface
AmazonOpenSearchServerlessDestinationUpdate	Interface
AmazonOpenSearchServerlessRetryOptions	Interface
AmazonOpenSearchServerlessS3BackupMode	TypeAlias
AmazonOpenSearchServerlessS3BackupModeenum	Variable
AmazonopensearchserviceBufferingHints	Interface
AmazonopensearchserviceDestinationConfiguration	Interface
AmazonopensearchserviceDestinationDescription	Interface
AmazonopensearchserviceDestinationUpdate	Interface
AmazonopensearchserviceIndexRotationPeriod	TypeAlias
AmazonopensearchserviceIndexRotationPeriodenum	Variable
AmazonopensearchserviceRetryOptions	Interface
AmazonopensearchserviceS3BackupMode	TypeAlias
AmazonopensearchserviceS3BackupModeenum	Variable
AuthenticationConfiguration	Interface
BufferingHints	Interface
CatalogConfiguration	Interface
ClientDefaults	Interface
ClientInputEndpointParameters	Interface
CloudWatchLoggingOptions	Interface
CompressionFormat	TypeAlias
CompressionFormatenum	Variable
ConcurrentModificationException	Class
Connectivity	TypeAlias
Connectivityenum	Variable
ContentEncoding	TypeAlias
ContentEncodingenum	Variable
CopyCommand	Interface
CreateDeliveryStreamCommand	Class
CreateDeliveryStreamCommandInput	Interface
CreateDeliveryStreamCommandOutput	Interface
CreateDeliveryStreamInput	Interface
CreateDeliveryStreamOutput	Interface
DatabaseColumnList	Interface
DatabaseList	Interface
DatabaseSnapshotInfo	Interface
DatabaseSourceAuthenticationConfiguration	Interface
DatabaseSourceConfiguration	Interface
DatabaseSourceDescription	Interface
DatabaseSourceVPCConfiguration	Interface
DatabaseTableList	Interface
DatabaseType	TypeAlias
DatabaseTypeenum	Variable
DataFormatConversionConfiguration	Interface
DefaultDocumentIdFormat	TypeAlias
DefaultDocumentIdFormatenum	Variable
DeleteDeliveryStreamCommand	Class
DeleteDeliveryStreamCommandInput	Interface
DeleteDeliveryStreamCommandOutput	Interface
DeleteDeliveryStreamInput	Interface
DeleteDeliveryStreamOutput	Interface
DeliveryStreamDescription	Interface
DeliveryStreamEncryptionConfiguration	Interface
DeliveryStreamEncryptionConfigurationInput	Interface
DeliveryStreamEncryptionStatus	TypeAlias
DeliveryStreamEncryptionStatusenum	Variable
DeliveryStreamFailureType	TypeAlias
DeliveryStreamFailureTypeenum	Variable
DeliveryStreamStatus	TypeAlias
DeliveryStreamStatusenum	Variable
DeliveryStreamType	TypeAlias
DeliveryStreamTypeenum	Variable
DescribeDeliveryStreamCommand	Class
DescribeDeliveryStreamCommandInput	Interface
DescribeDeliveryStreamCommandOutput	Interface
DescribeDeliveryStreamInput	Interface
DescribeDeliveryStreamOutput	Interface
Deserializer	Interface
DestinationDescription	Interface
DestinationTableConfiguration	Interface
DirectPutSourceConfiguration	Interface
DirectPutSourceDescription	Interface
DocumentIdOptions	Interface
DynamicPartitioningConfiguration	Interface
ElasticsearchBufferingHints	Interface
ElasticsearchDestinationConfiguration	Interface
ElasticsearchDestinationDescription	Interface
ElasticsearchDestinationUpdate	Interface
ElasticsearchIndexRotationPeriod	TypeAlias
ElasticsearchIndexRotationPeriodenum	Variable
ElasticsearchRetryOptions	Interface
ElasticsearchS3BackupMode	TypeAlias
ElasticsearchS3BackupModeenum	Variable
EncryptionConfiguration	Interface
ExtendedS3DestinationConfiguration	Interface
ExtendedS3DestinationDescription	Interface
ExtendedS3DestinationUpdate	Interface
FailureDescription	Interface
Firehose	Class
Firehose	Interface
FirehoseClient	Class
FirehoseClientConfig	Interface
FirehoseClientConfigType	TypeAlias
FirehoseClientResolvedConfig	Interface
FirehoseClientResolvedConfigType	TypeAlias
FirehoseServiceException	Class
HECEndpointType	TypeAlias
HECEndpointTypeenum	Variable
HiveJsonSerDe	Interface
HttpEndpointBufferingHints	Interface
HttpEndpointCommonAttribute	Interface
HttpEndpointConfiguration	Interface
HttpEndpointDescription	Interface
HttpEndpointDestinationConfiguration	Interface
HttpEndpointDestinationDescription	Interface
HttpEndpointDestinationUpdate	Interface
HttpEndpointRequestConfiguration	Interface
HttpEndpointRetryOptions	Interface
HttpEndpointS3BackupMode	TypeAlias
HttpEndpointS3BackupModeenum	Variable
IcebergDestinationConfiguration	Interface
IcebergDestinationDescription	Interface
IcebergDestinationUpdate	Interface
IcebergS3BackupMode	TypeAlias
IcebergS3BackupModeenum	Variable
InputFormatConfiguration	Interface
InvalidArgumentException	Class
InvalidKMSResourceException	Class
InvalidSourceException	Class
KeyType	TypeAlias
KeyTypeenum	Variable
KinesisStreamSourceConfiguration	Interface
KinesisStreamSourceDescription	Interface
KMSEncryptionConfig	Interface
LimitExceededException	Class
ListDeliveryStreamsCommand	Class
ListDeliveryStreamsCommandInput	Interface
ListDeliveryStreamsCommandOutput	Interface
ListDeliveryStreamsInput	Interface
ListDeliveryStreamsOutput	Interface
ListTagsForDeliveryStreamCommand	Class
ListTagsForDeliveryStreamCommandInput	Interface
ListTagsForDeliveryStreamCommandOutput	Interface
ListTagsForDeliveryStreamInput	Interface
ListTagsForDeliveryStreamOutput	Interface
MSKSourceConfiguration	Interface
MSKSourceDescription	Interface
NoEncryptionConfig	TypeAlias
NoEncryptionConfigenum	Variable
OpenXJsonSerDe	Interface
OrcCompression	TypeAlias
OrcCompressionenum	Variable
OrcFormatVersion	TypeAlias
OrcFormatVersionenum	Variable
OrcSerDe	Interface
OutputFormatConfiguration	Interface
ParquetCompression	TypeAlias
ParquetCompressionenum	Variable
ParquetSerDe	Interface
ParquetWriterVersion	TypeAlias
ParquetWriterVersionenum	Variable
PartitionField	Interface
PartitionSpec	Interface
ProcessingConfiguration	Interface
Processor	Interface
ProcessorParameter	Interface
ProcessorParameterName	TypeAlias
ProcessorParameterNameenum	Variable
ProcessorType	TypeAlias
ProcessorTypeenum	Variable
PutRecordBatchCommand	Class
PutRecordBatchCommandInput	Interface
PutRecordBatchCommandOutput	Interface
PutRecordBatchInput	Interface
PutRecordBatchOutput	Interface
PutRecordBatchResponseEntry	Interface
PutRecordCommand	Class
PutRecordCommandInput	Interface
PutRecordCommandOutput	Interface
PutRecordInput	Interface
PutRecordOutput	Interface
RedshiftDestinationConfiguration	Interface
RedshiftDestinationDescription	Interface
RedshiftDestinationUpdate	Interface
RedshiftRetryOptions	Interface
RedshiftS3BackupMode	TypeAlias
RedshiftS3BackupModeenum	Variable
ResourceInUseException	Class
ResourceNotFoundException	Class
RetryOptions	Interface
RuntimeExtension	Interface
S3BackupMode	TypeAlias
S3BackupModeenum	Variable
S3DestinationConfiguration	Interface
S3DestinationDescription	Interface
S3DestinationUpdate	Interface
SchemaConfiguration	Interface
SchemaEvolutionConfiguration	Interface
SecretsManagerConfiguration	Interface
Serializer	Interface
ServiceInputTypes	TypeAlias
ServiceOutputTypes	TypeAlias
ServiceUnavailableException	Class
SnapshotRequestedBy	TypeAlias
SnapshotRequestedByenum	Variable
SnapshotStatus	TypeAlias
SnapshotStatusenum	Variable
SnowflakeBufferingHints	Interface
SnowflakeDataLoadingOption	TypeAlias
SnowflakeDataLoadingOptionenum	Variable
SnowflakeDestinationConfiguration	Interface
SnowflakeDestinationDescription	Interface
SnowflakeDestinationUpdate	Interface
SnowflakeRetryOptions	Interface
SnowflakeRoleConfiguration	Interface
SnowflakeS3BackupMode	TypeAlias
SnowflakeS3BackupModeenum	Variable
SnowflakeVpcConfiguration	Interface
SourceDescription	Interface
SplunkBufferingHints	Interface
SplunkDestinationConfiguration	Interface
SplunkDestinationDescription	Interface
SplunkDestinationUpdate	Interface
SplunkRetryOptions	Interface
SplunkS3BackupMode	TypeAlias
SplunkS3BackupModeenum	Variable
SSLMode	TypeAlias
SSLModeenum	Variable
StartDeliveryStreamEncryptionCommand	Class
StartDeliveryStreamEncryptionCommandInput	Interface
StartDeliveryStreamEncryptionCommandOutput	Interface
StartDeliveryStreamEncryptionInput	Interface
StartDeliveryStreamEncryptionOutput	Interface
StopDeliveryStreamEncryptionCommand	Class
StopDeliveryStreamEncryptionCommandInput	Interface
StopDeliveryStreamEncryptionCommandOutput	Interface
StopDeliveryStreamEncryptionInput	Interface
StopDeliveryStreamEncryptionOutput	Interface
TableCreationConfiguration	Interface
Tag	Interface
TagDeliveryStreamCommand	Class
TagDeliveryStreamCommandInput	Interface
TagDeliveryStreamCommandOutput	Interface
TagDeliveryStreamInput	Interface
TagDeliveryStreamOutput	Interface
UntagDeliveryStreamCommand	Class
UntagDeliveryStreamCommandInput	Interface
UntagDeliveryStreamCommandOutput	Interface
UntagDeliveryStreamInput	Interface
UntagDeliveryStreamOutput	Interface
UpdateDestinationCommand	Class
UpdateDestinationCommandInput	Interface
UpdateDestinationCommandOutput	Interface
UpdateDestinationInput	Interface
UpdateDestinationOutput	Interface
VpcConfiguration	Interface
VpcConfigurationDescription	Interface

Getting Started

References

@aws-sdk/client-firehose

Description

Installation

Types