{-# 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.DescribeLimits
-- 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)
--
-- Describes the shard limits and usage for the account.
--
-- If you update your account limits, the old limits might be returned for
-- a few minutes.
--
-- This operation has a limit of one transaction per second per account.
module Amazonka.Kinesis.DescribeLimits
  ( -- * Creating a Request
    DescribeLimits (..),
    newDescribeLimits,

    -- * Destructuring the Response
    DescribeLimitsResponse (..),
    newDescribeLimitsResponse,

    -- * Response Lenses
    describeLimitsResponse_httpStatus,
    describeLimitsResponse_shardLimit,
    describeLimitsResponse_openShardCount,
  )
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

-- | /See:/ 'newDescribeLimits' smart constructor.
data DescribeLimits = DescribeLimits'
  {
  }
  deriving (DescribeLimits -> DescribeLimits -> Bool
(DescribeLimits -> DescribeLimits -> Bool)
-> (DescribeLimits -> DescribeLimits -> Bool) -> Eq DescribeLimits
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeLimits -> DescribeLimits -> Bool
$c/= :: DescribeLimits -> DescribeLimits -> Bool
== :: DescribeLimits -> DescribeLimits -> Bool
$c== :: DescribeLimits -> DescribeLimits -> Bool
Prelude.Eq, ReadPrec [DescribeLimits]
ReadPrec DescribeLimits
Int -> ReadS DescribeLimits
ReadS [DescribeLimits]
(Int -> ReadS DescribeLimits)
-> ReadS [DescribeLimits]
-> ReadPrec DescribeLimits
-> ReadPrec [DescribeLimits]
-> Read DescribeLimits
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeLimits]
$creadListPrec :: ReadPrec [DescribeLimits]
readPrec :: ReadPrec DescribeLimits
$creadPrec :: ReadPrec DescribeLimits
readList :: ReadS [DescribeLimits]
$creadList :: ReadS [DescribeLimits]
readsPrec :: Int -> ReadS DescribeLimits
$creadsPrec :: Int -> ReadS DescribeLimits
Prelude.Read, Int -> DescribeLimits -> ShowS
[DescribeLimits] -> ShowS
DescribeLimits -> String
(Int -> DescribeLimits -> ShowS)
-> (DescribeLimits -> String)
-> ([DescribeLimits] -> ShowS)
-> Show DescribeLimits
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeLimits] -> ShowS
$cshowList :: [DescribeLimits] -> ShowS
show :: DescribeLimits -> String
$cshow :: DescribeLimits -> String
showsPrec :: Int -> DescribeLimits -> ShowS
$cshowsPrec :: Int -> DescribeLimits -> ShowS
Prelude.Show, (forall x. DescribeLimits -> Rep DescribeLimits x)
-> (forall x. Rep DescribeLimits x -> DescribeLimits)
-> Generic DescribeLimits
forall x. Rep DescribeLimits x -> DescribeLimits
forall x. DescribeLimits -> Rep DescribeLimits x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeLimits x -> DescribeLimits
$cfrom :: forall x. DescribeLimits -> Rep DescribeLimits x
Prelude.Generic)

-- |
-- Create a value of 'DescribeLimits' 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.
newDescribeLimits ::
  DescribeLimits
newDescribeLimits :: DescribeLimits
newDescribeLimits = DescribeLimits
DescribeLimits'

instance Core.AWSRequest DescribeLimits where
  type
    AWSResponse DescribeLimits =
      DescribeLimitsResponse
  request :: DescribeLimits -> Request DescribeLimits
request = Service -> DescribeLimits -> Request DescribeLimits
forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON Service
defaultService
  response :: Logger
-> Service
-> Proxy DescribeLimits
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeLimits)))
response =
    (Int
 -> ResponseHeaders
 -> Object
 -> Either String (AWSResponse DescribeLimits))
-> Logger
-> Service
-> Proxy DescribeLimits
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeLimits)))
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 ->
          Int -> Natural -> Natural -> DescribeLimitsResponse
DescribeLimitsResponse'
            (Int -> Natural -> Natural -> DescribeLimitsResponse)
