{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Kinesis.PutRecord
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- 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 MiB 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
-- <https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream 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
-- <https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream Adding Data to a Stream>
-- in the /Amazon Kinesis Data Streams Developer Guide/.
--
-- After you write a record to a stream, you cannot modify that record or
-- its order within the stream.
--
-- 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.
module Amazonka.Kinesis.PutRecord
  ( -- * Creating a Request
    PutRecord (..),
    newPutRecord,

    -- * Request Lenses
    putRecord_explicitHashKey,
    putRecord_sequenceNumberForOrdering,
    putRecord_streamName,
    putRecord_data,
    putRecord_partitionKey,

    -- * Destructuring the Response
    PutRecordResponse (..),
    newPutRecordResponse,

    -- * Response Lenses
    putRecordResponse_encryptionType,
    putRecordResponse_httpStatus,
    putRecordResponse_shardId,
    putRecordResponse_sequenceNumber,
  )
where

import qualified Amazonka.Core as Core
import Amazonka.Kinesis.Types
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | Represents the input for @PutRecord@.
--
-- /See:/ 'newPutRecord' smart constructor.
data PutRecord = PutRecord'
  { -- | The hash value used to explicitly determine the shard the data record is
    -- assigned to by overriding the partition key hash.
    PutRecord -> Maybe Text
explicitHashKey :: Prelude.Maybe Prelude.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.
    PutRecord -> Maybe Text
sequenceNumberForOrdering :: Prelude.Maybe Prelude.Text,
    -- | The name of the stream to put the data record into.
    PutRecord -> Text
streamName :: Prelude.Text,
    -- | 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 MiB).
    PutRecord -> Base64
data' :: Core.Base64,
    -- | 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.
    PutRecord -> Text
partitionKey :: Prelude.Text
  }
  deriving (PutRecord -> PutRecord -> Bool
(PutRecord -> PutRecord -> Bool)
-> (PutRecord -> PutRecord -> Bool) -> Eq PutRecord
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PutRecord -> PutRecord -> Bool
$c/= :: PutRecord -> PutRecord -> Bool
== :: PutRecord -> PutRecord -> Bool
$c== :: PutRecord -> PutRecord -> Bool
Prelude.Eq, ReadPrec [PutRecord]
ReadPrec PutRecord
Int -> ReadS PutRecord
ReadS [PutRecord]
(Int -> ReadS PutRecord)
-> ReadS [PutRecord]
-> ReadPrec PutRecord
-> ReadPrec [PutRecord]
-> Read PutRecord
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PutRecord]
$creadListPrec :: ReadPrec [PutRecord]
readPrec :: ReadPrec PutRecord
$creadPrec :: ReadPrec PutRecord
readList :: ReadS [PutRecord]
$creadList :: ReadS [PutRecord]
readsPrec :: Int -> ReadS PutRecord
$creadsPrec :: Int -> ReadS PutRecord
Prelude.Read, Int -> PutRecord -> ShowS
[PutRecord] -> ShowS
PutRecord -> String
(Int -> PutRecord -> ShowS)
-> (PutRecord -> String)
-> ([PutRecord] -> ShowS)
-> Show PutRecord
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PutRecord] -> ShowS
$cshowList :: [PutRecord] -> ShowS
show :: PutRecord -> String
$cshow :: PutRecord -> String
showsPrec :: Int -> PutRecord -> ShowS
$cshowsPrec :: Int -> PutRecord -> ShowS
Prelude.Show, (forall x. PutRecord -> Rep PutRecord x)
-> (forall x. Rep PutRecord x -> PutRecord) -> Generic PutRecord
forall x. Rep PutRecord x -> PutRecord
forall x. PutRecord -> Rep PutRecord x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PutRecord x -> PutRecord
$cfrom :: forall x. PutRecord -> Rep PutRecord x
Prelude.Generic)

-- |
-- Create a value of 'PutRecord' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'explicitHashKey', 'putRecord_explicitHashKey' - The hash value used to explicitly determine the shard the data record is
-- assigned to by overriding the partition key hash.
--
-- 'sequenceNumberForOrdering', 'putRecord_sequenceNumberForOrdering' - 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.
--
-- 'streamName', 'putRecord_streamName' - The name of the stream to put the data record into.
--
-- 'data'', 'putRecord_data' - 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 MiB).--
-- -- /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.
--
-- 'partitionKey', 'putRecord_partitionKey' - 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.
newPutRecord ::
  -- | 'streamName'
  Prelude.Text ->
  -- | 'data''
  Prelude.ByteString ->
  -- | 'partitionKey'
  Prelude.Text ->
  PutRecord
