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

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

Network.AWS.KMS.ListGrants

Contents

Description

List the grants for a specified key.

This operation returns paginated results.

Synopsis

Creating a Request

listGrants #

Arguments

:: Text

lgKeyId

-> ListGrants 

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

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

  • lgMarker - Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.
  • lgLimit - When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true. 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.
  • lgKeyId - A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a 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

data ListGrants #

See: listGrants smart constructor.

Instances

Eq ListGrants # 
Data ListGrants # 

Methods

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

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

toConstr :: ListGrants -> Constr #

dataTypeOf :: ListGrants -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListGrants # 
Show ListGrants # 
Generic ListGrants # 

Associated Types

type Rep ListGrants :: * -> * #

Hashable ListGrants # 
ToJSON ListGrants # 
NFData ListGrants # 

Methods

rnf :: ListGrants -> () #

AWSPager ListGrants # 
AWSRequest ListGrants # 
ToQuery ListGrants # 
ToPath ListGrants # 
ToHeaders ListGrants # 

Methods

toHeaders :: ListGrants -> [Header] #

type Rep ListGrants # 
type Rep ListGrants = D1 (MetaData "ListGrants" "Network.AWS.KMS.ListGrants" "amazonka-kms-1.4.5-5KQpvh5Ruw27D0B5DkiMna" False) (C1 (MetaCons "ListGrants'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lgMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lgLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_lgKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs ListGrants # 

Request Lenses

lgMarker :: Lens' ListGrants (Maybe Text) #

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

lgLimit :: Lens' ListGrants (Maybe Natural) #

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true. 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.

lgKeyId :: Lens' ListGrants Text #

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a 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

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. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.
  • lgGrants - A list of grants.
  • lgNextMarker - When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.

data ListGrantsResponse #

See: listGrantsResponse smart constructor.

Instances

Eq ListGrantsResponse # 
Data ListGrantsResponse # 

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 # 
Show ListGrantsResponse # 
Generic ListGrantsResponse # 
Hashable ListGrantsResponse # 
FromJSON ListGrantsResponse # 
NFData ListGrantsResponse # 

Methods

rnf :: ListGrantsResponse -> () #

type Rep ListGrantsResponse # 
type Rep ListGrantsResponse = D1 (MetaData "ListGrantsResponse" "Network.AWS.KMS.Types.Product" "amazonka-kms-1.4.5-5KQpvh5Ruw27D0B5DkiMna" False) (C1 (MetaCons "ListGrantsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lgTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_lgGrants") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GrantListEntry]))) (S1 (MetaSel (Just Symbol "_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. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.

lgNextMarker :: Lens' ListGrantsResponse (Maybe Text) #

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