{-# 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.CognitoIdentityProvider.AdminDeleteUser
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Deletes a user as an administrator. Works on any user.
--
-- Calling this action requires developer credentials.
module Amazonka.CognitoIdentityProvider.AdminDeleteUser
  ( -- * Creating a Request
    AdminDeleteUser (..),
    newAdminDeleteUser,

    -- * Request Lenses
    adminDeleteUser_userPoolId,
    adminDeleteUser_username,

    -- * Destructuring the Response
    AdminDeleteUserResponse (..),
    newAdminDeleteUserResponse,
  )
where

import Amazonka.CognitoIdentityProvider.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

-- | Represents the request to delete a user as an administrator.
--
-- /See:/ 'newAdminDeleteUser' smart constructor.
data AdminDeleteUser = AdminDeleteUser'
  { -- | The user pool ID for the user pool where you want to delete the user.
    AdminDeleteUser -> Text
userPoolId :: Prelude.Text,
    -- | The user name of the user you want to delete.
    AdminDeleteUser -> Sensitive Text
username :: Data.Sensitive Prelude.Text
  }
  deriving (AdminDeleteUser -> AdminDeleteUser -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AdminDeleteUser -> AdminDeleteUser -> Bool
$c/= :: AdminDeleteUser -> AdminDeleteUser -> Bool
== :: AdminDeleteUser -> AdminDeleteUser -> Bool
$c== :: AdminDeleteUser -> AdminDeleteUser -> Bool
Prelude.Eq, Int -> AdminDeleteUser -> ShowS
[AdminDeleteUser] -> ShowS
AdminDeleteUser -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AdminDeleteUser] -> ShowS
$cshowList :: [AdminDeleteUser] -> ShowS
show :: AdminDeleteUser -> String
$cshow :: AdminDeleteUser -> String
showsPrec :: Int -> AdminDeleteUser -> ShowS
$cshowsPrec :: Int -> AdminDeleteUser -> ShowS
Prelude.Show, forall x. Rep AdminDeleteUser x -> AdminDeleteUser
forall x. AdminDeleteUser -> Rep AdminDeleteUser x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep AdminDeleteUser x -> AdminDeleteUser
$cfrom :: forall x. AdminDeleteUser -> Rep AdminDeleteUser x
Prelude.Generic)

-- |
-- Create a value of 'AdminDeleteUser' 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:
--
-- 'userPoolId', 'adminDeleteUser_userPoolId' - The user pool ID for the user pool where you want to delete the user.
--
-- 'username', 'adminDeleteUser_username' - The user name of the user you want to delete.
newAdminDeleteUser ::
  -- | 'userPoolId'
  Prelude.Text ->
  -- | 'username'
  Prelude.Text ->
  AdminDeleteUser
newAdminDeleteUser :: Text -> Text -> AdminDeleteUser
newAdminDeleteUser Text
pUserPoolId_ Text
pUsername_ =
  AdminDeleteUser'
    { $sel:userPoolId:AdminDeleteUser' :: Text
userPoolId = Text
pUserPoolId_,
      $sel:username:AdminDeleteUser' :: Sensitive Text
username = forall a. Iso' (Sensitive a) a
Data._Sensitive forall t b. AReview t b -> b -> t
Lens.# Text
pUsername_
    }

-- | The user pool ID for the user pool where you want to delete the user.
adminDeleteUser_userPoolId :: Lens.Lens' AdminDeleteUser Prelude.Text
adminDeleteUser_userPoolId :: Lens' AdminDeleteUser Text
adminDeleteUser_userPoolId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AdminDeleteUser' {Text
userPoolId :: Text
$sel:userPoolId:AdminDeleteUser' :: AdminDeleteUser -> Text
userPoolId} -> Text
userPoolId) (\s :: AdminDeleteUser
s@AdminDeleteUser' {} Text
a -> AdminDeleteUser
s {$sel:userPoolId:AdminDeleteUser' :: Text
userPoolId = Text
a} :: AdminDeleteUser)

-- | The user name of the user you want to delete.
adminDeleteUser_username :: Lens.Lens' AdminDeleteUser Prelude.Text
adminDeleteUser_username :: Lens' AdminDeleteUser Text
adminDeleteUser_username = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AdminDeleteUser' {Sensitive Text
username :: Sensitive Text
$sel:username:AdminDeleteUser' :: AdminDeleteUser -> Sensitive Text
username} -> Sensitive Text
username) (\s :: AdminDeleteUser
s@AdminDeleteUser' {} Sensitive Text
a -> AdminDeleteUser
s {$sel:username:AdminDeleteUser' :: Sensitive Text
username = Sensitive Text
a} :: AdminDeleteUser) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a. Iso' (Sensitive a) a
Data._Sensitive

instance Core.AWSRequest AdminDeleteUser where
  type
    AWSResponse AdminDeleteUser =
      AdminDeleteUserResponse
  request :: (Service -> Service) -> AdminDeleteUser -> Request AdminDeleteUser
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy AdminDeleteUser
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse AdminDeleteUser)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
AWSResponse a
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveNull AdminDeleteUserResponse
AdminDeleteUserResponse'

instance Prelude.Hashable AdminDeleteUser where
  hashWithSalt :: Int -> AdminDeleteUser -> Int
hashWithSalt Int
_salt AdminDeleteUser' {Text
Sensitive Text
username :: Sensitive Text
userPoolId :: Text
$sel:username:AdminDeleteUser' :: AdminDeleteUser -> Sensitive Text
$sel:userPoolId:AdminDeleteUser' :: AdminDeleteUser -> Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
userPoolId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Sensitive Text
username

instance Prelude.NFData AdminDeleteUser where
  rnf :: AdminDeleteUser -> ()
rnf AdminDeleteUser' {Text
Sensitive Text
username :: Sensitive Text
userPoolId :: Text
$sel:username:AdminDeleteUser' :: AdminDeleteUser -> Sensitive Text
$sel:userPoolId:AdminDeleteUser' :: AdminDeleteUser -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
userPoolId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Sensitive Text
username

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

instance Data.ToJSON AdminDeleteUser where
  toJSON :: AdminDeleteUser -> Value
toJSON AdminDeleteUser' {Text
Sensitive Text
username :: Sensitive Text
userPoolId :: Text
$sel:username:AdminDeleteUser' :: AdminDeleteUser -> Sensitive Text
$sel:userPoolId:AdminDeleteUser' :: AdminDeleteUser -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just (Key
"UserPoolId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
userPoolId),
            forall a. a -> Maybe a
Prelude.Just (Key
"Username" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Sensitive Text
username)
          ]
      )

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

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

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

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

instance Prelude.NFData AdminDeleteUserResponse where
  rnf :: AdminDeleteUserResponse -> ()
rnf AdminDeleteUserResponse
_ = ()