Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.4/services/firehose.ts?docs=full";

§Classes

Firehose

§Interfaces

AmazonOpenSearchServerlessBufferingHints

Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.

AmazonOpenSearchServerlessDestinationConfiguration

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

AmazonOpenSearchServerlessDestinationDescription

The destination description in the Serverless offering for Amazon OpenSearch Service.

AmazonOpenSearchServerlessDestinationUpdate

Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.

AmazonOpenSearchServerlessRetryOptions

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.

AmazonopensearchserviceBufferingHints

Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.

AmazonopensearchserviceDestinationConfiguration

Describes the configuration of a destination in Amazon OpenSearch Service

AmazonopensearchserviceDestinationDescription

The destination description in Amazon OpenSearch Service.

AmazonopensearchserviceDestinationUpdate

Describes an update for a destination in Amazon OpenSearch Service.

AmazonopensearchserviceRetryOptions

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.

BufferingHints

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data Firehose might choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.

CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your delivery stream.

CopyCommand

Describes a COPY command for Amazon Redshift.

CreateDeliveryStreamInput
CreateDeliveryStreamOutput
DataFormatConversionConfiguration

Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the Amazon Web Services Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion.

DeleteDeliveryStreamInput
DeliveryStreamDescription

Contains information about a delivery stream.

DeliveryStreamEncryptionConfiguration

Contains information about the server-side encryption (SSE) status for the delivery stream, the type customer master key (CMK) in use, if any, and the ARN of the CMK. You can get DeliveryStreamEncryptionConfiguration by invoking the "DescribeDeliveryStream" operation.

DeliveryStreamEncryptionConfigurationInput

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

DescribeDeliveryStreamInput
DescribeDeliveryStreamOutput
Deserializer

The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON. Kinesis Data Firehose then serializes the data to its final format using the "Serializer". Kinesis Data Firehose supports two types of deserializers: the Apache Hive JSON SerDe and the OpenX JSON SerDe.

DestinationDescription

Describes the destination for a delivery stream.

DynamicPartitioningConfiguration

The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

ElasticsearchBufferingHints

Describes the buffering to perform before delivering data to the Amazon ES destination.

ElasticsearchDestinationConfiguration

Describes the configuration of a destination in Amazon ES.

ElasticsearchDestinationDescription

The destination description in Amazon ES.

ElasticsearchDestinationUpdate

Describes an update for a destination in Amazon ES.

ElasticsearchRetryOptions

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.

EncryptionConfiguration

Describes the encryption for a destination in Amazon S3.

ExtendedS3DestinationConfiguration

Describes the configuration of a destination in Amazon S3.

ExtendedS3DestinationDescription

Describes a destination in Amazon S3.

ExtendedS3DestinationUpdate

Describes an update for a destination in Amazon S3.

FailureDescription

Provides details in case one of the following operations fails due to an error related to KMS: "CreateDeliveryStream", "DeleteDeliveryStream", "StartDeliveryStreamEncryption", "StopDeliveryStreamEncryption".

HiveJsonSerDe

The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.

HttpEndpointBufferingHints

Describes the buffering options that can be applied before data is delivered to the HTTP endpoint destination. Kinesis Data Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.

HttpEndpointCommonAttribute

Describes the metadata that's delivered to the specified HTTP endpoint destination.

HttpEndpointConfiguration

Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.

HttpEndpointDescription

Describes the HTTP endpoint selected as the destination.

HttpEndpointDestinationConfiguration

Describes the configuration of the HTTP endpoint destination.

HttpEndpointDestinationDescription

Describes the HTTP endpoint destination.

HttpEndpointDestinationUpdate

Updates the specified HTTP endpoint destination.

HttpEndpointRequestConfiguration

The configuration of the HTTP endpoint request.

HttpEndpointRetryOptions

Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.

InputFormatConfiguration

Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if Enabled is set to true.

KinesisStreamSourceConfiguration

The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a delivery stream.

KinesisStreamSourceDescription

Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.

KMSEncryptionConfig

Describes an encryption key for a destination in Amazon S3.

ListDeliveryStreamsInput
ListDeliveryStreamsOutput
ListTagsForDeliveryStreamInput
ListTagsForDeliveryStreamOutput
OpenXJsonSerDe

The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.

OrcSerDe

A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.

OutputFormatConfiguration

Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.

ParquetSerDe

A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.

ProcessingConfiguration

Describes a data processing configuration.

Processor

Describes a data processor.

ProcessorParameter

Describes the processor parameter.

PutRecordBatchInput
PutRecordBatchOutput
PutRecordBatchResponseEntry

Contains the result for an individual record from a "PutRecordBatch" request. If the record is successfully added to your delivery stream, it receives a record ID. If the record fails to be added to your delivery stream, the result includes an error code and an error message.

PutRecordInput
PutRecordOutput
Record

The unit of data in a delivery stream.

RedshiftDestinationConfiguration

Describes the configuration of a destination in Amazon Redshift.

RedshiftDestinationDescription

Describes a destination in Amazon Redshift.

RedshiftDestinationUpdate

Describes an update for a destination in Amazon Redshift.

RedshiftRetryOptions

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.

RetryOptions

The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.

S3DestinationConfiguration

Describes the configuration of a destination in Amazon S3.

S3DestinationDescription

Describes a destination in Amazon S3.

S3DestinationUpdate

Describes an update for a destination in Amazon S3.

SchemaConfiguration

Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.

Serializer

The serializer that you want Kinesis Data Firehose to use to convert data to the target format before writing it to Amazon S3. Kinesis Data Firehose supports two types of serializers: the ORC SerDe and the Parquet SerDe.

SourceDescription

Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.

SplunkDestinationConfiguration

Describes the configuration of a destination in Splunk.

SplunkDestinationDescription

Describes a destination in Splunk.

SplunkDestinationUpdate

Describes an update for a destination in Splunk.

SplunkRetryOptions

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.

StartDeliveryStreamEncryptionInput
StopDeliveryStreamEncryptionInput
Tag

Metadata that you can assign to a delivery stream, consisting of a key-value pair.

TagDeliveryStreamInput
UntagDeliveryStreamInput
UpdateDestinationInput
VpcConfiguration

The details of the VPC of the Amazon ES destination.

VpcConfigurationDescription

The details of the VPC of the Amazon ES destination.

§Type Aliases

AmazonOpenSearchServerlessS3BackupMode
AmazonopensearchserviceIndexRotationPeriod
AmazonopensearchserviceS3BackupMode
CompressionFormat
ContentEncoding
DeliveryStreamEncryptionStatus
DeliveryStreamFailureType
DeliveryStreamStatus
DeliveryStreamType
ElasticsearchIndexRotationPeriod
ElasticsearchS3BackupMode
HECEndpointType
HttpEndpointS3BackupMode
KeyType
NoEncryptionConfig
OrcCompression
OrcFormatVersion
ParquetCompression
ParquetWriterVersion
ProcessorParameterName
ProcessorType
RedshiftS3BackupMode
S3BackupMode
SplunkS3BackupMode