newPutRecord :: Text -> ByteString -> Text -> PutRecord
newPutRecord Text
pStreamName_ ByteString
pData_ Text
pPartitionKey_ =
  PutRecord' :: Maybe Text -> Maybe Text -> Text -> Base64 -> Text -> PutRecord
PutRecord'
    { $sel:explicitHashKey:PutRecord' :: Maybe Text
explicitHashKey = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:sequenceNumberForOrdering:PutRecord' :: Maybe Text
sequenceNumberForOrdering = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:streamName:PutRecord' :: Text
streamName = Text
pStreamName_,
      $sel:data':PutRecord' :: Base64
data' = Tagged ByteString (Identity ByteString)
-> Tagged Base64 (Identity Base64)
Iso' Base64 ByteString
Core._Base64 (Tagged ByteString (Identity ByteString)
 -> Tagged Base64 (Identity Base64))
-> ByteString -> Base64
forall t b. AReview t b -> b -> t
Lens.# ByteString
pData_,
      $sel:partitionKey:PutRecord' :: Text
partitionKey = Text
pPartitionKey_
    }

-- | The hash value used to explicitly determine the shard the data record is
-- assigned to by overriding the partition key hash.
putRecord_explicitHashKey :: Lens.Lens' PutRecord (Prelude.Maybe Prelude.Text)
putRecord_explicitHashKey :: (Maybe Text -> f (Maybe Text)) -> PutRecord -> f PutRecord
putRecord_explicitHashKey = (PutRecord -> Maybe Text)
-> (PutRecord -> Maybe Text -> PutRecord)
-> Lens PutRecord PutRecord (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutRecord' {Maybe Text
explicitHashKey :: Maybe Text
$sel:explicitHashKey:PutRecord' :: PutRecord -> Maybe Text
explicitHashKey} -> Maybe Text
explicitHashKey) (\s :: PutRecord
s@PutRecord' {} Maybe Text
a -> PutRecord
s {$sel:explicitHashKey:PutRecord' :: Maybe Text
explicitHashKey = Maybe Text
a} :: PutRecord)

-- | 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.
putRecord_sequenceNumberForOrdering :: Lens.Lens' PutRecord (Prelude.Maybe Prelude.Text)
putRecord_sequenceNumberForOrdering :: (Maybe Text -> f (Maybe Text)) -> PutRecord -> f PutRecord
putRecord_sequenceNumberForOrdering = (PutRecord -> Maybe Text)
-> (PutRecord -> Maybe Text -> PutRecord)
-> Lens PutRecord PutRecord (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutRecord' {Maybe Text
sequenceNumberForOrdering :: Maybe Text
$sel:sequenceNumberForOrdering:PutRecord' :: PutRecord -> Maybe Text
sequenceNumberForOrdering} -> Maybe Text
sequenceNumberForOrdering) (\s :: PutRecord
s@PutRecord' {} Maybe Text
a -> PutRecord
s {$sel:sequenceNumberForOrdering:PutRecord' :: Maybe Text
sequenceNumberForOrdering = Maybe Text
a} :: PutRecord)

-- | The name of the stream to put the data record into.
putRecord_streamName :: Lens.Lens' PutRecord Prelude.Text
putRecord_streamName :: (Text -> f Text) -> PutRecord -> f PutRecord
putRecord_streamName = (PutRecord -> Text)
-> (PutRecord -> Text -> PutRecord)
-> Lens PutRecord PutRecord Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutRecord' {Text
streamName :: Text
$sel:streamName:PutRecord' :: PutRecord -> Text
streamName} -> Text
streamName) (\s :: PutRecord
s@PutRecord' {} Text
a -> PutRecord
s {$sel:streamName:PutRecord' :: Text
streamName = Text
a} :: PutRecord)

