{-# 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.APIGateway.UpdateApiKey
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Changes information about an ApiKey resource.
module Amazonka.APIGateway.UpdateApiKey
  ( -- * Creating a Request
    UpdateApiKey (..),
    newUpdateApiKey,

    -- * Request Lenses
    updateApiKey_patchOperations,
    updateApiKey_apiKey,

    -- * Destructuring the Response
    ApiKey (..),
    newApiKey,

    -- * Response Lenses
    apiKey_createdDate,
    apiKey_customerId,
    apiKey_description,
    apiKey_enabled,
    apiKey_id,
    apiKey_lastUpdatedDate,
    apiKey_name,
    apiKey_stageKeys,
    apiKey_tags,
    apiKey_value,
  )
where

import Amazonka.APIGateway.Types
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | A request to change information about an ApiKey resource.
--
-- /See:/ 'newUpdateApiKey' smart constructor.
data UpdateApiKey = UpdateApiKey'
  { -- | For more information about supported patch operations, see
    -- <https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html Patch Operations>.
    UpdateApiKey -> Maybe [PatchOperation]
patchOperations :: Prelude.Maybe [PatchOperation],
    -- | The identifier of the ApiKey resource to be updated.
    UpdateApiKey -> Text
apiKey :: Prelude.Text
  }
  deriving (UpdateApiKey -> UpdateApiKey -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: UpdateApiKey -> UpdateApiKey -> Bool
$c/= :: UpdateApiKey -> UpdateApiKey -> Bool
== :: UpdateApiKey -> UpdateApiKey -> Bool
$c== :: UpdateApiKey -> UpdateApiKey -> Bool
Prelude.Eq, ReadPrec [UpdateApiKey]
ReadPrec UpdateApiKey
Int -> ReadS UpdateApiKey
ReadS [UpdateApiKey]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [UpdateApiKey]
$creadListPrec :: ReadPrec [UpdateApiKey]
readPrec :: ReadPrec UpdateApiKey
$creadPrec :: ReadPrec UpdateApiKey
readList :: ReadS [UpdateApiKey]
$creadList :: ReadS [UpdateApiKey]
readsPrec :: Int -> ReadS UpdateApiKey
$creadsPrec :: Int -> ReadS UpdateApiKey
Prelude.Read, Int -> UpdateApiKey -> ShowS
[UpdateApiKey] -> ShowS
UpdateApiKey -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [UpdateApiKey] -> ShowS
$cshowList :: [UpdateApiKey] -> ShowS
show :: UpdateApiKey -> String
$cshow :: UpdateApiKey -> String
showsPrec :: Int -> UpdateApiKey -> ShowS
$cshowsPrec :: Int -> UpdateApiKey -> ShowS
Prelude.Show, forall x. Rep UpdateApiKey x -> UpdateApiKey
forall x. UpdateApiKey -> Rep UpdateApiKey x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep UpdateApiKey x -> UpdateApiKey
$cfrom :: forall x. UpdateApiKey -> Rep UpdateApiKey x
Prelude.Generic)

-- |
-- Create a value of 'UpdateApiKey' 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:
--
-- 'patchOperations', 'updateApiKey_patchOperations' - For more information about supported patch operations, see
-- <https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html Patch Operations>.
--
-- 'apiKey', 'updateApiKey_apiKey' - The identifier of the ApiKey resource to be updated.
newUpdateApiKey ::
  -- | 'apiKey'
  Prelude.Text ->
  UpdateApiKey
newUpdateApiKey :: Text -> UpdateApiKey
newUpdateApiKey Text
pApiKey_ =
  UpdateApiKey'
    { $sel:patchOperations:UpdateApiKey' :: Maybe [PatchOperation]
patchOperations = forall a. Maybe a
Prelude.Nothing,
      $sel:apiKey:UpdateApiKey' :: Text
apiKey = Text
pApiKey_
    }

-- | For more information about supported patch operations, see
-- <https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html Patch Operations>.
updateApiKey_patchOperations :: Lens.Lens' UpdateApiKey (Prelude.Maybe [PatchOperation])
updateApiKey_patchOperations :: Lens' UpdateApiKey (Maybe [PatchOperation])
updateApiKey_patchOperations = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UpdateApiKey' {Maybe [PatchOperation]
patchOperations :: Maybe [PatchOperation]
$sel:patchOperations:UpdateApiKey' :: UpdateApiKey -> Maybe [PatchOperation]
patchOperations} -> Maybe [PatchOperation]
patchOperations) (\s :: UpdateApiKey
s@UpdateApiKey' {} Maybe [PatchOperation]
a -> UpdateApiKey
s {$sel:patchOperations:UpdateApiKey' :: Maybe [PatchOperation]
patchOperations = Maybe [PatchOperation]
a} :: UpdateApiKey) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. 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 forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The identifier of the ApiKey resource to be updated.
updateApiKey_apiKey :: Lens.Lens' UpdateApiKey Prelude.Text
updateApiKey_apiKey :: Lens' UpdateApiKey Text
updateApiKey_apiKey = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UpdateApiKey' {Text
apiKey :: Text
$sel:apiKey:UpdateApiKey' :: UpdateApiKey -> Text
apiKey} -> Text
apiKey) (\s :: UpdateApiKey
s@UpdateApiKey' {} Text
a -> UpdateApiKey
s {$sel:apiKey:UpdateApiKey' :: Text
apiKey = Text
a} :: UpdateApiKey)

