Network.AWS.Kinesis.PutRecord

Writes a single data record into an Amazon Kinesis data stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.

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 Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs.

Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide .

PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.

Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide .

If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException .

By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

Creating a Request

putRecord

Arguments

:: Text

prStreamName

-> ByteString

prData

-> Text

prPartitionKey

-> PutRecord

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

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

• prExplicitHashKey - The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
• prSequenceNumberForOrdering - Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the result when putting record n-1 ). If this parameter is not set, records are coarsely ordered based on arrival time.
• prStreamName - The name of the stream to put the data record into.
• prData - The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.
• prPartitionKey - Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, 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.

data PutRecord

Represents the input for PutRecord .

See: putRecord smart constructor.

Instances

Eq PutRecord

Defined in Network.AWS.Kinesis.PutRecord

Methods

(==) :: PutRecord -> PutRecord -> Bool

(/=) :: PutRecord -> PutRecord -> Bool

Data PutRecord

Defined in Network.AWS.Kinesis.PutRecord

Methods

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

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

toConstr :: PutRecord -> Constr

dataTypeOf :: PutRecord -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> PutRecord -> PutRecord

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

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

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

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

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

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

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

Read PutRecord

Defined in Network.AWS.Kinesis.PutRecord

Methods

readsPrec :: Int -> ReadS PutRecord

readList :: ReadS [PutRecord]

readPrec :: ReadPrec PutRecord

readListPrec :: ReadPrec [PutRecord]

Show PutRecord

Defined in Network.AWS.Kinesis.PutRecord

Methods

showsPrec :: Int -> PutRecord -> ShowS

show :: PutRecord -> String

showList :: [PutRecord] -> ShowS

Generic PutRecord

Defined in Network.AWS.Kinesis.PutRecord

Associated Types

type Rep PutRecord :: Type -> Type

Methods

from :: PutRecord -> Rep PutRecord x

to :: Rep PutRecord x -> PutRecord

Hashable PutRecord

Defined in Network.AWS.Kinesis.PutRecord

Methods

hashWithSalt :: Int -> PutRecord -> Int

hash :: PutRecord -> Int

ToJSON PutRecord

Defined in Network.AWS.Kinesis.PutRecord

Methods

toJSON :: PutRecord -> Value

toEncoding :: PutRecord -> Encoding

toJSONList :: [PutRecord] -> Value

toEncodingList :: [PutRecord] -> Encoding

AWSRequest PutRecord

Defined in Network.AWS.Kinesis.PutRecord

Associated Types

type Rs PutRecord :: Type

Methods

request :: PutRecord -> Request PutRecord

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy PutRecord -> ClientResponse -> m (Response PutRecord)

ToHeaders PutRecord

Defined in Network.AWS.Kinesis.PutRecord

Methods

toHeaders :: PutRecord -> [Header]

ToPath PutRecord

Defined in Network.AWS.Kinesis.PutRecord

Methods

toPath :: PutRecord -> ByteString

ToQuery PutRecord

Defined in Network.AWS.Kinesis.PutRecord

Methods

toQuery :: PutRecord -> QueryString

NFData PutRecord

Defined in Network.AWS.Kinesis.PutRecord

Methods

rnf :: PutRecord -> ()

type Rep PutRecord

Defined in Network.AWS.Kinesis.PutRecord

type Rep PutRecord = D1 (MetaData "PutRecord" "Network.AWS.Kinesis.PutRecord" "amazonka-kinesis-1.6.1-DicNGWPqg566LpzNlyqosm" False) (C1 (MetaCons "PutRecord'" PrefixI True) ((S1 (MetaSel (Just "_prExplicitHashKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_prSequenceNumberForOrdering") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_prStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_prData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Base64) :*: S1 (MetaSel (Just "_prPartitionKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs PutRecord

Defined in Network.AWS.Kinesis.PutRecord

type Rs PutRecord = PutRecordResponse

Request Lenses

prExplicitHashKey :: Lens' PutRecord (Maybe Text)

The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.

prSequenceNumberForOrdering :: Lens' PutRecord (Maybe Text)

Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the result when putting record n-1 ). If this parameter is not set, records are coarsely ordered based on arrival time.

prStreamName :: Lens' PutRecord Text

The name of the stream to put the data record into.

prData :: Lens' PutRecord ByteString

The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.

prPartitionKey :: Lens' PutRecord Text

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, 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.

Destructuring the Response

putRecordResponse

Arguments

:: Int

prrsResponseStatus

-> Text

prrsShardId

-> Text

prrsSequenceNumber

-> PutRecordResponse

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

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

• prrsEncryptionType - The encryption type to use on the record. This parameter can be one of the following values: * NONE : Do not encrypt the records in the stream. * KMS : Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.
• prrsResponseStatus - -- | The response status code.
• prrsShardId - The shard ID of the shard where the data record was placed.
• prrsSequenceNumber - The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.

data PutRecordResponse

Represents the output for PutRecord .

See: putRecordResponse smart constructor.

Instances

Eq PutRecordResponse

Defined in Network.AWS.Kinesis.PutRecord

Methods

(==) :: PutRecordResponse -> PutRecordResponse -> Bool

(/=) :: PutRecordResponse -> PutRecordResponse -> Bool

Data PutRecordResponse

Defined in Network.AWS.Kinesis.PutRecord

Methods

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

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

toConstr :: PutRecordResponse -> Constr

dataTypeOf :: PutRecordResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> PutRecordResponse -> PutRecordResponse

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

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

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

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

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

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

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

Read PutRecordResponse

Defined in Network.AWS.Kinesis.PutRecord

Methods

readsPrec :: Int -> ReadS PutRecordResponse

readList :: ReadS [PutRecordResponse]

readPrec :: ReadPrec PutRecordResponse

readListPrec :: ReadPrec [PutRecordResponse]

Show PutRecordResponse

Defined in Network.AWS.Kinesis.PutRecord

Methods

showsPrec :: Int -> PutRecordResponse -> ShowS

show :: PutRecordResponse -> String

showList :: [PutRecordResponse] -> ShowS

Generic PutRecordResponse

Defined in Network.AWS.Kinesis.PutRecord

Associated Types

type Rep PutRecordResponse :: Type -> Type

Methods

from :: PutRecordResponse -> Rep PutRecordResponse x

to :: Rep PutRecordResponse x -> PutRecordResponse

NFData PutRecordResponse

Defined in Network.AWS.Kinesis.PutRecord

Methods

rnf :: PutRecordResponse -> ()

type Rep PutRecordResponse

Defined in Network.AWS.Kinesis.PutRecord

type Rep PutRecordResponse = D1 (MetaData "PutRecordResponse" "Network.AWS.Kinesis.PutRecord" "amazonka-kinesis-1.6.1-DicNGWPqg566LpzNlyqosm" False) (C1 (MetaCons "PutRecordResponse'" PrefixI True) ((S1 (MetaSel (Just "_prrsEncryptionType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EncryptionType)) :*: S1 (MetaSel (Just "_prrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) :*: (S1 (MetaSel (Just "_prrsShardId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_prrsSequenceNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

Response Lenses

prrsEncryptionType :: Lens' PutRecordResponse (Maybe EncryptionType)

The encryption type to use on the record. This parameter can be one of the following values: * NONE : Do not encrypt the records in the stream. * KMS : Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

prrsResponseStatus :: Lens' PutRecordResponse Int

• - | The response status code.

prrsShardId :: Lens' PutRecordResponse Text

The shard ID of the shard where the data record was placed.

prrsSequenceNumber :: Lens' PutRecordResponse Text

The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.