-- | 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 MiB).--
-- -- /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.
putRecord_data :: Lens.Lens' PutRecord Prelude.ByteString
putRecord_data :: (ByteString -> f ByteString) -> PutRecord -> f PutRecord
putRecord_data = (PutRecord -> Base64)
-> (PutRecord -> Base64 -> PutRecord)
-> Lens PutRecord PutRecord Base64 Base64
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutRecord' {Base64
data' :: Base64
$sel:data':PutRecord' :: PutRecord -> Base64
data'} -> Base64
data') (\s :: PutRecord
s@PutRecord' {} Base64
a -> PutRecord
s {$sel:data':PutRecord' :: Base64
data' = Base64
a} :: PutRecord) ((Base64 -> f Base64) -> PutRecord -> f PutRecord)
-> ((ByteString -> f ByteString) -> Base64 -> f Base64)
-> (ByteString -> f ByteString)
-> PutRecord
-> f PutRecord
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. (ByteString -> f ByteString) -> Base64 -> f Base64
Iso' Base64 ByteString
Core._Base64

-- | 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.
putRecord_partitionKey :: Lens.Lens' PutRecord Prelude.Text
putRecord_partitionKey :: (Text -> f Text) -> PutRecord -> f PutRecord
putRecord_partitionKey = (PutRecord -> Text)
-> (PutRecord -> Text -> PutRecord)
-> Lens PutRecord PutRecord Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutRecord' {Text
partitionKey :: Text
$sel:partitionKey:PutRecord' :: PutRecord -> Text
partitionKey} -> Text
partitionKey) (\s :: PutRecord
s@PutRecord' {} Text
a -> PutRecord
s {$sel:partitionKey:PutRecord' :: Text
partitionKey = Text
a} :: PutRecord)

instance Core.AWSRequest PutRecord where
  type AWSResponse PutRecord = PutRecordResponse
  request :: PutRecord -> Request PutRecord
request = Service -> PutRecord -> Request PutRecord
forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON Service
defaultService
  response :: Logger
-> Service
-> Proxy PutRecord
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse PutRecord)))
response =
    (Int
 -> ResponseHeaders
 -> Object
 -> Either String (AWSResponse PutRecord))
-> Logger
-> Service
-> Proxy PutRecord
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse PutRecord)))
forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> Logger
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe EncryptionType -> Int -> Text -> Text -> PutRecordResponse
PutRecordResponse'
            (Maybe EncryptionType -> Int -> Text -> Text -> PutRecordResponse)
-> Either String (Maybe EncryptionType)
-> Either String (Int -> Text -> Text -> PutRecordResponse)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Either String (Maybe EncryptionType)
forall a. FromJSON a => Object -> Text -> Either String (Maybe a)
Core..?> Text
"EncryptionType")
            Either String (Int -> Text -> Text -> PutRecordResponse)
-> Either String Int
-> Either String (Text -> Text -> PutRecordResponse)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Int -> Either String Int
forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (Int -> Int
forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
            Either String (Text -> Text -> PutRecordResponse)
-> Either String Text -> Either String (Text -> PutRecordResponse)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Either String Text
forall a. FromJSON a => Object -> Text -> Either String a
Core..:> Text
"ShardId")
            Either String (Text -> PutRecordResponse)
-> Either String Text -> Either String PutRecordResponse
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Either String Text
forall a. FromJSON a => Object -> Text -> Either String a
Core..:> Text
"SequenceNumber")
      )

instance Prelude.Hashable PutRecord

instance Prelude.NFData PutRecord

instance Core.ToHeaders PutRecord where
  toHeaders :: PutRecord -> ResponseHeaders
toHeaders =
    ResponseHeaders -> PutRecord -> ResponseHeaders
forall a b. a -> b -> a
Prelude.const
      ( [ResponseHeaders] -> ResponseHeaders
forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              HeaderName -> ByteString -> ResponseHeaders
forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Core.=# (ByteString
"Kinesis_20131202.PutRecord" :: Prelude.ByteString),
            HeaderName
"Content-Type"
              HeaderName -> ByteString -> ResponseHeaders
forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Core.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Core.ToJSON PutRecord where
  toJSON :: PutRecord -> Value
toJSON PutRecord' {Maybe Text
Text
Base64
partitionKey :: Text
data' :: Base64
streamName :: Text
sequenceNumberForOrdering :: Maybe Text
explicitHashKey :: Maybe Text
$sel:partitionKey:PutRecord' :: PutRecord -> Text
$sel:data':PutRecord' :: PutRecord -> Base64
$sel:streamName:PutRecord' :: PutRecord -> Text
$sel:sequenceNumberForOrdering:PutRecord' :: PutRecord -> Maybe Text
$sel:explicitHashKey:PutRecord' :: PutRecord -> Maybe Text
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"ExplicitHashKey" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
explicitHashKey,
            (Text
"SequenceNumberForOrdering" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
sequenceNumberForOrdering,
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"StreamName" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
streamName),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"Data" Text -> Base64 -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Base64
data'),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"PartitionKey" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
partitionKey)
          ]
      )