instance Core.AWSRequest UpdateApiKey where
  type AWSResponse UpdateApiKey = ApiKey
  request :: (Service -> Service) -> UpdateApiKey -> Request UpdateApiKey
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.patchJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy UpdateApiKey
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse UpdateApiKey)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      (\Int
s ResponseHeaders
h Object
x -> forall a. FromJSON a => Object -> Either String a
Data.eitherParseJSON Object
x)

instance Prelude.Hashable UpdateApiKey where
  hashWithSalt :: Int -> UpdateApiKey -> Int
hashWithSalt Int
_salt UpdateApiKey' {Maybe [PatchOperation]
Text
apiKey :: Text
patchOperations :: Maybe [PatchOperation]
$sel:apiKey:UpdateApiKey' :: UpdateApiKey -> Text
$sel:patchOperations:UpdateApiKey' :: UpdateApiKey -> Maybe [PatchOperation]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [PatchOperation]
patchOperations
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
apiKey

instance Prelude.NFData UpdateApiKey where
  rnf :: UpdateApiKey -> ()
rnf UpdateApiKey' {Maybe [PatchOperation]
Text
apiKey :: Text
patchOperations :: Maybe [PatchOperation]
$sel:apiKey:UpdateApiKey' :: UpdateApiKey -> Text
$sel:patchOperations:UpdateApiKey' :: UpdateApiKey -> Maybe [PatchOperation]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [PatchOperation]
patchOperations
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
apiKey

instance Data.ToHeaders UpdateApiKey where
  toHeaders :: UpdateApiKey -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"Accept"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# (ByteString
"application/json" :: Prelude.ByteString)
          ]
      )

instance Data.ToJSON UpdateApiKey where
  toJSON :: UpdateApiKey -> Value
toJSON UpdateApiKey' {Maybe [PatchOperation]
Text
apiKey :: Text
patchOperations :: Maybe [PatchOperation]
$sel:apiKey:UpdateApiKey' :: UpdateApiKey -> Text
$sel:patchOperations:UpdateApiKey' :: UpdateApiKey -> Maybe [PatchOperation]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"patchOperations" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [PatchOperation]
patchOperations
          ]
      )

instance Data.ToPath UpdateApiKey where
  toPath :: UpdateApiKey -> ByteString
toPath UpdateApiKey' {Maybe [PatchOperation]
Text
apiKey :: Text
patchOperations :: Maybe [PatchOperation]
$sel:apiKey:UpdateApiKey' :: UpdateApiKey -> Text
$sel:patchOperations:UpdateApiKey' :: UpdateApiKey -> Maybe [PatchOperation]
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat [ByteString
"/apikeys/", forall a. ToByteString a => a -> ByteString
Data.toBS Text
apiKey]

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