{-# 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.GetShardIterator
-- 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)
--
-- Gets an Amazon Kinesis shard iterator. A shard iterator expires 5
-- minutes after it is returned to the requester.
--
-- A shard iterator specifies the shard position from which to start
-- reading data records sequentially. The position is specified using the
-- sequence number of a data record in a shard. A sequence number is the
-- identifier associated with every record ingested in the stream, and is
-- assigned when a record is put into the stream. Each stream has one or
-- more shards.
--
-- You must specify the shard iterator type. For example, you can set the
-- @ShardIteratorType@ parameter to read exactly from the position denoted
-- by a specific sequence number by using the @AT_SEQUENCE_NUMBER@ shard
-- iterator type. Alternatively, the parameter can read right after the
-- sequence number by using the @AFTER_SEQUENCE_NUMBER@ shard iterator
-- type, using sequence numbers returned by earlier calls to PutRecord,
-- PutRecords, GetRecords, or DescribeStream. In the request, you can
-- specify the shard iterator type @AT_TIMESTAMP@ to read records from an
-- arbitrary point in time, @TRIM_HORIZON@ to cause @ShardIterator@ to
-- point to the last untrimmed record in the shard in the system (the
-- oldest data record in the shard), or @LATEST@ so that you always read
-- the most recent data in the shard.
--
-- When you read repeatedly from a stream, use a GetShardIterator request
-- to get the first shard iterator for use in your first GetRecords request
-- and for subsequent reads use the shard iterator returned by the
-- GetRecords request in @NextShardIterator@. A new shard iterator is
-- returned by every GetRecords request in @NextShardIterator@, which you
-- use in the @ShardIterator@ parameter of the next GetRecords request.
--
-- If a GetShardIterator request is made too often, you receive a
-- @ProvisionedThroughputExceededException@. For more information about
-- throughput limits, see GetRecords, and
-- <https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html Streams Limits>
-- in the /Amazon Kinesis Data Streams Developer Guide/.
--
-- If the shard is closed, GetShardIterator returns a valid iterator for
-- the last sequence number of the shard. A shard can be closed as a result
-- of using SplitShard or MergeShards.
--
-- GetShardIterator has a limit of five transactions per second per account
-- per open shard.
module Amazonka.Kinesis.GetShardIterator
  ( -- * Creating a Request
    GetShardIterator (..),
    newGetShardIterator,

    -- * Request Lenses
    getShardIterator_startingSequenceNumber,
    getShardIterator_timestamp,
    getShardIterator_streamName,
    getShardIterator_shardId,
    getShardIterator_shardIteratorType,

    -- * Destructuring the Response
    GetShardIteratorResponse (..),
    newGetShardIteratorResponse,

    -- * Response Lenses
    getShardIteratorResponse_shardIterator,
    getShardIteratorResponse_httpStatus,
  )
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 @GetShardIterator@.
--
-- /See:/ 'newGetShardIterator' smart constructor.
data GetShardIterator = GetShardIterator'
  { -- | The sequence number of the data record in the shard from which to start
    -- reading. Used with shard iterator type AT_SEQUENCE_NUMBER and
    -- AFTER_SEQUENCE_NUMBER.
    GetShardIterator -> Maybe Text
startingSequenceNumber :: Prelude.Maybe Prelude.Text,
    -- | The time stamp of the data record from which to start reading. Used with
    -- shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date
    -- with precision in milliseconds. For example,
    -- @2016-04-04T19:58:46.480-00:00@ or @1459799926.480@. If a record with
    -- this exact time stamp does not exist, the iterator returned is for the
    -- next (later) record. If the time stamp is older than the current trim
    -- horizon, the iterator returned is for the oldest untrimmed data record
    -- (TRIM_HORIZON).
    GetShardIterator -> Maybe POSIX
timestamp :: Prelude.Maybe Core.POSIX,
    -- | The name of the Amazon Kinesis data stream.
    GetShardIterator -> Text
streamName :: Prelude.Text,
    -- | The shard ID of the Kinesis Data Streams shard to get the iterator for.
    GetShardIterator -> Text
shardId :: Prelude.Text,
    -- | Determines how the shard iterator is used to start reading data records
    -- from the shard.
    --
    -- The following are the valid Amazon Kinesis shard iterator types:
    --
    -- -   AT_SEQUENCE_NUMBER - Start reading from the position denoted by a
    --     specific sequence number, provided in the value
    --     @StartingSequenceNumber@.
    --
    -- -   AFTER_SEQUENCE_NUMBER - Start reading right after the position
    --     denoted by a specific sequence number, provided in the value
    --     @StartingSequenceNumber@.
    --
    -- -   AT_TIMESTAMP - Start reading from the position denoted by a specific
    --     time stamp, provided in the value @Timestamp@.
    --
    -- -   TRIM_HORIZON - Start reading at the last untrimmed record in the
    --     shard in the system, which is the oldest data record in the shard.
    --
    -- -   LATEST - Start reading just after the most recent record in the
    --     shard, so that you always read the most recent data in the shard.
    GetShardIterator -> ShardIteratorType
shardIteratorType :: ShardIteratorType
  }
  deriving (GetShardIterator -> GetShardIterator -> Bool
(GetShardIterator -> GetShardIterator -> Bool)
-> (GetShardIterator -> GetShardIterator -> Bool)
-> Eq GetShardIterator
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetShardIterator -> GetShardIterator -> Bool
$c/= :: GetShardIterator -> GetShardIterator -> Bool
== :: GetShardIterator -> GetShardIterator -> Bool
$c== :: GetShardIterator -> GetShardIterator -> Bool
Prelude.Eq, ReadPrec [GetShardIterator]
ReadPrec GetShardIterator
Int -> ReadS GetShardIterator
ReadS [GetShardIterator]
(Int -> ReadS GetShardIterator)
-> ReadS [GetShardIterator]
-> ReadPrec GetShardIterator
-> ReadPrec [GetShardIterator]
-> Read GetShardIterator
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetShardIterator]
$creadListPrec :: ReadPrec [GetShardIterator]
readPrec :: ReadPrec GetShardIterator
$creadPrec :: ReadPrec GetShardIterator
readList :: ReadS [GetShardIterator]
$creadList :: ReadS [GetShardIterator]
readsPrec :: Int -> ReadS GetShardIterator
$creadsPrec :: Int -> ReadS GetShardIterator
Prelude.Read, Int -> GetShardIterator -> ShowS
[GetShardIterator] -> ShowS
GetShardIterator -> String
(Int -> GetShardIterator -> ShowS)
-> (GetShardIterator -> String)
-> ([GetShardIterator] -> ShowS)
-> Show GetShardIterator
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetShardIterator] -> ShowS
$cshowList :: [GetShardIterator] -> ShowS
show :: GetShardIterator -> String
$cshow :: GetShardIterator -> String
showsPrec :: Int -> GetShardIterator -> ShowS
$cshowsPrec :: Int -> GetShardIterator -> ShowS
Prelude.Show, (forall x. GetShardIterator -> Rep GetShardIterator x)
-> (forall x. Rep GetShardIterator x -> GetShardIterator)
-> Generic GetShardIterator
forall x. Rep GetShardIterator x -> GetShardIterator
forall x. GetShardIterator -> Rep GetShardIterator x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetShardIterator x -> GetShardIterator
$cfrom :: forall x. GetShardIterator -> Rep GetShardIterator x
Prelude.Generic)

