amazonka-kms-1.6.0: Amazon Key Management Service SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.KMS.DeleteAlias

Contents

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

Creating a Request

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 # 
Data 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 # 
Show DeleteAlias # 
Generic DeleteAlias # 

Associated Types

type Rep DeleteAlias :: * -> * #

Hashable DeleteAlias # 
ToJSON DeleteAlias # 
NFData DeleteAlias # 

Methods

rnf :: DeleteAlias -> () #

AWSRequest DeleteAlias # 
ToHeaders DeleteAlias # 

Methods

toHeaders :: DeleteAlias -> [Header] #

ToPath DeleteAlias # 
ToQuery DeleteAlias # 
type Rep DeleteAlias # 
type Rep DeleteAlias = D1 * (MetaData "DeleteAlias" "Network.AWS.KMS.DeleteAlias" "amazonka-kms-1.6.0-1x3YFaSKSJTDyirX3XbKEX" True) (C1 * (MetaCons "DeleteAlias'" PrefixI True) (S1 * (MetaSel (Just Symbol "_daAliasName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))
type Rs DeleteAlias # 

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 # 
Data DeleteAliasResponse # 

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 # 
Show DeleteAliasResponse # 
Generic DeleteAliasResponse # 
NFData DeleteAliasResponse # 

Methods

rnf :: DeleteAliasResponse -> () #

type Rep DeleteAliasResponse # 
type Rep DeleteAliasResponse = D1 * (MetaData "DeleteAliasResponse" "Network.AWS.KMS.DeleteAlias" "amazonka-kms-1.6.0-1x3YFaSKSJTDyirX3XbKEX" False) (C1 * (MetaCons "DeleteAliasResponse'" PrefixI False) (U1 *))