Network.AWS.KMS.RetireGrant

Retires a grant. You can retire a grant when you're done using it to clean up. 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 account that created the grant
• The RetiringPrincipal, if present
• The GranteePrincipal, if RetireGrant is a grantee operation

The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the CreateGrant function.

Creating a Request

retireGrant :: RetireGrant

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
• rgGrantId
• rgGrantToken

data RetireGrant

See: retireGrant smart constructor.

Instances

Eq RetireGrant

Methods

(==) :: RetireGrant -> RetireGrant -> Bool

(/=) :: RetireGrant -> RetireGrant -> Bool

Data 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

Methods

readsPrec :: Int -> ReadS RetireGrant

readList :: ReadS [RetireGrant]

readPrec :: ReadPrec RetireGrant

readListPrec :: ReadPrec [RetireGrant]

Show RetireGrant

Methods

showsPrec :: Int -> RetireGrant -> ShowS

show :: RetireGrant -> String

showList :: [RetireGrant] -> ShowS

Generic RetireGrant

Associated Types

type Rep RetireGrant :: * -> *

Methods

from :: RetireGrant -> Rep RetireGrant x

to :: Rep RetireGrant x -> RetireGrant

Hashable RetireGrant

Methods

hashWithSalt :: Int -> RetireGrant -> Int

hash :: RetireGrant -> Int

ToJSON RetireGrant

Methods

toJSON :: RetireGrant -> Value

toEncoding :: RetireGrant -> Encoding

toJSONList :: [RetireGrant] -> Value

toEncodingList :: [RetireGrant] -> Encoding

NFData RetireGrant

Methods

rnf :: RetireGrant -> ()

AWSRequest RetireGrant

Associated Types

type Rs RetireGrant :: *

Methods

request :: RetireGrant -> Request RetireGrant

response :: MonadResource m => Logger -> Service -> Proxy * RetireGrant -> ClientResponse -> m (Response RetireGrant)

ToQuery RetireGrant

Methods

toQuery :: RetireGrant -> QueryString

ToPath RetireGrant

Methods

toPath :: RetireGrant -> ByteString

ToHeaders RetireGrant

Methods

toHeaders :: RetireGrant -> [Header]

type Rep RetireGrant

type Rep RetireGrant = D1 (MetaData "RetireGrant" "Network.AWS.KMS.RetireGrant" "amazonka-kms-1.4.1-GF628EecSPSCenC7tCeKjK" False) (C1 (MetaCons "RetireGrant'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rgKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rgGrantId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rgGrantToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Rs RetireGrant

type Rs RetireGrant = RetireGrantResponse

Request Lenses

rgKeyId :: Lens' RetireGrant (Maybe Text)

A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or a fully specified ARN of the key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

rgGrantId :: Lens' RetireGrant (Maybe Text)

Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

rgGrantToken :: Lens' RetireGrant (Maybe Text)

Token that identifies the grant to be retired.

Destructuring the Response

retireGrantResponse :: RetireGrantResponse

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

data RetireGrantResponse

See: retireGrantResponse smart constructor.

Instances

Eq RetireGrantResponse

Methods

(==) :: RetireGrantResponse -> RetireGrantResponse -> Bool

(/=) :: RetireGrantResponse -> RetireGrantResponse -> Bool

Data RetireGrantResponse

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

Methods

readsPrec :: Int -> ReadS RetireGrantResponse

readList :: ReadS [RetireGrantResponse]

readPrec :: ReadPrec RetireGrantResponse

readListPrec :: ReadPrec [RetireGrantResponse]

Show RetireGrantResponse

Methods

showsPrec :: Int -> RetireGrantResponse -> ShowS

show :: RetireGrantResponse -> String

showList :: [RetireGrantResponse] -> ShowS

Generic RetireGrantResponse

Associated Types

type Rep RetireGrantResponse :: * -> *

Methods

from :: RetireGrantResponse -> Rep RetireGrantResponse x

to :: Rep RetireGrantResponse x -> RetireGrantResponse

NFData RetireGrantResponse

Methods

rnf :: RetireGrantResponse -> ()

type Rep RetireGrantResponse

type Rep RetireGrantResponse = D1 (MetaData "RetireGrantResponse" "Network.AWS.KMS.RetireGrant" "amazonka-kms-1.4.1-GF628EecSPSCenC7tCeKjK" False) (C1 (MetaCons "RetireGrantResponse'" PrefixI False) U1)