-- |
-- Create a value of 'GetShardIterator' 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:
--
-- 'startingSequenceNumber', 'getShardIterator_startingSequenceNumber' - The sequence number of the data record in the shard from which to start
-- reading. Used with shard iterator type AT_SEQUENCE_NUMBER and
-- AFTER_SEQUENCE_NUMBER.
--
-- 'timestamp', 'getShardIterator_timestamp' - The time stamp of the data record from which to start reading. Used with
-- shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date
-- with precision in milliseconds. For example,
-- @2016-04-04T19:58:46.480-00:00@ or @1459799926.480@. If a record with
-- this exact time stamp does not exist, the iterator returned is for the
-- next (later) record. If the time stamp is older than the current trim
-- horizon, the iterator returned is for the oldest untrimmed data record
-- (TRIM_HORIZON).
--
-- 'streamName', 'getShardIterator_streamName' - The name of the Amazon Kinesis data stream.
--
-- 'shardId', 'getShardIterator_shardId' - The shard ID of the Kinesis Data Streams shard to get the iterator for.
--
-- 'shardIteratorType', 'getShardIterator_shardIteratorType' - Determines how the shard iterator is used to start reading data records
-- from the shard.
--
-- The following are the valid Amazon Kinesis shard iterator types:
--
-- -   AT_SEQUENCE_NUMBER - Start reading from the position denoted by a
--     specific sequence number, provided in the value
--     @StartingSequenceNumber@.
--
-- -   AFTER_SEQUENCE_NUMBER - Start reading right after the position
--     denoted by a specific sequence number, provided in the value
--     @StartingSequenceNumber@.
--
-- -   AT_TIMESTAMP - Start reading from the position denoted by a specific
--     time stamp, provided in the value @Timestamp@.
--
-- -   TRIM_HORIZON - Start reading at the last untrimmed record in the
--     shard in the system, which is the oldest data record in the shard.
--
-- -   LATEST - Start reading just after the most recent record in the
--     shard, so that you always read the most recent data in the shard.
newGetShardIterator ::
  -- | 'streamName'
  Prelude.Text ->
  -- | 'shardId'
  Prelude.Text ->
  -- | 'shardIteratorType'
  ShardIteratorType ->
  GetShardIterator
