Network.AWS.IAM.GetContextKeysForPrincipalPolicy

Gets a list of all of the context keys referenced in all the IAM policies that are 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. Context keys 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 .

Creating a Request

getContextKeysForPrincipalPolicy

Arguments

:: Text

gckfppPolicySourceARN

-> GetContextKeysForPrincipalPolicy

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 used to validate this parameter is a string of characters consisting of the following: * Any printable ASCII character ranging from the space character (u0020) through the end of the ASCII character range * The printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF) * 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 that are attached to the user. The list also includes 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

See: getContextKeysForPrincipalPolicy smart constructor.

Instances

Eq GetContextKeysForPrincipalPolicy

Defined in Network.AWS.IAM.GetContextKeysForPrincipalPolicy

Methods

(==) :: GetContextKeysForPrincipalPolicy -> GetContextKeysForPrincipalPolicy -> Bool

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

Data GetContextKeysForPrincipalPolicy

Defined in Network.AWS.IAM.GetContextKeysForPrincipalPolicy

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

Defined in Network.AWS.IAM.GetContextKeysForPrincipalPolicy

Methods

readsPrec :: Int -> ReadS GetContextKeysForPrincipalPolicy

readList :: ReadS [GetContextKeysForPrincipalPolicy]

readPrec :: ReadPrec GetContextKeysForPrincipalPolicy

readListPrec :: ReadPrec [GetContextKeysForPrincipalPolicy]

Show GetContextKeysForPrincipalPolicy

Defined in Network.AWS.IAM.GetContextKeysForPrincipalPolicy

Methods

showsPrec :: Int -> GetContextKeysForPrincipalPolicy -> ShowS

show :: GetContextKeysForPrincipalPolicy -> String

showList :: [GetContextKeysForPrincipalPolicy] -> ShowS

Generic GetContextKeysForPrincipalPolicy

Defined in Network.AWS.IAM.GetContextKeysForPrincipalPolicy

Associated Types

type Rep GetContextKeysForPrincipalPolicy :: Type -> Type

Methods

from :: GetContextKeysForPrincipalPolicy -> Rep GetContextKeysForPrincipalPolicy x

to :: Rep GetContextKeysForPrincipalPolicy x -> GetContextKeysForPrincipalPolicy

Hashable GetContextKeysForPrincipalPolicy

Defined in Network.AWS.IAM.GetContextKeysForPrincipalPolicy

Methods

hashWithSalt :: Int -> GetContextKeysForPrincipalPolicy -> Int

hash :: GetContextKeysForPrincipalPolicy -> Int

AWSRequest GetContextKeysForPrincipalPolicy

Defined in Network.AWS.IAM.GetContextKeysForPrincipalPolicy

Associated Types

type Rs GetContextKeysForPrincipalPolicy :: Type

Methods

request :: GetContextKeysForPrincipalPolicy -> Request GetContextKeysForPrincipalPolicy

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetContextKeysForPrincipalPolicy -> ClientResponse -> m (Response GetContextKeysForPrincipalPolicy)

ToHeaders GetContextKeysForPrincipalPolicy

Defined in Network.AWS.IAM.GetContextKeysForPrincipalPolicy

Methods

toHeaders :: GetContextKeysForPrincipalPolicy -> [Header]

ToPath GetContextKeysForPrincipalPolicy

Defined in Network.AWS.IAM.GetContextKeysForPrincipalPolicy

Methods

toPath :: GetContextKeysForPrincipalPolicy -> ByteString

ToQuery GetContextKeysForPrincipalPolicy

Defined in Network.AWS.IAM.GetContextKeysForPrincipalPolicy

Methods

toQuery :: GetContextKeysForPrincipalPolicy -> QueryString

NFData GetContextKeysForPrincipalPolicy

Defined in Network.AWS.IAM.GetContextKeysForPrincipalPolicy

Methods

rnf :: GetContextKeysForPrincipalPolicy -> ()

type Rep GetContextKeysForPrincipalPolicy

Defined in Network.AWS.IAM.GetContextKeysForPrincipalPolicy

