Network.AWS.Kinesis.PutRecords

Puts (writes) multiple data records from a producer into an Amazon Kinesis stream in a single call (also referred to as a PutRecords request). Use this operation to send data from a data producer into the Amazon Kinesis stream for real-time ingestion and processing. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written per second.

You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob.

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

The partition key is used by Amazon Kinesis as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Developer Guide.

Each record in the Records array may include an optional parameter, ExplicitHashKey, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Developer Guide.

The PutRecords response includes an array of response Records. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array.

The response Records array includes both successfully and unsuccessfully processed records. Amazon Kinesis attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records.

A successfully-processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream.

An unsuccessfully-processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Developer Guide.

Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.

See: AWS API Reference for PutRecords.

Creating a Request

putRecords

Arguments

:: NonEmpty PutRecordsRequestEntry

pRecordEntries

-> Text

pStreamName

-> PutRecords

Creates a value of PutRecords with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pRecordEntries
• pStreamName

data PutRecords

A PutRecords request.

See: putRecords smart constructor.

Instances

Eq PutRecords

Data PutRecords

Read PutRecords

Show PutRecords

Generic PutRecords

ToJSON PutRecords

AWSRequest PutRecords

ToPath PutRecords

ToHeaders PutRecords

ToQuery PutRecords

Typeable * PutRecords

type Rep PutRecords

type Sv PutRecords = Kinesis

type Rs PutRecords = PutRecordsResponse

Request Lenses

pRecordEntries :: Lens' PutRecords (NonEmpty PutRecordsRequestEntry)

The records associated with the request.

pStreamName :: Lens' PutRecords Text

The stream name associated with the request.

Destructuring the Response

putRecordsResponse

Arguments

:: Int

prsStatus

-> NonEmpty PutRecordsResultEntry

prsRecords

-> PutRecordsResponse

Creates a value of PutRecordsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• prsFailedRecordCount
• prsStatus
• prsRecords

data PutRecordsResponse

PutRecords results.

See: putRecordsResponse smart constructor.

Instances

Eq PutRecordsResponse

Data PutRecordsResponse

Read PutRecordsResponse

Show PutRecordsResponse

Generic PutRecordsResponse

Typeable * PutRecordsResponse

type Rep PutRecordsResponse

Response Lenses

prsFailedRecordCount :: Lens' PutRecordsResponse (Maybe Natural)

The number of unsuccessfully processed records in a PutRecords request.

prsStatus :: Lens' PutRecordsResponse Int

The response status code.

prsRecords :: Lens' PutRecordsResponse (NonEmpty PutRecordsResultEntry)

An array of successfully and unsuccessfully processed record results, correlated with the request by natural ordering. A record that is successfully added to your Amazon Kinesis stream includes SequenceNumber and ShardId in the result. A record that fails to be added to your Amazon Kinesis stream includes ErrorCode and ErrorMessage in the result.