-> Either String Int
-> Either String (Natural -> Natural -> DescribeLimitsResponse)
forall (f :: * -> *) a b. Functor 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 (Natural -> Natural -> DescribeLimitsResponse)
-> Either String Natural
-> Either String (Natural -> DescribeLimitsResponse)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Key -> Either String Natural
forall a. FromJSON a => Object -> Key -> Either String a
Core..:> Key
"ShardLimit")
            Either String (Natural -> DescribeLimitsResponse)
-> Either String Natural -> Either String DescribeLimitsResponse
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Key -> Either String Natural
forall a. FromJSON a => Object -> Key -> Either String a
Core..:> Key
"OpenShardCount")
      )

instance Prelude.Hashable DescribeLimits

instance Prelude.NFData DescribeLimits

instance Core.ToHeaders DescribeLimits where
  toHeaders :: DescribeLimits -> ResponseHeaders
toHeaders =
    ResponseHeaders -> DescribeLimits -> 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.DescribeLimits" ::
                          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 DescribeLimits where
  toJSON :: DescribeLimits -> Value
toJSON = Value -> DescribeLimits -> Value
forall a b. a -> b -> a
Prelude.const (Object -> Value
Core.Object Object
forall a. Monoid a => a
Prelude.mempty)

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

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

-- | /See:/ 'newDescribeLimitsResponse' smart constructor.
data DescribeLimitsResponse = DescribeLimitsResponse'
  { -- | The response's http status code.
    DescribeLimitsResponse -> Int
httpStatus :: Prelude.Int,
    -- | The maximum number of shards.
    DescribeLimitsResponse -> Natural
shardLimit :: Prelude.Natural,
    -- | The number of open shards.
    DescribeLimitsResponse -> Natural
openShardCount :: Prelude.Natural
  }
  deriving (DescribeLimitsResponse -> DescribeLimitsResponse -> Bool
(DescribeLimitsResponse -> DescribeLimitsResponse -> Bool)
-> (DescribeLimitsResponse -> DescribeLimitsResponse -> Bool)
-> Eq DescribeLimitsResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeLimitsResponse -> DescribeLimitsResponse -> Bool
$c/= :: DescribeLimitsResponse -> DescribeLimitsResponse -> Bool
== :: DescribeLimitsResponse -> DescribeLimitsResponse -> Bool
$c== :: DescribeLimitsResponse -> DescribeLimitsResponse -> Bool
Prelude.Eq, ReadPrec [DescribeLimitsResponse]
ReadPrec DescribeLimitsResponse
Int -> ReadS DescribeLimitsResponse
ReadS [DescribeLimitsResponse]
(Int -> ReadS DescribeLimitsResponse)
-> ReadS [DescribeLimitsResponse]
-> ReadPrec DescribeLimitsResponse
-> ReadPrec [DescribeLimitsResponse]
-> Read DescribeLimitsResponse
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeLimitsResponse]
$creadListPrec :: ReadPrec [DescribeLimitsResponse]
readPrec :: ReadPrec DescribeLimitsResponse
$creadPrec :: ReadPrec DescribeLimitsResponse
readList :: ReadS [DescribeLimitsResponse]
$creadList :: ReadS [DescribeLimitsResponse]
readsPrec :: Int -> ReadS DescribeLimitsResponse
$creadsPrec :: Int -> ReadS DescribeLimitsResponse
Prelude.Read, Int -> DescribeLimitsResponse -> ShowS
[DescribeLimitsResponse] -> ShowS
DescribeLimitsResponse -> String
(Int -> DescribeLimitsResponse -> ShowS)
-> (DescribeLimitsResponse -> String)
-> ([DescribeLimitsResponse] -> ShowS)
-> Show DescribeLimitsResponse
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeLimitsResponse] -> ShowS
$cshowList :: [DescribeLimitsResponse] -> ShowS
show :: DescribeLimitsResponse -> String
$cshow :: DescribeLimitsResponse -> String
showsPrec :: Int -> DescribeLimitsResponse -> ShowS
$cshowsPrec :: Int -> DescribeLimitsResponse -> ShowS
Prelude.Show, (forall x. DescribeLimitsResponse -> Rep DescribeLimitsResponse x)
-> (forall x.
    Rep DescribeLimitsResponse x -> DescribeLimitsResponse)
