{-# 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.KMS.DeleteAlias
-- 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)
--
-- Deletes the specified alias.
--
-- Adding, deleting, or updating an alias can allow or deny permission to
-- the KMS key. For details, see
-- <https://docs.aws.amazon.com/kms/latest/developerguide/abac.html Using ABAC in KMS>
-- in the /Key Management Service Developer Guide/.
--
-- Because an alias is not a property of a KMS key, you can delete and
-- change the aliases of a KMS key without affecting the KMS key. Also,
-- aliases do not appear in the response from the DescribeKey operation. To
-- get the aliases of all KMS keys, use the ListAliases operation.
--
-- Each KMS key can have multiple aliases. To change the alias of a KMS
-- key, use DeleteAlias to delete the current alias and CreateAlias to
-- create a new alias. To associate an existing alias with a different KMS
-- key, call UpdateAlias.
--
-- __Cross-account use__: No. You cannot perform this operation on an alias
-- in a different Amazon Web Services account.
--
-- __Required permissions__
--
-- -   <https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html kms:DeleteAlias>
--     on the alias (IAM policy).
--
-- -   <https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html kms:DeleteAlias>
--     on the KMS key (key policy).
--
-- For details, see
-- <https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access Controlling access to aliases>
-- in the /Key Management Service Developer Guide/.
--
-- __Related operations:__
--
-- -   CreateAlias
--
-- -   ListAliases
--
-- -   UpdateAlias
module Amazonka.KMS.DeleteAlias
  ( -- * Creating a Request
    DeleteAlias (..),
    newDeleteAlias,

    -- * Request Lenses
    deleteAlias_aliasName,

    -- * Destructuring the Response
    DeleteAliasResponse (..),
    newDeleteAliasResponse,
  )
where

import qualified Amazonka.Core as Core
import Amazonka.KMS.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:/ 'newDeleteAlias' smart constructor.
data DeleteAlias = DeleteAlias'
  { -- | The alias to be deleted. The alias name must begin with @alias\/@
    -- followed by the alias name, such as @alias\/ExampleAlias@.
    DeleteAlias -> Text
aliasName :: Prelude.Text
  }
  deriving (DeleteAlias -> DeleteAlias -> Bool
(DeleteAlias -> DeleteAlias -> Bool)
-> (DeleteAlias -> DeleteAlias -> Bool) -> Eq DeleteAlias
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DeleteAlias -> DeleteAlias -> Bool
$c/= :: DeleteAlias -> DeleteAlias -> Bool
== :: DeleteAlias -> DeleteAlias -> Bool
$c== :: DeleteAlias -> DeleteAlias -> Bool
Prelude.Eq, ReadPrec [DeleteAlias]
ReadPrec DeleteAlias
Int -> ReadS DeleteAlias
ReadS [DeleteAlias]
(Int -> ReadS DeleteAlias)
-> ReadS [DeleteAlias]
-> ReadPrec DeleteAlias
-> ReadPrec [DeleteAlias]
-> Read DeleteAlias
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DeleteAlias]
$creadListPrec :: ReadPrec [DeleteAlias]
readPrec :: ReadPrec DeleteAlias
$creadPrec :: ReadPrec DeleteAlias
readList :: ReadS [DeleteAlias]
$creadList :: ReadS [DeleteAlias]
readsPrec :: Int -> ReadS DeleteAlias
$creadsPrec :: Int -> ReadS DeleteAlias
Prelude.Read, Int -> DeleteAlias -> ShowS
[DeleteAlias] -> ShowS
DeleteAlias -> String
(Int -> DeleteAlias -> ShowS)
-> (DeleteAlias -> String)
-> ([DeleteAlias] -> ShowS)
-> Show DeleteAlias
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DeleteAlias] -> ShowS
$cshowList :: [DeleteAlias] -> ShowS
show :: DeleteAlias -> String
$cshow :: DeleteAlias -> String
showsPrec :: Int -> DeleteAlias -> ShowS
$cshowsPrec :: Int -> DeleteAlias -> ShowS
Prelude.Show, (forall x. DeleteAlias -> Rep DeleteAlias x)
-> (forall x. Rep DeleteAlias x -> DeleteAlias)
-> Generic DeleteAlias
forall x. Rep DeleteAlias x -> DeleteAlias
forall x. DeleteAlias -> Rep DeleteAlias x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DeleteAlias x -> DeleteAlias
$cfrom :: forall x. DeleteAlias -> Rep DeleteAlias x
Prelude.Generic)

-- |
-- Create a value of 'DeleteAlias' 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:
--
-- 'aliasName', 'deleteAlias_aliasName' - The alias to be deleted. The alias name must begin with @alias\/@
-- followed by the alias name, such as @alias\/ExampleAlias@.
newDeleteAlias ::
  -- | 'aliasName'
  Prelude.Text ->
  DeleteAlias
newDeleteAlias :: Text -> DeleteAlias
newDeleteAlias Text
pAliasName_ =
  DeleteAlias' :: Text -> DeleteAlias
DeleteAlias' {$sel:aliasName:DeleteAlias' :: Text
aliasName = Text
pAliasName_}

-- | The alias to be deleted. The alias name must begin with @alias\/@
-- followed by the alias name, such as @alias\/ExampleAlias@.
deleteAlias_aliasName :: Lens.Lens' DeleteAlias Prelude.Text
deleteAlias_aliasName :: (Text -> f Text) -> DeleteAlias -> f DeleteAlias
deleteAlias_aliasName = (DeleteAlias -> Text)
-> (DeleteAlias -> Text -> DeleteAlias)
-> Lens DeleteAlias DeleteAlias Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DeleteAlias' {Text
aliasName :: Text
$sel:aliasName:DeleteAlias' :: DeleteAlias -> Text
aliasName} -> Text
aliasName) (\s :: DeleteAlias
s@DeleteAlias' {} Text
a -> DeleteAlias
s {$sel:aliasName:DeleteAlias' :: Text
aliasName = Text
a} :: DeleteAlias)

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

instance Prelude.Hashable DeleteAlias

instance Prelude.NFData DeleteAlias

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

instance Core.ToJSON DeleteAlias where
  toJSON :: DeleteAlias -> Value
toJSON DeleteAlias' {Text
aliasName :: Text
$sel:aliasName:DeleteAlias' :: DeleteAlias -> 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
"AliasName" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
aliasName)]
      )

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

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

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

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

instance Prelude.NFData DeleteAliasResponse