Copyright	(c) 2013-2018 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)
Safe Haskell	None
Language	Haskell2010

Network.AWS.KMS.DeleteAlias

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account.

Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.

Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call UpdateAlias .

Synopsis

deleteAlias :: Text -> DeleteAlias
data DeleteAlias
daAliasName :: Lens' DeleteAlias Text
deleteAliasResponse :: DeleteAliasResponse
data DeleteAliasResponse

Creating a Request

deleteAlias #

Arguments

:: Text	`daAliasName`
-> DeleteAlias

Creates a value of DeleteAlias with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

daAliasName - The alias to be deleted. The name must start with the word "alias" followed by a forward slash (alias). Aliases that begin with "aliasaws" are reserved.

data DeleteAlias #

See: deleteAlias smart constructor.

Instances

Eq DeleteAlias #
Instance details Defined in Network.AWS.KMS.DeleteAlias Methods (==) :: DeleteAlias -> DeleteAlias -> Bool # (/=) :: DeleteAlias -> DeleteAlias -> Bool #
Data DeleteAlias #
Instance details Defined in Network.AWS.KMS.DeleteAlias Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteAlias -> c DeleteAlias # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteAlias # toConstr :: DeleteAlias -> Constr # dataTypeOf :: DeleteAlias -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DeleteAlias) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteAlias) # gmapT :: (forall b. Data b => b -> b) -> DeleteAlias -> DeleteAlias # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteAlias -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteAlias -> r # gmapQ :: (forall d. Data d => d -> u) -> DeleteAlias -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteAlias -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteAlias -> m DeleteAlias # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteAlias -> m DeleteAlias # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteAlias -> m DeleteAlias #
Read DeleteAlias #
Instance details Defined in Network.AWS.KMS.DeleteAlias Methods readsPrec :: Int -> ReadS DeleteAlias # readList :: ReadS [DeleteAlias] # readPrec :: ReadPrec DeleteAlias # readListPrec :: ReadPrec [DeleteAlias] #
Show DeleteAlias #
Instance details Defined in Network.AWS.KMS.DeleteAlias Methods showsPrec :: Int -> DeleteAlias -> ShowS # show :: DeleteAlias -> String # showList :: [DeleteAlias] -> ShowS #
Generic DeleteAlias #
Instance details Defined in Network.AWS.KMS.DeleteAlias Associated Types type Rep DeleteAlias :: * -> * # Methods from :: DeleteAlias -> Rep DeleteAlias x # to :: Rep DeleteAlias x -> DeleteAlias #
Hashable DeleteAlias #
Instance details Defined in Network.AWS.KMS.DeleteAlias Methods hashWithSalt :: Int -> DeleteAlias -> Int # hash :: DeleteAlias -> Int #
ToJSON DeleteAlias #
Instance details Defined in Network.AWS.KMS.DeleteAlias Methods toJSON :: DeleteAlias -> Value # toEncoding :: DeleteAlias -> Encoding # toJSONList :: [DeleteAlias] -> Value # toEncodingList :: [DeleteAlias] -> Encoding #
AWSRequest DeleteAlias #
Instance details Defined in Network.AWS.KMS.DeleteAlias Associated Types type Rs DeleteAlias :: * # Methods request :: DeleteAlias -> Request DeleteAlias # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DeleteAlias -> ClientResponse -> m (Response DeleteAlias) #
ToHeaders DeleteAlias #
Instance details Defined in Network.AWS.KMS.DeleteAlias Methods toHeaders :: DeleteAlias -> [Header] #
ToPath DeleteAlias #
Instance details Defined in Network.AWS.KMS.DeleteAlias Methods toPath :: DeleteAlias -> ByteString #
ToQuery DeleteAlias #
Instance details Defined in Network.AWS.KMS.DeleteAlias Methods toQuery :: DeleteAlias -> QueryString #
NFData DeleteAlias #
Instance details Defined in Network.AWS.KMS.DeleteAlias Methods rnf :: DeleteAlias -> () #
type Rep DeleteAlias #
Instance details Defined in Network.AWS.KMS.DeleteAlias type Rep DeleteAlias = D1 (MetaData "DeleteAlias" "Network.AWS.KMS.DeleteAlias" "amazonka-kms-1.6.0-J0DpkKKCQ2By8yYSyE2w7" True) (C1 (MetaCons "DeleteAlias'" PrefixI True) (S1 (MetaSel (Just "_daAliasName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs DeleteAlias #
Instance details Defined in Network.AWS.KMS.DeleteAlias type Rs DeleteAlias = DeleteAliasResponse

Request Lenses

daAliasName :: Lens' DeleteAlias Text #

The alias to be deleted. The name must start with the word "alias" followed by a forward slash (alias). Aliases that begin with "aliasaws" are reserved.

Destructuring the Response

deleteAliasResponse :: DeleteAliasResponse #

Creates a value of DeleteAliasResponse with the minimum fields required to make a request.

data DeleteAliasResponse #

See: deleteAliasResponse smart constructor.

Instances

Eq DeleteAliasResponse #
Instance details Defined in Network.AWS.KMS.DeleteAlias Methods (==) :: DeleteAliasResponse -> DeleteAliasResponse -> Bool # (/=) :: DeleteAliasResponse -> DeleteAliasResponse -> Bool #
Data DeleteAliasResponse #
Instance details Defined in Network.AWS.KMS.DeleteAlias Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteAliasResponse -> c DeleteAliasResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteAliasResponse # toConstr :: DeleteAliasResponse -> Constr # dataTypeOf :: DeleteAliasResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DeleteAliasResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteAliasResponse) # gmapT :: (forall b. Data b => b -> b) -> DeleteAliasResponse -> DeleteAliasResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteAliasResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteAliasResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DeleteAliasResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteAliasResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteAliasResponse -> m DeleteAliasResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteAliasResponse -> m DeleteAliasResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteAliasResponse -> m DeleteAliasResponse #
Read DeleteAliasResponse #
Instance details Defined in Network.AWS.KMS.DeleteAlias Methods readsPrec :: Int -> ReadS DeleteAliasResponse # readList :: ReadS [DeleteAliasResponse] # readPrec :: ReadPrec DeleteAliasResponse # readListPrec :: ReadPrec [DeleteAliasResponse] #
Show DeleteAliasResponse #
Instance details Defined in Network.AWS.KMS.DeleteAlias Methods showsPrec :: Int -> DeleteAliasResponse -> ShowS # show :: DeleteAliasResponse -> String # showList :: [DeleteAliasResponse] -> ShowS #
Generic DeleteAliasResponse #
Instance details Defined in Network.AWS.KMS.DeleteAlias Associated Types type Rep DeleteAliasResponse :: * -> * # Methods from :: DeleteAliasResponse -> Rep DeleteAliasResponse x # to :: Rep DeleteAliasResponse x -> DeleteAliasResponse #
NFData DeleteAliasResponse #
Instance details Defined in Network.AWS.KMS.DeleteAlias Methods rnf :: DeleteAliasResponse -> () #
type Rep DeleteAliasResponse #
Instance details Defined in Network.AWS.KMS.DeleteAlias type Rep DeleteAliasResponse = D1 (MetaData "DeleteAliasResponse" "Network.AWS.KMS.DeleteAlias" "amazonka-kms-1.6.0-J0DpkKKCQ2By8yYSyE2w7" False) (C1 (MetaCons "DeleteAliasResponse'" PrefixI False) (U1 :: * -> *))