type Rep GetContextKeysForPrincipalPolicy = D1 (MetaData "GetContextKeysForPrincipalPolicy" "Network.AWS.IAM.GetContextKeysForPrincipalPolicy" "amazonka-iam-1.6.1-BDjAp2BAcQu3GSS4Bsr6zu" False) (C1 (MetaCons "GetContextKeysForPrincipalPolicy'" PrefixI True) (S1 (MetaSel (Just "_gckfppPolicyInputList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_gckfppPolicySourceARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

type Rs GetContextKeysForPrincipalPolicy

Defined in Network.AWS.IAM.GetContextKeysForPrincipalPolicy

type Rs GetContextKeysForPrincipalPolicy = GetContextKeysForPolicyResponse

Request Lenses

gckfppPolicyInputList :: Lens' GetContextKeysForPrincipalPolicy [Text]

An optional list of additional policies for which you want the list of context keys that are referenced. The regex pattern used to validate this parameter is a string of characters consisting of the following: * Any printable ASCII character ranging from the space character (u0020) through the end of the ASCII character range * The printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF) * The special characters tab (u0009), line feed (u000A), and carriage return (u000D)

gckfppPolicySourceARN :: Lens' GetContextKeysForPrincipalPolicy Text

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 that are attached to the user. The list also includes 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

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:

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

data GetContextKeysForPolicyResponse

Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.

See: getContextKeysForPolicyResponse smart constructor.

Instances

Eq GetContextKeysForPolicyResponse

Defined in Network.AWS.IAM.Types.Product

Methods

(==) :: GetContextKeysForPolicyResponse -> GetContextKeysForPolicyResponse -> Bool

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

Data GetContextKeysForPolicyResponse

Defined in Network.AWS.IAM.Types.Product

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

Defined in Network.AWS.IAM.Types.Product

Methods

readsPrec :: Int -> ReadS GetContextKeysForPolicyResponse

readList :: ReadS [GetContextKeysForPolicyResponse]

readPrec :: ReadPrec GetContextKeysForPolicyResponse

readListPrec :: ReadPrec [GetContextKeysForPolicyResponse]

Show GetContextKeysForPolicyResponse

Defined in Network.AWS.IAM.Types.Product

Methods

showsPrec :: Int -> GetContextKeysForPolicyResponse -> ShowS

show :: GetContextKeysForPolicyResponse -> String

showList :: [GetContextKeysForPolicyResponse] -> ShowS

Generic GetContextKeysForPolicyResponse

Defined in Network.AWS.IAM.Types.Product

Associated Types

type Rep GetContextKeysForPolicyResponse :: Type -> Type

Methods

from :: GetContextKeysForPolicyResponse -> Rep GetContextKeysForPolicyResponse x

to :: Rep GetContextKeysForPolicyResponse x -> GetContextKeysForPolicyResponse

Hashable GetContextKeysForPolicyResponse

Defined in Network.AWS.IAM.Types.Product

Methods

hashWithSalt :: Int -> GetContextKeysForPolicyResponse -> Int

hash :: GetContextKeysForPolicyResponse -> Int

FromXML GetContextKeysForPolicyResponse

Defined in Network.AWS.IAM.Types.Product

Methods

parseXML :: [Node] -> Either String GetContextKeysForPolicyResponse

NFData GetContextKeysForPolicyResponse

Defined in Network.AWS.IAM.Types.Product

Methods

rnf :: GetContextKeysForPolicyResponse -> ()

type Rep GetContextKeysForPolicyResponse

Defined in Network.AWS.IAM.Types.Product

type Rep GetContextKeysForPolicyResponse = D1 (MetaData "GetContextKeysForPolicyResponse" "Network.AWS.IAM.Types.Product" "amazonka-iam-1.6.1-BDjAp2BAcQu3GSS4Bsr6zu" True) (C1 (MetaCons "GetContextKeysForPolicyResponse'" PrefixI True) (S1 (MetaSel (Just "_gckfpContextKeyNames") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Text]))))

Response Lenses

gckfpContextKeyNames :: Lens' GetContextKeysForPolicyResponse [Text]

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