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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.

A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant .

Creating a Request

listRetirableGrants #

Arguments

:: Text	`lrgRetiringPrincipal`
-> ListRetirableGrants

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

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

lrgMarker - Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.
lrgLimit - Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
lrgRetiringPrincipal - The retiring principal for which to list grants. To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference .

data ListRetirableGrants #

See: listRetirableGrants smart constructor.

Instances

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

Request Lenses

lrgMarker :: Lens' ListRetirableGrants (Maybe Text) #

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

lrgLimit :: Lens' ListRetirableGrants (Maybe Natural) #

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

lrgRetiringPrincipal :: Lens' ListRetirableGrants Text #

The retiring principal for which to list grants. To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference .

Destructuring the Response

listGrantsResponse :: ListGrantsResponse #

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

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

lgTruncated - A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
lgGrants - A list of grants.
lgNextMarker - When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

data ListGrantsResponse #

See: listGrantsResponse smart constructor.

Instances

Eq ListGrantsResponse #
Instance details Defined in Network.AWS.KMS.Types.Product Methods (==) :: ListGrantsResponse -> ListGrantsResponse -> Bool # (/=) :: ListGrantsResponse -> ListGrantsResponse -> Bool #
Data ListGrantsResponse #
Instance details Defined in Network.AWS.KMS.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListGrantsResponse -> c ListGrantsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListGrantsResponse # toConstr :: ListGrantsResponse -> Constr # dataTypeOf :: ListGrantsResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListGrantsResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListGrantsResponse) # gmapT :: (forall b. Data b => b -> b) -> ListGrantsResponse -> ListGrantsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListGrantsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListGrantsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> ListGrantsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListGrantsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListGrantsResponse -> m ListGrantsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListGrantsResponse -> m ListGrantsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListGrantsResponse -> m ListGrantsResponse #
Read ListGrantsResponse #
Instance details Defined in Network.AWS.KMS.Types.Product Methods readsPrec :: Int -> ReadS ListGrantsResponse # readList :: ReadS [ListGrantsResponse] # readPrec :: ReadPrec ListGrantsResponse # readListPrec :: ReadPrec [ListGrantsResponse] #
Show ListGrantsResponse #
Instance details Defined in Network.AWS.KMS.Types.Product Methods showsPrec :: Int -> ListGrantsResponse -> ShowS # show :: ListGrantsResponse -> String # showList :: [ListGrantsResponse] -> ShowS #
Generic ListGrantsResponse #
Instance details Defined in Network.AWS.KMS.Types.Product Associated Types type Rep ListGrantsResponse :: * -> * # Methods from :: ListGrantsResponse -> Rep ListGrantsResponse x # to :: Rep ListGrantsResponse x -> ListGrantsResponse #
Hashable ListGrantsResponse #
Instance details Defined in Network.AWS.KMS.Types.Product Methods hashWithSalt :: Int -> ListGrantsResponse -> Int # hash :: ListGrantsResponse -> Int #
FromJSON ListGrantsResponse #
Instance details Defined in Network.AWS.KMS.Types.Product Methods parseJSON :: Value -> Parser ListGrantsResponse # parseJSONList :: Value -> Parser [ListGrantsResponse] #
NFData ListGrantsResponse #
Instance details Defined in Network.AWS.KMS.Types.Product Methods rnf :: ListGrantsResponse -> () #
type Rep ListGrantsResponse #
Instance details Defined in Network.AWS.KMS.Types.Product type Rep ListGrantsResponse = D1 (MetaData "ListGrantsResponse" "Network.AWS.KMS.Types.Product" "amazonka-kms-1.6.0-J0DpkKKCQ2By8yYSyE2w7" False) (C1 (MetaCons "ListGrantsResponse'" PrefixI True) (S1 (MetaSel (Just "_lgTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 (MetaSel (Just "_lgGrants") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GrantListEntry])) :: S1 (MetaSel (Just "_lgNextMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))

Response Lenses

lgTruncated :: Lens' ListGrantsResponse (Maybe Bool) #

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.

lgGrants :: Lens' ListGrantsResponse [GrantListEntry] #

A list of grants.

lgNextMarker :: Lens' ListGrantsResponse (Maybe Text) #

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.