newGetShardIterator :: Text -> Text -> ShardIteratorType -> GetShardIterator
newGetShardIterator
  Text
pStreamName_
  Text
pShardId_
  ShardIteratorType
pShardIteratorType_ =
    GetShardIterator' :: Maybe Text
-> Maybe POSIX
-> Text
-> Text
-> ShardIteratorType
-> GetShardIterator
GetShardIterator'
      { $sel:startingSequenceNumber:GetShardIterator' :: Maybe Text
startingSequenceNumber =
          Maybe Text
forall a. Maybe a
Prelude.Nothing,
        $sel:timestamp:GetShardIterator' :: Maybe POSIX
timestamp = Maybe POSIX
forall a. Maybe a
Prelude.Nothing,
        $sel:streamName:GetShardIterator' :: Text
streamName = Text
pStreamName_,
        $sel:shardId:GetShardIterator' :: Text
shardId = Text
pShardId_,
        $sel:shardIteratorType:GetShardIterator' :: ShardIteratorType
shardIteratorType = ShardIteratorType
pShardIteratorType_
      }

-- | The sequence number of the data record in the shard from which to start
-- reading. Used with shard iterator type AT_SEQUENCE_NUMBER and
-- AFTER_SEQUENCE_NUMBER.
getShardIterator_startingSequenceNumber :: Lens.Lens' GetShardIterator (Prelude.Maybe Prelude.Text)
getShardIterator_startingSequenceNumber :: (Maybe Text -> f (Maybe Text))
-> GetShardIterator -> f GetShardIterator
getShardIterator_startingSequenceNumber = (GetShardIterator -> Maybe Text)
-> (GetShardIterator -> Maybe Text -> GetShardIterator)
-> Lens GetShardIterator GetShardIterator (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetShardIterator' {Maybe Text
startingSequenceNumber :: Maybe Text
$sel:startingSequenceNumber:GetShardIterator' :: GetShardIterator -> Maybe Text
startingSequenceNumber} -> Maybe Text
startingSequenceNumber) (\s :: GetShardIterator
s@GetShardIterator' {} Maybe Text
a -> GetShardIterator
s {$sel:startingSequenceNumber:GetShardIterator' :: Maybe Text
startingSequenceNumber = Maybe Text
a} :: GetShardIterator)

-- | The time stamp of the data record from which to start reading. Used with
-- shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date
-- with precision in milliseconds. For example,
-- @2016-04-04T19:58:46.480-00:00@ or @1459799926.480@. If a record with
-- this exact time stamp does not exist, the iterator returned is for the
-- next (later) record. If the time stamp is older than the current trim
-- horizon, the iterator returned is for the oldest untrimmed data record
-- (TRIM_HORIZON).
getShardIterator_timestamp :: Lens.Lens' GetShardIterator (Prelude.Maybe Prelude.UTCTime)
getShardIterator_timestamp :: (Maybe UTCTime -> f (Maybe UTCTime))
-> GetShardIterator -> f GetShardIterator
getShardIterator_timestamp = (GetShardIterator -> Maybe POSIX)
-> (GetShardIterator -> Maybe POSIX -> GetShardIterator)
-> Lens
     GetShardIterator GetShardIterator (Maybe POSIX) (Maybe POSIX)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetShardIterator' {Maybe POSIX
