amazonka-kms-1.6.1: 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.RevokeGrant

Contents

Description

Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

Synopsis

Creating a Request

revokeGrant Source #

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

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

  • rKeyId - A unique identifier for the customer master key associated with the grant. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN. For example: * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey .
  • rGrantId - Identifier of the grant to be revoked.

data RevokeGrant Source #

See: revokeGrant smart constructor.

Instances
Eq RevokeGrant Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

Data RevokeGrant Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RevokeGrant -> c RevokeGrant #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RevokeGrant #

toConstr :: RevokeGrant -> Constr #

dataTypeOf :: RevokeGrant -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RevokeGrant) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RevokeGrant) #

gmapT :: (forall b. Data b => b -> b) -> RevokeGrant -> RevokeGrant #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RevokeGrant -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RevokeGrant -> r #

gmapQ :: (forall d. Data d => d -> u) -> RevokeGrant -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RevokeGrant -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RevokeGrant -> m RevokeGrant #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RevokeGrant -> m RevokeGrant #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RevokeGrant -> m RevokeGrant #

Read RevokeGrant Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

Show RevokeGrant Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

Generic RevokeGrant Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

Associated Types

type Rep RevokeGrant :: Type -> Type #

Hashable RevokeGrant Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

ToJSON RevokeGrant Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

AWSRequest RevokeGrant Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

Associated Types

type Rs RevokeGrant :: Type #

ToHeaders RevokeGrant Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

Methods

toHeaders :: RevokeGrant -> [Header] #

ToPath RevokeGrant Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

ToQuery RevokeGrant Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

NFData RevokeGrant Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

Methods

rnf :: RevokeGrant -> () #

type Rep RevokeGrant Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

type Rep RevokeGrant = D1 (MetaData "RevokeGrant" "Network.AWS.KMS.RevokeGrant" "amazonka-kms-1.6.1-1UDljZYfeha1jjHbbMax4v" False) (C1 (MetaCons "RevokeGrant'" PrefixI True) (S1 (MetaSel (Just "_rKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_rGrantId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))
type Rs RevokeGrant Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

Request Lenses

rKeyId :: Lens' RevokeGrant Text Source #

A unique identifier for the customer master key associated with the grant. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN. For example: * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey .

rGrantId :: Lens' RevokeGrant Text Source #

Identifier of the grant to be revoked.

Destructuring the Response

revokeGrantResponse :: RevokeGrantResponse Source #

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

data RevokeGrantResponse Source #

See: revokeGrantResponse smart constructor.

Instances
Eq RevokeGrantResponse Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

Data RevokeGrantResponse Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RevokeGrantResponse -> c RevokeGrantResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RevokeGrantResponse #

toConstr :: RevokeGrantResponse -> Constr #

dataTypeOf :: RevokeGrantResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RevokeGrantResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RevokeGrantResponse) #

gmapT :: (forall b. Data b => b -> b) -> RevokeGrantResponse -> RevokeGrantResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RevokeGrantResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RevokeGrantResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> RevokeGrantResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RevokeGrantResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RevokeGrantResponse -> m RevokeGrantResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RevokeGrantResponse -> m RevokeGrantResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RevokeGrantResponse -> m RevokeGrantResponse #

Read RevokeGrantResponse Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

Show RevokeGrantResponse Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

Generic RevokeGrantResponse Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

Associated Types

type Rep RevokeGrantResponse :: Type -> Type #

NFData RevokeGrantResponse Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

Methods

rnf :: RevokeGrantResponse -> () #

type Rep RevokeGrantResponse Source # 
Instance details

Defined in Network.AWS.KMS.RevokeGrant

type Rep RevokeGrantResponse = D1 (MetaData "RevokeGrantResponse" "Network.AWS.KMS.RevokeGrant" "amazonka-kms-1.6.1-1UDljZYfeha1jjHbbMax4v" False) (C1 (MetaCons "RevokeGrantResponse'" PrefixI False) (U1 :: Type -> Type))