AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class BufferingHints

Describes hints for the buffering to perform before delivering data to the destination. Please note that these options are treated as hints, and therefore Kinesis Firehose may choose to use different values when it is optimal.

Class CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your delivery stream.

Class ConcurrentModificationException

KinesisFirehose exception

Class CopyCommand

Describes a COPY command for Amazon Redshift.

Class CreateDeliveryStreamRequest

Container for the parameters to the CreateDeliveryStream operation. Creates a delivery stream.

By default, you can create up to 20 delivery streams per region.

This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream.

A Kinesis Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream ARN and role ARN in the KinesisStreamSourceConfiguration parameter.

A delivery stream is configured with a single destination: Amazon S3, Amazon ES, or Amazon Redshift. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, or RedshiftDestinationConfiguration.

When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. Note that BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly; for example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.

A few notes about Amazon Redshift as a destination:

  • An Amazon Redshift destination requires an S3 bucket as intermediate location, as Kinesis Firehose first delivers data to S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter.

  • The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

  • We strongly recommend that you use the user name and password you provide exclusively with Kinesis Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions.

Kinesis Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Amazon S3 Bucket Access in the Amazon Kinesis Firehose Developer Guide.

Class CreateDeliveryStreamResponse

This is the response object from the CreateDeliveryStream operation.

Class DeleteDeliveryStreamRequest

Container for the parameters to the DeleteDeliveryStream operation. Deletes a delivery stream and its data.

You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state.

To check the state of a delivery stream, use DescribeDeliveryStream.

While the delivery stream is DELETING state, the service may continue to accept the records, but the service doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.

Class DeleteDeliveryStreamResponse

This is the response object from the DeleteDeliveryStream operation.

Class DeliveryStreamDescription

Contains information about a delivery stream.

Class DescribeDeliveryStreamRequest

Container for the parameters to the DescribeDeliveryStream operation. Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call DescribeDeliveryStream to see if the delivery stream is ACTIVE and therefore ready for data to be sent to it.

Class DescribeDeliveryStreamResponse

This is the response object from the DescribeDeliveryStream operation.

Class DestinationDescription

Describes the destination for a delivery stream.

Class ElasticsearchBufferingHints

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

Class ElasticsearchDestinationConfiguration

Describes the configuration of a destination in Amazon ES.

Class ElasticsearchDestinationDescription

The destination description in Amazon ES.

Class ElasticsearchDestinationUpdate

Describes an update for a destination in Amazon ES.

Class ElasticsearchRetryOptions

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

Class EncryptionConfiguration

Describes the encryption for a destination in Amazon S3.

Class ExtendedS3DestinationConfiguration

Describes the configuration of a destination in Amazon S3.

Class ExtendedS3DestinationDescription

Describes a destination in Amazon S3.

Class ExtendedS3DestinationUpdate

Describes an update for a destination in Amazon S3.

Class InvalidArgumentException

KinesisFirehose exception

Class KinesisStreamSourceConfiguration

The stream and role ARNs for a Kinesis stream used as the source for a delivery stream.

Class KinesisStreamSourceDescription

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

Class KMSEncryptionConfig

Describes an encryption key for a destination in Amazon S3.

Class LimitExceededException

KinesisFirehose exception

Class ListDeliveryStreamsRequest

Container for the parameters to the ListDeliveryStreams operation. Lists your delivery streams.

The number of delivery streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more delivery streams to list, you can request them by specifying the name of the last delivery stream returned in the call in the ExclusiveStartDeliveryStreamName parameter of a subsequent call.

Class ListDeliveryStreamsResponse

This is the response object from the ListDeliveryStreams operation.

Class ProcessingConfiguration

Describes a data processing configuration.

Class Processor

Describes a data processor.

Class ProcessorParameter

Describes the processor parameter.

Class PutRecordBatchRequest

Container for the parameters to the PutRecordBatch operation. Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers.

By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see Amazon Kinesis Firehose Limits.

Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could be a segment from a log file, geographic location data, web site clickstream data, and so on.

Kinesis Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.

The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Each entry in the RequestResponses array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Kinesis Firehose attempts to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records.

A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailable or InternalFailure. ErrorMessage provides more detailed information about the error.

If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.

If PutRecordBatch throws ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.

Data records sent to Kinesis Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.

Class PutRecordBatchResponse

This is the response object from the PutRecordBatch operation.

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

Class PutRecordRequest

Container for the parameters to the PutRecord operation. Writes a single data record into an Amazon Kinesis Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers.

By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Firehose Limits.

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, website clickstream data, and so on.

Kinesis Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.

The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.

If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.

Data records sent to Kinesis Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.

Class PutRecordResponse

This is the response object from the PutRecord operation.

Class Record

The unit of data in a delivery stream.

Class RedshiftDestinationConfiguration

Describes the configuration of a destination in Amazon Redshift.

Class RedshiftDestinationDescription

Describes a destination in Amazon Redshift.

Class RedshiftDestinationUpdate

Describes an update for a destination in Amazon Redshift.

Class RedshiftRetryOptions

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

Class ResourceInUseException

KinesisFirehose exception

Class ResourceNotFoundException

KinesisFirehose exception

Class S3DestinationConfiguration

Describes the configuration of a destination in Amazon S3.

Class S3DestinationDescription

Describes a destination in Amazon S3.

Class S3DestinationUpdate

Describes an update for a destination in Amazon S3.

Class ServiceUnavailableException

KinesisFirehose exception

Class SourceDescription

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

Class SplunkDestinationConfiguration

Describes the configuration of a destination in Splunk.

Class SplunkDestinationDescription

Describes a destination in Splunk.

Class SplunkDestinationUpdate

Describes an update for a destination in Splunk.

Class SplunkRetryOptions

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

Class UpdateDestinationRequest

Container for the parameters to the UpdateDestination operation. Updates the specified destination of the specified delivery stream.

You can use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.

Note that switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.

If the destination type is the same, Kinesis Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination.

If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Firehose does not merge any parameters. In this case, all parameters must be specified.

Kinesis Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.

Class UpdateDestinationResponse

This is the response object from the UpdateDestination operation.