instance Core.ToPath PutRecord where
  toPath :: PutRecord -> ByteString
toPath = ByteString -> PutRecord -> ByteString
forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Core.ToQuery PutRecord where
  toQuery :: PutRecord -> QueryString
toQuery = QueryString -> PutRecord -> QueryString
forall a b. a -> b -> a
Prelude.const QueryString
forall a. Monoid a => a
Prelude.mempty

-- | Represents the output for @PutRecord@.
--
-- /See:/ 'newPutRecordResponse' smart constructor.
data PutRecordResponse = PutRecordResponse'
  { -- | 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.
    PutRecordResponse -> Maybe EncryptionType
encryptionType :: Prelude.Maybe EncryptionType,
    -- | The response's http status code.
    PutRecordResponse -> Int
httpStatus :: Prelude.Int,
    -- | The shard ID of the shard where the data record was placed.
    PutRecordResponse -> Text
shardId :: Prelude.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.
    PutRecordResponse -> Text
sequenceNumber :: Prelude.Text
  }
  deriving (PutRecordResponse -> PutRecordResponse -> Bool
(PutRecordResponse -> PutRecordResponse -> Bool)
-> (PutRecordResponse -> PutRecordResponse -> Bool)
-> Eq PutRecordResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PutRecordResponse -> PutRecordResponse -> Bool
$c/= :: PutRecordResponse -> PutRecordResponse -> Bool
== :: PutRecordResponse -> PutRecordResponse -> Bool
$c== :: PutRecordResponse -> PutRecordResponse -> Bool
Prelude.Eq, ReadPrec [PutRecordResponse]
ReadPrec PutRecordResponse
Int -> ReadS PutRecordResponse
ReadS [PutRecordResponse]
(Int -> ReadS PutRecordResponse)
-> ReadS [PutRecordResponse]
-> ReadPrec PutRecordResponse
-> ReadPrec [PutRecordResponse]
-> Read PutRecordResponse
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PutRecordResponse]
$creadListPrec :: ReadPrec [PutRecordResponse]
readPrec :: ReadPrec PutRecordResponse
$creadPrec :: ReadPrec PutRecordResponse
readList :: ReadS [PutRecordResponse]
$creadList :: ReadS [PutRecordResponse]
readsPrec :: Int -> ReadS PutRecordResponse
$creadsPrec :: Int -> ReadS PutRecordResponse
Prelude.Read, Int -> PutRecordResponse -> ShowS
[PutRecordResponse] -> ShowS
PutRecordResponse -> String
(Int -> PutRecordResponse -> ShowS)
-> (PutRecordResponse -> String)
-> ([PutRecordResponse] -> ShowS)
-> Show PutRecordResponse
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PutRecordResponse] -> ShowS
$cshowList :: [PutRecordResponse] -> ShowS
show :: PutRecordResponse -> String
$cshow :: PutRecordResponse -> String
showsPrec :: Int -> PutRecordResponse -> ShowS
$cshowsPrec :: Int -> PutRecordResponse -> ShowS
Prelude.Show, (forall x. PutRecordResponse -> Rep PutRecordResponse x)
-> (forall x. Rep PutRecordResponse x -> PutRecordResponse)
-> Generic PutRecordResponse
forall x. Rep PutRecordResponse x -> PutRecordResponse
forall x. PutRecordResponse -> Rep PutRecordResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PutRecordResponse x -> PutRecordResponse
$cfrom :: forall x. PutRecordResponse -> Rep PutRecordResponse x
Prelude.Generic)

-- |
-- Create a value of 'PutRecordResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'encryptionType', 'putRecordResponse_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.
--
-- 'httpStatus', 'putRecordResponse_httpStatus' - The response's http status code.
--
-- 'shardId', 'putRecordResponse_shardId' - The shard ID of the shard where the data record was placed.
--
-- 'sequenceNumber', 'putRecordResponse_sequenceNumber' - 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.
newPutRecordResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  -- | 'shardId'
  Prelude.Text ->
  -- | 'sequenceNumber'
  Prelude.Text ->
  PutRecordResponse
newPutRecordResponse :: Int -> Text -> Text -> PutRecordResponse
newPutRecordResponse
  Int
pHttpStatus_
  Text
pShardId_
  Text
