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

Contents

Description

Retrieves a list of policies attached to a key.

This operation returns paginated results.

Synopsis

Creating a Request

listKeyPolicies #

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

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

  • lkpMarker - 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.
  • lkpLimit - 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 1000, inclusive. If you do not include a value, it defaults to 100. Currently only 1 policy can be attached to a key.
  • lkpKeyId - A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias". * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789012 * Alias ARN Example - arn:aws:kms:us-east-1:123456789012:aliasMyAliasName * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 * Alias Name Example - aliasMyAliasName

data ListKeyPolicies #

See: listKeyPolicies smart constructor.

Instances

Eq ListKeyPolicies # 
Data ListKeyPolicies # 

Methods

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

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

toConstr :: ListKeyPolicies -> Constr #

dataTypeOf :: ListKeyPolicies -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListKeyPolicies # 
Show ListKeyPolicies # 
Generic ListKeyPolicies # 
Hashable ListKeyPolicies # 
ToJSON ListKeyPolicies # 
NFData ListKeyPolicies # 

Methods

rnf :: ListKeyPolicies -> () #

AWSPager ListKeyPolicies # 
AWSRequest ListKeyPolicies # 
ToQuery ListKeyPolicies # 
ToPath ListKeyPolicies # 
ToHeaders ListKeyPolicies # 
type Rep ListKeyPolicies # 
type Rep ListKeyPolicies = D1 (MetaData "ListKeyPolicies" "Network.AWS.KMS.ListKeyPolicies" "amazonka-kms-1.4.5-5KQpvh5Ruw27D0B5DkiMna" False) (C1 (MetaCons "ListKeyPolicies'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lkpMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lkpLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_lkpKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs ListKeyPolicies # 

Request Lenses

lkpMarker :: Lens' ListKeyPolicies (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.

lkpLimit :: Lens' ListKeyPolicies (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 1000, inclusive. If you do not include a value, it defaults to 100. Currently only 1 policy can be attached to a key.

lkpKeyId :: Lens' ListKeyPolicies Text #

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias". * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789012 * Alias ARN Example - arn:aws:kms:us-east-1:123456789012:aliasMyAliasName * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 * Alias Name Example - aliasMyAliasName

Destructuring the Response

listKeyPoliciesResponse #

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

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

  • lkprsPolicyNames - A list of policy names. Currently, there is only one policy and it is named Default.
  • lkprsTruncated - 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.
  • lkprsNextMarker - When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.
  • lkprsResponseStatus - -- | The response status code.

data ListKeyPoliciesResponse #

See: listKeyPoliciesResponse smart constructor.

Instances

Eq ListKeyPoliciesResponse # 
Data ListKeyPoliciesResponse # 

Methods

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

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

toConstr :: ListKeyPoliciesResponse -> Constr #

dataTypeOf :: ListKeyPoliciesResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read ListKeyPoliciesResponse # 
Show ListKeyPoliciesResponse # 
Generic ListKeyPoliciesResponse # 
NFData ListKeyPoliciesResponse # 

Methods

rnf :: ListKeyPoliciesResponse -> () #

type Rep ListKeyPoliciesResponse # 
type Rep ListKeyPoliciesResponse = D1 (MetaData "ListKeyPoliciesResponse" "Network.AWS.KMS.ListKeyPolicies" "amazonka-kms-1.4.5-5KQpvh5Ruw27D0B5DkiMna" False) (C1 (MetaCons "ListKeyPoliciesResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lkprsPolicyNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_lkprsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_lkprsNextMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lkprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

lkprsPolicyNames :: Lens' ListKeyPoliciesResponse [Text] #

A list of policy names. Currently, there is only one policy and it is named Default.

lkprsTruncated :: Lens' ListKeyPoliciesResponse (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.

lkprsNextMarker :: Lens' ListKeyPoliciesResponse (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.

lkprsResponseStatus :: Lens' ListKeyPoliciesResponse Int #

  • - | The response status code.