amazonka-kinesis-firehose-1.6.1: Amazon Kinesis Firehose SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Firehose.PutRecordBatch

Contents

Description

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 Data 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, website clickstream data, and so on.

Kinesis Data 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 Data Firehose tries 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 Data 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.

Synopsis

Creating a Request

putRecordBatch Source #

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 #

See: putRecordBatch smart constructor.

Instances
Eq PutRecordBatch Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

Data PutRecordBatch Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutRecordBatch -> c PutRecordBatch #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutRecordBatch #

toConstr :: PutRecordBatch -> Constr #

dataTypeOf :: PutRecordBatch -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PutRecordBatch) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutRecordBatch) #

gmapT :: (forall b. Data b => b -> b) -> PutRecordBatch -> PutRecordBatch #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutRecordBatch -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutRecordBatch -> r #

gmapQ :: (forall d. Data d => d -> u) -> PutRecordBatch -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutRecordBatch -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutRecordBatch -> m PutRecordBatch #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutRecordBatch -> m PutRecordBatch #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutRecordBatch -> m PutRecordBatch #

Read PutRecordBatch Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

Show PutRecordBatch Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

Generic PutRecordBatch Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

Associated Types

type Rep PutRecordBatch :: Type -> Type #

Hashable PutRecordBatch Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

ToJSON PutRecordBatch Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

AWSRequest PutRecordBatch Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

Associated Types

type Rs PutRecordBatch :: Type #

ToHeaders PutRecordBatch Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

ToPath PutRecordBatch Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

ToQuery PutRecordBatch Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

NFData PutRecordBatch Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

Methods

rnf :: PutRecordBatch -> () #

type Rep PutRecordBatch Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

type Rep PutRecordBatch = D1 (MetaData "PutRecordBatch" "Network.AWS.Firehose.PutRecordBatch" "amazonka-kinesis-firehose-1.6.1-IIrhAXaawLd9hcHz2LzLHx" False) (C1 (MetaCons "PutRecordBatch'" PrefixI True) (S1 (MetaSel (Just "_prbDeliveryStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_prbRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (List1 Record))))
type Rs PutRecordBatch Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

Request Lenses

prbDeliveryStreamName :: Lens' PutRecordBatch Text Source #

The name of the delivery stream.

Destructuring the Response

putRecordBatchResponse Source #

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 #

See: putRecordBatchResponse smart constructor.

Instances
Eq PutRecordBatchResponse Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

Data PutRecordBatchResponse Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutRecordBatchResponse -> c PutRecordBatchResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutRecordBatchResponse #

toConstr :: PutRecordBatchResponse -> Constr #

dataTypeOf :: PutRecordBatchResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PutRecordBatchResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutRecordBatchResponse) #

gmapT :: (forall b. Data b => b -> b) -> PutRecordBatchResponse -> PutRecordBatchResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutRecordBatchResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutRecordBatchResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> PutRecordBatchResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutRecordBatchResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutRecordBatchResponse -> m PutRecordBatchResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutRecordBatchResponse -> m PutRecordBatchResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutRecordBatchResponse -> m PutRecordBatchResponse #

Read PutRecordBatchResponse Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

Show PutRecordBatchResponse Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

Generic PutRecordBatchResponse Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

Associated Types

type Rep PutRecordBatchResponse :: Type -> Type #

NFData PutRecordBatchResponse Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

Methods

rnf :: PutRecordBatchResponse -> () #

type Rep PutRecordBatchResponse Source # 
Instance details

Defined in Network.AWS.Firehose.PutRecordBatch

type Rep PutRecordBatchResponse = D1 (MetaData "PutRecordBatchResponse" "Network.AWS.Firehose.PutRecordBatch" "amazonka-kinesis-firehose-1.6.1-IIrhAXaawLd9hcHz2LzLHx" False) (C1 (MetaCons "PutRecordBatchResponse'" PrefixI True) (S1 (MetaSel (Just "_prbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: (S1 (MetaSel (Just "_prbrsFailedPutCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat) :*: S1 (MetaSel (Just "_prbrsRequestResponses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (List1 PutRecordBatchResponseEntry)))))

Response Lenses

prbrsFailedPutCount :: Lens' PutRecordBatchResponse Natural Source #

The number of records that might have failed processing.

prbrsRequestResponses :: Lens' PutRecordBatchResponse (NonEmpty PutRecordBatchResponseEntry) Source #

The results array. For each record, the index of the response element is the same as the index used in the request array.