pSequenceNumber_ =
    PutRecordResponse' :: Maybe EncryptionType -> Int -> Text -> Text -> PutRecordResponse
PutRecordResponse'
      { $sel:encryptionType:PutRecordResponse' :: Maybe EncryptionType
encryptionType =
          Maybe EncryptionType
forall a. Maybe a
Prelude.Nothing,
        $sel:httpStatus:PutRecordResponse' :: Int
httpStatus = Int
pHttpStatus_,
        $sel:shardId:PutRecordResponse' :: Text
shardId = Text
pShardId_,
        $sel:sequenceNumber:PutRecordResponse' :: Text
sequenceNumber = Text
pSequenceNumber_
      }

-- | 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.
putRecordResponse_encryptionType :: Lens.Lens' PutRecordResponse (Prelude.Maybe EncryptionType)
putRecordResponse_encryptionType :: (Maybe EncryptionType -> f (Maybe EncryptionType))
-> PutRecordResponse -> f PutRecordResponse
putRecordResponse_encryptionType = (PutRecordResponse -> Maybe EncryptionType)
-> (PutRecordResponse -> Maybe EncryptionType -> PutRecordResponse)
-> Lens
     PutRecordResponse
     PutRecordResponse
     (Maybe EncryptionType)
     (Maybe EncryptionType)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutRecordResponse' {Maybe EncryptionType
encryptionType :: Maybe EncryptionType
$sel:encryptionType:PutRecordResponse' :: PutRecordResponse -> Maybe EncryptionType
encryptionType} -> Maybe EncryptionType
encryptionType) (\s :: PutRecordResponse
s@PutRecordResponse' {} Maybe EncryptionType
a -> PutRecordResponse
s {$sel:encryptionType:PutRecordResponse' :: Maybe EncryptionType
encryptionType = Maybe EncryptionType
a} :: PutRecordResponse)

-- | The response's http status code.
putRecordResponse_httpStatus :: Lens.Lens' PutRecordResponse Prelude.Int
putRecordResponse_httpStatus :: (Int -> f Int) -> PutRecordResponse -> f PutRecordResponse
putRecordResponse_httpStatus = (PutRecordResponse -> Int)
-> (PutRecordResponse -> Int -> PutRecordResponse)
-> Lens PutRecordResponse PutRecordResponse Int Int
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutRecordResponse' {Int
httpStatus :: Int
$sel:httpStatus:PutRecordResponse' :: PutRecordResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: PutRecordResponse
s@PutRecordResponse' {} Int
a -> PutRecordResponse
s {$sel:httpStatus:PutRecordResponse' :: Int
httpStatus = Int
a} :: PutRecordResponse)

-- | The shard ID of the shard where the data record was placed.
putRecordResponse_shardId :: Lens.Lens' PutRecordResponse Prelude.Text
putRecordResponse_shardId :: (Text -> f Text) -> PutRecordResponse -> f PutRecordResponse
putRecordResponse_shardId = (PutRecordResponse -> Text)
-> (PutRecordResponse -> Text -> PutRecordResponse)
-> Lens PutRecordResponse PutRecordResponse Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutRecordResponse' {Text
shardId :: Text
$sel:shardId:PutRecordResponse' :: PutRecordResponse -> Text
shardId} -> Text
shardId) (\s :: PutRecordResponse
s@PutRecordResponse' {} Text
a -> PutRecordResponse
s {$sel:shardId:PutRecordResponse' :: Text
shardId = Text
a} :: PutRecordResponse)

-- | 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.
putRecordResponse_sequenceNumber :: Lens.Lens' PutRecordResponse Prelude.Text
putRecordResponse_sequenceNumber :: (Text -> f Text) -> PutRecordResponse -> f PutRecordResponse
putRecordResponse_sequenceNumber = (PutRecordResponse -> Text)
-> (PutRecordResponse -> Text -> PutRecordResponse)
-> Lens PutRecordResponse PutRecordResponse Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutRecordResponse' {Text
sequenceNumber :: Text
$sel:sequenceNumber:PutRecordResponse' :: PutRecordResponse -> Text
sequenceNumber} -> Text
sequenceNumber) (\s :: PutRecordResponse
s@PutRecordResponse' {} Text
a -> PutRecordResponse
s {$sel:sequenceNumber:PutRecordResponse' :: Text
sequenceNumber = Text
a} :: PutRecordResponse)

instance Prelude.NFData PutRecordResponse