Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
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. 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, and so on.
Amazon 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(s) to parse individual data items when reading the data from the destination.
The PutRecordBatch response includes a count of any failed records,
FailedPutCount
, and an array of responses, RequestResponses
. The
FailedPutCount
value is a count of records that failed. Each entry in
the RequestResponses
array gives additional information of the
processed record. Each entry in RequestResponses
directly correlates
with a record in the request array using the same ordering, from the top
to the bottom of the request and response. RequestResponses
always
includes the same number of records as the request array.
RequestResponses
both successfully and unsuccessfully processed
records. Amazon 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 a
unique value identified 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 FailedPutCount
is greater than 0 (zero), retry the request. A retry
of the entire batch of records is possible; however, we strongly
recommend that you inspect the entire response and resend only those
records that failed processing. This minimizes duplicate records and
also reduces the total bytes sent (and corresponding charges).
If the PutRecordBatch 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 Amazon 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.
See: AWS API Reference for PutRecordBatch.
- putRecordBatch :: Text -> NonEmpty Record -> PutRecordBatch
- data PutRecordBatch
- prbDeliveryStreamName :: Lens' PutRecordBatch Text
- prbRecords :: Lens' PutRecordBatch (NonEmpty Record)
- putRecordBatchResponse :: Int -> Natural -> NonEmpty PutRecordBatchResponseEntry -> PutRecordBatchResponse
- data PutRecordBatchResponse
- prbrsResponseStatus :: Lens' PutRecordBatchResponse Int
- prbrsFailedPutCount :: Lens' PutRecordBatchResponse Natural
- prbrsRequestResponses :: Lens' PutRecordBatchResponse (NonEmpty PutRecordBatchResponseEntry)
Creating a Request
Creates a value of PutRecordBatch
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data PutRecordBatch Source
Contains the parameters for PutRecordBatch.
See: putRecordBatch
smart constructor.
Request Lenses
prbDeliveryStreamName :: Lens' PutRecordBatch Text Source
The name of the delivery stream.
prbRecords :: Lens' PutRecordBatch (NonEmpty Record) Source
One or more records.
Destructuring the Response
Creates a value of PutRecordBatchResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data PutRecordBatchResponse Source
Contains the output of PutRecordBatch.
See: putRecordBatchResponse
smart constructor.
Response Lenses
prbrsResponseStatus :: Lens' PutRecordBatchResponse Int Source
The response status code.
prbrsFailedPutCount :: Lens' PutRecordBatchResponse Natural Source
The number of unsuccessfully written records.
prbrsRequestResponses :: Lens' PutRecordBatchResponse (NonEmpty PutRecordBatchResponseEntry) Source
The results for the individual records. The index of each element matches the same index in which records were sent.