Имя | Описание |
---|---|
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 Firehose may choose to use different values when it is optimal. |
CloudWatchLoggingOptions | Describes the CloudWatch logging options for your delivery stream. |
ConcurrentModificationException | |
CopyCommand | Describes a COPY command for Amazon Redshift. |
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 A delivery stream is configured with a single destination: Amazon S3, Amazon Elasticsearch Service, 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, 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:
Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Firehose principal to assume the role, and the role should have permissions that allows the service to deliver the data. For more information, see Amazon S3 Bucket Access in the Amazon Kinesis Firehose Developer Guide. |
CreateDeliveryStreamResponse | This is the response object from the CreateDeliveryStream operation. |
DeliveryStreamDescription | Contains information about a delivery stream. |
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. |
DescribeDeliveryStreamResponse | This is the response object from the DescribeDeliveryStream operation. |
DestinationDescription | Describes the destination for a delivery stream. |
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 the event that Firehose is unable to deliver documents to Amazon ES. |
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. |
InvalidArgumentException | |
LimitExceededException | |
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. |
ListDeliveryStreamsResponse | This is the response object from the ListDeliveryStreams operation. |
ProcessingConfiguration | Describes a data processing configuration. |
Processor | Describes a data processor. |
ProcessorParameter | Describes the processor parameter. |
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. 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, 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, a segment from a log file, geographic location data, web site clickstream data, and so on. 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 ( 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, and 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. 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: 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 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. |
PutRecordBatchResponse | This is the response object from the PutRecordBatch operation. |
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, web site clickstream data, etc. 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 ( 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 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. |
PutRecordResponse | This is the response object from the PutRecord operation. |
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 the event that Firehose is unable to deliver documents to Amazon Redshift. |
ResourceNotFoundException | |
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. |
ServiceUnavailableException | |
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, 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, Firehose does not merge any parameters. In this case, all parameters must be specified. 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. You should use the new version ID to set CurrentDeliveryStreamVersionId in the next call. |