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.RetireGrant

Contents

Description

Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:

  • The AWS account (root user) under which the grant was created
  • The RetiringPrincipal , if present in the grant
  • The GranteePrincipal , if RetireGrant is an operation specified in the grant

You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.

Synopsis

Creating a Request

retireGrant :: RetireGrant Source #

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

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

  • rgKeyId - The Amazon Resource Name (ARN) of the CMK associated with the grant. For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab
  • rgGrantId - Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation. * Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
  • rgGrantToken - Token that identifies the grant to be retired.

data RetireGrant Source #

See: retireGrant smart constructor.

Instances
Eq RetireGrant Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

Data RetireGrant Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

Methods

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

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

toConstr :: RetireGrant -> Constr #

dataTypeOf :: RetireGrant -> DataType #

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

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

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

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

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

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

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

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

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

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

Read RetireGrant Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

Show RetireGrant Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

Generic RetireGrant Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

Associated Types

type Rep RetireGrant :: Type -> Type #

Hashable RetireGrant Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

ToJSON RetireGrant Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

AWSRequest RetireGrant Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

Associated Types

type Rs RetireGrant :: Type #

ToHeaders RetireGrant Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

Methods

toHeaders :: RetireGrant -> [Header] #

ToPath RetireGrant Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

ToQuery RetireGrant Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

NFData RetireGrant Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

Methods

rnf :: RetireGrant -> () #

type Rep RetireGrant Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

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

Defined in Network.AWS.KMS.RetireGrant

Request Lenses

rgKeyId :: Lens' RetireGrant (Maybe Text) Source #

The Amazon Resource Name (ARN) of the CMK associated with the grant. For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

rgGrantId :: Lens' RetireGrant (Maybe Text) Source #

Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation. * Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

rgGrantToken :: Lens' RetireGrant (Maybe Text) Source #

Token that identifies the grant to be retired.

Destructuring the Response

retireGrantResponse :: RetireGrantResponse Source #

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

data RetireGrantResponse Source #

See: retireGrantResponse smart constructor.

Instances
Eq RetireGrantResponse Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

Data RetireGrantResponse Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

Methods

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

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

toConstr :: RetireGrantResponse -> Constr #

dataTypeOf :: RetireGrantResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read RetireGrantResponse Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

Show RetireGrantResponse Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

Generic RetireGrantResponse Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

Associated Types

type Rep RetireGrantResponse :: Type -> Type #

NFData RetireGrantResponse Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

Methods

rnf :: RetireGrantResponse -> () #

type Rep RetireGrantResponse Source # 
Instance details

Defined in Network.AWS.KMS.RetireGrant

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