amazonka-iam-1.4.5: Amazon Identity and Access Management 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.IAM.GetContextKeysForPrincipalPolicy

Contents

Description

Gets a list of all of the context keys referenced in all of the IAM policies attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.

You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.

Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy .

Synopsis

Creating a Request

getContextKeysForPrincipalPolicy Source #

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

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

  • gckfppPolicyInputList - An optional list of additional policies for which you want the list of context keys that are referenced. The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (u0020) through end of the ASCII character range (u00FF). It also includes the special characters tab (u0009), line feed (u000A), and carriage return (u000D).
  • gckfppPolicySourceARN - The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .

data GetContextKeysForPrincipalPolicy Source #

See: getContextKeysForPrincipalPolicy smart constructor.

Instances

Eq GetContextKeysForPrincipalPolicy Source # 
Data GetContextKeysForPrincipalPolicy Source # 

Methods

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

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

toConstr :: GetContextKeysForPrincipalPolicy -> Constr #

dataTypeOf :: GetContextKeysForPrincipalPolicy -> DataType #

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

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

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

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

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

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

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

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

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

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

Read GetContextKeysForPrincipalPolicy Source # 
Show GetContextKeysForPrincipalPolicy Source # 
Generic GetContextKeysForPrincipalPolicy Source # 
Hashable GetContextKeysForPrincipalPolicy Source # 
NFData GetContextKeysForPrincipalPolicy Source # 
AWSRequest GetContextKeysForPrincipalPolicy Source # 
ToPath GetContextKeysForPrincipalPolicy Source # 
ToHeaders GetContextKeysForPrincipalPolicy Source # 
ToQuery GetContextKeysForPrincipalPolicy Source # 
type Rep GetContextKeysForPrincipalPolicy Source # 
type Rep GetContextKeysForPrincipalPolicy = D1 (MetaData "GetContextKeysForPrincipalPolicy" "Network.AWS.IAM.GetContextKeysForPrincipalPolicy" "amazonka-iam-1.4.5-tAuuyG7nyKEp3j6LBO0rr" False) (C1 (MetaCons "GetContextKeysForPrincipalPolicy'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gckfppPolicyInputList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_gckfppPolicySourceARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs GetContextKeysForPrincipalPolicy Source # 

Request Lenses

gckfppPolicyInputList :: Lens' GetContextKeysForPrincipalPolicy [Text] Source #

An optional list of additional policies for which you want the list of context keys that are referenced. The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (u0020) through end of the ASCII character range (u00FF). It also includes the special characters tab (u0009), line feed (u000A), and carriage return (u000D).

gckfppPolicySourceARN :: Lens' GetContextKeysForPrincipalPolicy Text Source #

The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .

Destructuring the Response

getContextKeysForPolicyResponse :: GetContextKeysForPolicyResponse Source #

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

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

data GetContextKeysForPolicyResponse Source #

Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.

See: getContextKeysForPolicyResponse smart constructor.

Instances

Eq GetContextKeysForPolicyResponse Source # 
Data GetContextKeysForPolicyResponse Source # 

Methods

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

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

toConstr :: GetContextKeysForPolicyResponse -> Constr #

dataTypeOf :: GetContextKeysForPolicyResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read GetContextKeysForPolicyResponse Source # 
Show GetContextKeysForPolicyResponse Source # 
Generic GetContextKeysForPolicyResponse Source # 
Hashable GetContextKeysForPolicyResponse Source # 
NFData GetContextKeysForPolicyResponse Source # 
FromXML GetContextKeysForPolicyResponse Source # 
type Rep GetContextKeysForPolicyResponse Source # 
type Rep GetContextKeysForPolicyResponse = D1 (MetaData "GetContextKeysForPolicyResponse" "Network.AWS.IAM.Types.Product" "amazonka-iam-1.4.5-tAuuyG7nyKEp3j6LBO0rr" True) (C1 (MetaCons "GetContextKeysForPolicyResponse'" PrefixI True) (S1 (MetaSel (Just Symbol "_gckfpContextKeyNames") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Text]))))

Response Lenses

gckfpContextKeyNames :: Lens' GetContextKeysForPolicyResponse [Text] Source #

The list of context keys that are referenced in the input policies.