-> Generic DescribeLimitsResponse
forall x. Rep DescribeLimitsResponse x -> DescribeLimitsResponse
forall x. DescribeLimitsResponse -> Rep DescribeLimitsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeLimitsResponse x -> DescribeLimitsResponse
$cfrom :: forall x. DescribeLimitsResponse -> Rep DescribeLimitsResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeLimitsResponse' 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:
--
-- 'httpStatus', 'describeLimitsResponse_httpStatus' - The response's http status code.
--
-- 'shardLimit', 'describeLimitsResponse_shardLimit' - The maximum number of shards.
--
-- 'openShardCount', 'describeLimitsResponse_openShardCount' - The number of open shards.
newDescribeLimitsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  -- | 'shardLimit'
  Prelude.Natural ->
  -- | 'openShardCount'
  Prelude.Natural ->
  DescribeLimitsResponse
newDescribeLimitsResponse :: Int -> Natural -> Natural -> DescribeLimitsResponse
newDescribeLimitsResponse
  Int
pHttpStatus_
  Natural
pShardLimit_
  Natural
pOpenShardCount_ =
    DescribeLimitsResponse' :: Int -> Natural -> Natural -> DescribeLimitsResponse
DescribeLimitsResponse'
      { $sel:httpStatus:DescribeLimitsResponse' :: Int
httpStatus = Int
pHttpStatus_,
        $sel:shardLimit:DescribeLimitsResponse' :: Natural
shardLimit = Natural
pShardLimit_,
        $sel:openShardCount:DescribeLimitsResponse' :: Natural
openShardCount = Natural
pOpenShardCount_
      }

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

-- | The maximum number of shards.
describeLimitsResponse_shardLimit :: Lens.Lens' DescribeLimitsResponse Prelude.Natural
describeLimitsResponse_shardLimit :: (Natural -> f Natural)
-> DescribeLimitsResponse -> f DescribeLimitsResponse
describeLimitsResponse_shardLimit = (DescribeLimitsResponse -> Natural)
-> (DescribeLimitsResponse -> Natural -> DescribeLimitsResponse)
-> Lens
     DescribeLimitsResponse DescribeLimitsResponse Natural Natural
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeLimitsResponse' {Natural
shardLimit :: Natural
$sel:shardLimit:DescribeLimitsResponse' :: DescribeLimitsResponse -> Natural
shardLimit} -> Natural
shardLimit) (\s :: DescribeLimitsResponse
s@DescribeLimitsResponse' {} Natural
a -> DescribeLimitsResponse
s {$sel:shardLimit:DescribeLimitsResponse' :: Natural
shardLimit = Natural
a} :: DescribeLimitsResponse)

-- | The number of open shards.
describeLimitsResponse_openShardCount :: Lens.Lens' DescribeLimitsResponse Prelude.Natural
describeLimitsResponse_openShardCount :: (Natural -> f Natural)
-> DescribeLimitsResponse -> f DescribeLimitsResponse
describeLimitsResponse_openShardCount = (DescribeLimitsResponse -> Natural)
-> (DescribeLimitsResponse -> Natural -> DescribeLimitsResponse)
-> Lens
     DescribeLimitsResponse DescribeLimitsResponse Natural Natural
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeLimitsResponse' {Natural
openShardCount :: Natural
$sel:openShardCount:DescribeLimitsResponse' :: DescribeLimitsResponse -> Natural
openShardCount} -> Natural
openShardCount) (\s :: DescribeLimitsResponse
s@DescribeLimitsResponse' {} Natural
a -> DescribeLimitsResponse
s {$sel:openShardCount:DescribeLimitsResponse' :: Natural
openShardCount = Natural
a} :: DescribeLimitsResponse)

instance Prelude.NFData DescribeLimitsResponse