timestamp :: Maybe POSIX
$sel:timestamp:GetShardIterator' :: GetShardIterator -> Maybe POSIX
timestamp} -> Maybe POSIX
timestamp) (\s :: GetShardIterator
s@GetShardIterator' {} Maybe POSIX
a -> GetShardIterator
s {$sel:timestamp:GetShardIterator' :: Maybe POSIX
timestamp = Maybe POSIX
a} :: GetShardIterator) ((Maybe POSIX -> f (Maybe POSIX))
 -> GetShardIterator -> f GetShardIterator)
-> ((Maybe UTCTime -> f (Maybe UTCTime))
    -> Maybe POSIX -> f (Maybe POSIX))
-> (Maybe UTCTime -> f (Maybe UTCTime))
-> GetShardIterator
-> f GetShardIterator
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso POSIX POSIX UTCTime UTCTime
-> Iso (Maybe POSIX) (Maybe POSIX) (Maybe UTCTime) (Maybe UTCTime)
forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping AnIso POSIX POSIX UTCTime UTCTime
forall (a :: Format). Iso' (Time a) UTCTime
Core._Time

-- | The name of the Amazon Kinesis data stream.
getShardIterator_streamName :: Lens.Lens' GetShardIterator Prelude.Text
getShardIterator_streamName :: (Text -> f Text) -> GetShardIterator -> f GetShardIterator
getShardIterator_streamName = (GetShardIterator -> Text)
-> (GetShardIterator -> Text -> GetShardIterator)
-> Lens GetShardIterator GetShardIterator Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetShardIterator' {Text
streamName :: Text
$sel:streamName:GetShardIterator' :: GetShardIterator -> Text
streamName} -> Text
streamName) (\s :: GetShardIterator
s@GetShardIterator' {} Text
a -> GetShardIterator
s {$sel:streamName:GetShardIterator' :: Text
streamName = Text
a} :: GetShardIterator)

-- | The shard ID of the Kinesis Data Streams shard to get the iterator for.
getShardIterator_shardId :: Lens.Lens' GetShardIterator Prelude.Text
getShardIterator_shardId :: (Text -> f Text) -> GetShardIterator -> f GetShardIterator
getShardIterator_shardId = (GetShardIterator -> Text)
-> (GetShardIterator -> Text -> GetShardIterator)
-> Lens GetShardIterator GetShardIterator Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetShardIterator' {Text
shardId :: Text
$sel:shardId:GetShardIterator' :: GetShardIterator -> Text
shardId} -> Text
shardId) (\s :: GetShardIterator
s@GetShardIterator' {} Text
a -> GetShardIterator
s {$sel:shardId:GetShardIterator' :: Text
shardId = Text
a} :: GetShardIterator)

-- | Determines how the shard iterator is used to start reading data records
-- from the shard.
--
-- The following are the valid Amazon Kinesis shard iterator types:
--
-- -   AT_SEQUENCE_NUMBER - Start reading from the position denoted by a
--     specific sequence number, provided in the value
--     @StartingSequenceNumber@.
--
-- -   AFTER_SEQUENCE_NUMBER - Start reading right after the position
--     denoted by a specific sequence number, provided in the value
--     @StartingSequenceNumber@.
--
-- -   AT_TIMESTAMP - Start reading from the position denoted by a specific
--     time stamp, provided in the value @Timestamp@.
--
-- -   TRIM_HORIZON - Start reading at the last untrimmed record in the
--     shard in the system, which is the oldest data record in the shard.
--
-- -   LATEST - Start reading just after the most recent record in the
--     shard, so that you always read the most recent data in the shard.
getShardIterator_shardIteratorType :: Lens.Lens' GetShardIterator ShardIteratorType
getShardIterator_shardIteratorType :: (ShardIteratorType -> f ShardIteratorType)
-> GetShardIterator -> f GetShardIterator
getShardIterator_shardIteratorType = (GetShardIterator -> ShardIteratorType)
-> (GetShardIterator -> ShardIteratorType -> GetShardIterator)
-> Lens
     GetShardIterator
     GetShardIterator
     ShardIteratorType
     ShardIteratorType
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetShardIterator' {ShardIteratorType
shardIteratorType :: ShardIteratorType
$sel:shardIteratorType:GetShardIterator' :: GetShardIterator -> ShardIteratorType
shardIteratorType} -> ShardIteratorType
shardIteratorType) (\s :: GetShardIterator
s@GetShardIterator' {} ShardIteratorType
a -> GetShardIterator
s {$sel:shardIteratorType:GetShardIterator' :: ShardIteratorType
shardIteratorType = ShardIteratorType
a} :: GetShardIterator)

