{-# 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.Firehose.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 Firehose
-- delivery stream. To write multiple data records into a delivery stream,
-- use PutRecordBatch. 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 and how to request an increase, see
-- <https://docs.aws.amazon.com/firehose/latest/dev/limits.html Amazon Kinesis Data 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 KiB in size, and any kind of data. For example, it can 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 @PutRecord@ operation returns a @RecordId@, which is a unique string
-- assigned to each record. Producer applications can use this ID for
-- purposes such as auditability and investigation.
--
-- If the @PutRecord@ 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 Kinesis Data Firehose are stored for 24 hours from
-- the time they are added to a delivery stream as it tries to send the
-- records to the destination. If the destination is unreachable for more
-- than 24 hours, the data is no longer available.
--
-- Don\'t concatenate two or more base64 strings to form the data fields of
-- your records. Instead, concatenate the raw data, then perform base64
-- encoding.
module Amazonka.Firehose.PutRecord
  ( -- * Creating a Request
    PutRecord (..),
    newPutRecord,

    -- * Request Lenses
    putRecord_deliveryStreamName,
    putRecord_record,

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

    -- * Response Lenses
    putRecordResponse_encrypted,
    putRecordResponse_httpStatus,
    putRecordResponse_recordId,
  )
where

import qualified Amazonka.Core as Core
import Amazonka.Firehose.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

-- | /See:/ 'newPutRecord' smart constructor.
data PutRecord = PutRecord'
  { -- | The name of the delivery stream.
    PutRecord -> Text
deliveryStreamName :: Prelude.Text,
    -- | The record.
    PutRecord -> Record
record :: Record
  }
  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:
--
-- 'deliveryStreamName', 'putRecord_deliveryStreamName' - The name of the delivery stream.
--
-- 'record', 'putRecord_record' - The record.
newPutRecord ::
  -- | 'deliveryStreamName'
  Prelude.Text ->
  -- | 'record'
  Record ->
  PutRecord
newPutRecord :: Text -> Record -> PutRecord
newPutRecord Text
pDeliveryStreamName_ Record
pRecord_ =
  PutRecord' :: Text -> Record -> PutRecord
PutRecord'
    { $sel:deliveryStreamName:PutRecord' :: Text
deliveryStreamName =
        Text
pDeliveryStreamName_,
      $sel:record:PutRecord' :: Record
record = Record
pRecord_
    }

-- | The name of the delivery stream.
putRecord_deliveryStreamName :: Lens.Lens' PutRecord Prelude.Text
putRecord_deliveryStreamName :: (Text -> f Text) -> PutRecord -> f PutRecord
putRecord_deliveryStreamName = (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
deliveryStreamName :: Text
$sel:deliveryStreamName:PutRecord' :: PutRecord -> Text
deliveryStreamName} -> Text
deliveryStreamName) (\s :: PutRecord
s@PutRecord' {} Text
a -> PutRecord
s {$sel:deliveryStreamName:PutRecord' :: Text
deliveryStreamName = Text
a} :: PutRecord)

-- | The record.
putRecord_record :: Lens.Lens' PutRecord Record
putRecord_record :: (Record -> f Record) -> PutRecord -> f PutRecord
putRecord_record = (PutRecord -> Record)
-> (PutRecord -> Record -> PutRecord)
-> Lens PutRecord PutRecord Record Record
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutRecord' {Record
record :: Record
$sel:record:PutRecord' :: PutRecord -> Record
record} -> Record
record) (\s :: PutRecord
s@PutRecord' {} Record
a -> PutRecord
s {$sel:record:PutRecord' :: Record
record = Record
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 Bool -> Int -> Text -> PutRecordResponse
PutRecordResponse'
            (Maybe Bool -> Int -> Text -> PutRecordResponse)
-> Either String (Maybe Bool)
-> Either String (Int -> Text -> PutRecordResponse)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Either String (Maybe Bool)
forall a. FromJSON a => Object -> Text -> Either String (Maybe a)
Core..?> Text
"Encrypted")
            Either String (Int -> Text -> PutRecordResponse)
-> Either String Int -> Either String (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 -> 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
"RecordId")
      )

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
"Firehose_20150804.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' {Text
Record
record :: Record
deliveryStreamName :: Text
$sel:record:PutRecord' :: PutRecord -> Record
$sel:deliveryStreamName:PutRecord' :: PutRecord -> Text
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just
              (Text
"DeliveryStreamName" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
deliveryStreamName),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"Record" Text -> Record -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Record
record)
          ]
      )

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