instance Core.AWSRequest GetShardIterator where
  type
    AWSResponse GetShardIterator =
      GetShardIteratorResponse
  request :: GetShardIterator -> Request GetShardIterator
request = Service -> GetShardIterator -> Request GetShardIterator
forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON Service
defaultService
  response :: Logger
-> Service
-> Proxy GetShardIterator
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse GetShardIterator)))
response =
    (Int
 -> ResponseHeaders
 -> Object
 -> Either String (AWSResponse GetShardIterator))
-> Logger
-> Service
-> Proxy GetShardIterator
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse GetShardIterator)))
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 Text -> Int -> GetShardIteratorResponse
GetShardIteratorResponse'
            (Maybe Text -> Int -> GetShardIteratorResponse)
-> Either String (Maybe Text)
-> Either String (Int -> GetShardIteratorResponse)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Either String (Maybe Text)
forall a. FromJSON a => Object -> Text -> Either String (Maybe a)
Core..?> Text
"ShardIterator")
            Either String (Int -> GetShardIteratorResponse)
-> Either String Int -> Either String GetShardIteratorResponse
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))
      )

instance Prelude.Hashable GetShardIterator

instance Prelude.NFData GetShardIterator

instance Core.ToHeaders GetShardIterator where
  toHeaders :: GetShardIterator -> ResponseHeaders
toHeaders =
    ResponseHeaders -> GetShardIterator -> 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.GetShardIterator" ::
                          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 GetShardIterator where
  toJSON :: GetShardIterator -> Value
toJSON GetShardIterator' {Maybe Text
Maybe POSIX
Text
ShardIteratorType
shardIteratorType :: ShardIteratorType
shardId :: Text
streamName :: Text
timestamp :: Maybe POSIX
startingSequenceNumber :: Maybe Text
$sel:shardIteratorType:GetShardIterator' :: GetShardIterator -> ShardIteratorType
$sel:shardId:GetShardIterator' :: GetShardIterator -> Text
$sel:streamName:GetShardIterator' :: GetShardIterator -> Text
$sel:timestamp:GetShardIterator' :: GetShardIterator -> Maybe POSIX
$sel:startingSequenceNumber:GetShardIterator' :: GetShardIterator -> Maybe Text
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"StartingSequenceNumber" 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
startingSequenceNumber,
            (Text
"Timestamp" Text -> POSIX -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (POSIX -> Pair) -> Maybe POSIX -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe POSIX
timestamp,
            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
"ShardId" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
shardId),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just
              (Text
"ShardIteratorType" Text -> ShardIteratorType -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= ShardIteratorType
shardIteratorType)
          ]
      )

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

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