-- | /See:/ 'newPutRecordResponse' smart constructor.
data PutRecordResponse = PutRecordResponse'
  { -- | Indicates whether server-side encryption (SSE) was enabled during this
    -- operation.
    PutRecordResponse -> Maybe Bool
encrypted :: Prelude.Maybe Prelude.Bool,
    -- | The response's http status code.
    PutRecordResponse -> Int
httpStatus :: Prelude.Int,
    -- | The ID of the record.
    PutRecordResponse -> Text
recordId :: 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:
--
-- 'encrypted', 'putRecordResponse_encrypted' - Indicates whether server-side encryption (SSE) was enabled during this
-- operation.
--
-- 'httpStatus', 'putRecordResponse_httpStatus' - The response's http status code.
--
-- 'recordId', 'putRecordResponse_recordId' - The ID of the record.
newPutRecordResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  -- | 'recordId'
  Prelude.Text ->
  PutRecordResponse
newPutRecordResponse :: Int -> Text -> PutRecordResponse
newPutRecordResponse Int
pHttpStatus_ Text
pRecordId_ =
  PutRecordResponse' :: Maybe Bool -> Int -> Text -> PutRecordResponse
PutRecordResponse'
    { $sel:encrypted:PutRecordResponse' :: Maybe Bool
encrypted = Maybe Bool
forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:PutRecordResponse' :: Int
httpStatus = Int
pHttpStatus_,
      $sel:recordId:PutRecordResponse' :: Text
recordId = Text
pRecordId_
    }

-- | Indicates whether server-side encryption (SSE) was enabled during this
-- operation.
putRecordResponse_encrypted :: Lens.Lens' PutRecordResponse (Prelude.Maybe Prelude.Bool)
putRecordResponse_encrypted :: (Maybe Bool -> f (Maybe Bool))
-> PutRecordResponse -> f PutRecordResponse
putRecordResponse_encrypted = (PutRecordResponse -> Maybe Bool)
-> (PutRecordResponse -> Maybe Bool -> PutRecordResponse)
-> Lens
     PutRecordResponse PutRecordResponse (Maybe Bool) (Maybe Bool)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PutRecordResponse' {Maybe Bool
encrypted :: Maybe Bool
$sel:encrypted:PutRecordResponse' :: PutRecordResponse -> Maybe Bool
encrypted} -> Maybe Bool
encrypted) (\s :: PutRecordResponse
s@PutRecordResponse' {} Maybe Bool
a -> PutRecordResponse
s {$sel:encrypted:PutRecordResponse' :: Maybe Bool
encrypted = Maybe Bool
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 ID of the record.
putRecordResponse_recordId :: Lens.Lens' PutRecordResponse Prelude.Text
putRecordResponse_recordId :: (Text -> f Text) -> PutRecordResponse -> f PutRecordResponse
putRecordResponse_recordId = (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
recordId :: Text
$sel:recordId:PutRecordResponse' :: PutRecordResponse -> Text
recordId} -> Text
recordId) (\s :: PutRecordResponse
s@PutRecordResponse' {} Text
a -> PutRecordResponse
s {$sel:recordId:PutRecordResponse' :: Text
recordId = Text
a} :: PutRecordResponse)

instance Prelude.NFData PutRecordResponse