-- | Represents the output for @GetShardIterator@.
--
-- /See:/ 'newGetShardIteratorResponse' smart constructor.
data GetShardIteratorResponse = GetShardIteratorResponse'
  { -- | The position in the shard from which to start reading data records
    -- sequentially. A shard iterator specifies this position using the
    -- sequence number of a data record in a shard.
    GetShardIteratorResponse -> Maybe Text
shardIterator :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    GetShardIteratorResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (GetShardIteratorResponse -> GetShardIteratorResponse -> Bool
(GetShardIteratorResponse -> GetShardIteratorResponse -> Bool)
-> (GetShardIteratorResponse -> GetShardIteratorResponse -> Bool)
-> Eq GetShardIteratorResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetShardIteratorResponse -> GetShardIteratorResponse -> Bool
$c/= :: GetShardIteratorResponse -> GetShardIteratorResponse -> Bool
== :: GetShardIteratorResponse -> GetShardIteratorResponse -> Bool
$c== :: GetShardIteratorResponse -> GetShardIteratorResponse -> Bool
Prelude.Eq, ReadPrec [GetShardIteratorResponse]
ReadPrec GetShardIteratorResponse
Int -> ReadS GetShardIteratorResponse
ReadS [GetShardIteratorResponse]
(Int -> ReadS GetShardIteratorResponse)
-> ReadS [GetShardIteratorResponse]
-> ReadPrec GetShardIteratorResponse
-> ReadPrec [GetShardIteratorResponse]
-> Read GetShardIteratorResponse
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetShardIteratorResponse]
$creadListPrec :: ReadPrec [GetShardIteratorResponse]
readPrec :: ReadPrec GetShardIteratorResponse
$creadPrec :: ReadPrec GetShardIteratorResponse
readList :: ReadS [GetShardIteratorResponse]
$creadList :: ReadS [GetShardIteratorResponse]
readsPrec :: Int -> ReadS GetShardIteratorResponse
$creadsPrec :: Int -> ReadS GetShardIteratorResponse
Prelude.Read, Int -> GetShardIteratorResponse -> ShowS
[GetShardIteratorResponse] -> ShowS
GetShardIteratorResponse -> String
(Int -> GetShardIteratorResponse -> ShowS)
-> (GetShardIteratorResponse -> String)
-> ([GetShardIteratorResponse] -> ShowS)
-> Show GetShardIteratorResponse
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetShardIteratorResponse] -> ShowS
$cshowList :: [GetShardIteratorResponse] -> ShowS
show :: GetShardIteratorResponse -> String
$cshow :: GetShardIteratorResponse -> String
showsPrec :: Int -> GetShardIteratorResponse -> ShowS
$cshowsPrec :: Int -> GetShardIteratorResponse -> ShowS
Prelude.Show, (forall x.
 GetShardIteratorResponse -> Rep GetShardIteratorResponse x)
-> (forall x.
    Rep GetShardIteratorResponse x -> GetShardIteratorResponse)
-> Generic GetShardIteratorResponse
forall x.
Rep GetShardIteratorResponse x -> GetShardIteratorResponse
forall x.
GetShardIteratorResponse -> Rep GetShardIteratorResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep GetShardIteratorResponse x -> GetShardIteratorResponse
$cfrom :: forall x.
GetShardIteratorResponse -> Rep GetShardIteratorResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetShardIteratorResponse' 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:
--
-- 'shardIterator', 'getShardIteratorResponse_shardIterator' - The position in the shard from which to start reading data records
-- sequentially. A shard iterator specifies this position using the
-- sequence number of a data record in a shard.
--
-- 'httpStatus', 'getShardIteratorResponse_httpStatus' - The response's http status code.
newGetShardIteratorResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetShardIteratorResponse
newGetShardIteratorResponse :: Int -> GetShardIteratorResponse
newGetShardIteratorResponse Int
pHttpStatus_ =
  GetShardIteratorResponse' :: Maybe Text -> Int -> GetShardIteratorResponse
GetShardIteratorResponse'
    { $sel:shardIterator:GetShardIteratorResponse' :: Maybe Text
shardIterator =
        Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:GetShardIteratorResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The position in the shard from which to start reading data records
-- sequentially. A shard iterator specifies this position using the
-- sequence number of a data record in a shard.
getShardIteratorResponse_shardIterator :: Lens.Lens' GetShardIteratorResponse (Prelude.Maybe Prelude.Text)
getShardIteratorResponse_shardIterator :: (Maybe Text -> f (Maybe Text))
-> GetShardIteratorResponse -> f GetShardIteratorResponse
getShardIteratorResponse_shardIterator = (GetShardIteratorResponse -> Maybe Text)
-> (GetShardIteratorResponse
    -> Maybe Text -> GetShardIteratorResponse)
-> Lens
     GetShardIteratorResponse
     GetShardIteratorResponse
     (Maybe Text)
     (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetShardIteratorResponse' {Maybe Text
shardIterator :: Maybe Text
$sel:shardIterator:GetShardIteratorResponse' :: GetShardIteratorResponse -> Maybe Text
shardIterator} -> Maybe Text
shardIterator) (\s :: GetShardIteratorResponse
s@GetShardIteratorResponse' {} Maybe Text
a -> GetShardIteratorResponse
s {$sel:shardIterator:GetShardIteratorResponse' :: Maybe Text
shardIterator = Maybe Text
a} :: GetShardIteratorResponse)

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

instance Prelude.NFData GetShardIteratorResponse