Copyright	(c) 2013-2021 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

Amazonka.IAM.GetContextKeysForPrincipalPolicy

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 operation 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 Amazon Web Services 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

data GetContextKeysForPrincipalPolicy Source #

See: newGetContextKeysForPrincipalPolicy smart constructor.

Constructors

GetContextKeysForPrincipalPolicy'

Fields

policyInputList :: Maybe [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)
policySourceArn :: 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) in the Amazon Web Services General Reference.

Instances

Instances details

Eq GetContextKeysForPrincipalPolicy Source #
Instance details Defined in Amazonka.IAM.GetContextKeysForPrincipalPolicy Methods (==) :: GetContextKeysForPrincipalPolicy -> GetContextKeysForPrincipalPolicy -> Bool # (/=) :: GetContextKeysForPrincipalPolicy -> GetContextKeysForPrincipalPolicy -> Bool #
Read GetContextKeysForPrincipalPolicy Source #
Instance details Defined in Amazonka.IAM.GetContextKeysForPrincipalPolicy Methods readsPrec :: Int -> ReadS GetContextKeysForPrincipalPolicy # readList :: ReadS [GetContextKeysForPrincipalPolicy] # readPrec :: ReadPrec GetContextKeysForPrincipalPolicy # readListPrec :: ReadPrec [GetContextKeysForPrincipalPolicy] #
Show GetContextKeysForPrincipalPolicy Source #
Instance details Defined in Amazonka.IAM.GetContextKeysForPrincipalPolicy Methods showsPrec :: Int -> GetContextKeysForPrincipalPolicy -> ShowS # show :: GetContextKeysForPrincipalPolicy -> String # showList :: [GetContextKeysForPrincipalPolicy] -> ShowS #
Generic GetContextKeysForPrincipalPolicy Source #
Instance details Defined in Amazonka.IAM.GetContextKeysForPrincipalPolicy Associated Types type Rep GetContextKeysForPrincipalPolicy :: Type -> Type # Methods from :: GetContextKeysForPrincipalPolicy -> Rep GetContextKeysForPrincipalPolicy x # to :: Rep GetContextKeysForPrincipalPolicy x -> GetContextKeysForPrincipalPolicy #
NFData GetContextKeysForPrincipalPolicy Source #
Instance details Defined in Amazonka.IAM.GetContextKeysForPrincipalPolicy Methods rnf :: GetContextKeysForPrincipalPolicy -> () #
Hashable GetContextKeysForPrincipalPolicy Source #
Instance details Defined in Amazonka.IAM.GetContextKeysForPrincipalPolicy Methods hashWithSalt :: Int -> GetContextKeysForPrincipalPolicy -> Int # hash :: GetContextKeysForPrincipalPolicy -> Int #
AWSRequest GetContextKeysForPrincipalPolicy Source #
Instance details Defined in Amazonka.IAM.GetContextKeysForPrincipalPolicy Associated Types type AWSResponse GetContextKeysForPrincipalPolicy # Methods request :: GetContextKeysForPrincipalPolicy -> Request GetContextKeysForPrincipalPolicy # response :: MonadResource m => Logger -> Service -> Proxy GetContextKeysForPrincipalPolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetContextKeysForPrincipalPolicy))) #
ToHeaders GetContextKeysForPrincipalPolicy Source #
Instance details Defined in Amazonka.IAM.GetContextKeysForPrincipalPolicy Methods toHeaders :: GetContextKeysForPrincipalPolicy -> [Header] #
ToPath GetContextKeysForPrincipalPolicy Source #
Instance details Defined in Amazonka.IAM.GetContextKeysForPrincipalPolicy Methods toPath :: GetContextKeysForPrincipalPolicy -> ByteString #
ToQuery GetContextKeysForPrincipalPolicy Source #
Instance details Defined in Amazonka.IAM.GetContextKeysForPrincipalPolicy Methods toQuery :: GetContextKeysForPrincipalPolicy -> QueryString #
type Rep GetContextKeysForPrincipalPolicy Source #
Instance details Defined in Amazonka.IAM.GetContextKeysForPrincipalPolicy type Rep GetContextKeysForPrincipalPolicy = D1 ('MetaData "GetContextKeysForPrincipalPolicy" "Amazonka.IAM.GetContextKeysForPrincipalPolicy" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "GetContextKeysForPrincipalPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "policyInputList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "policySourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetContextKeysForPrincipalPolicy Source #
Instance details Defined in Amazonka.IAM.GetContextKeysForPrincipalPolicy type AWSResponse GetContextKeysForPrincipalPolicy = GetContextKeysForPolicyResponse

newGetContextKeysForPrincipalPolicy Source #

Arguments

:: Text	`$sel:policySourceArn:GetContextKeysForPrincipalPolicy'`
-> GetContextKeysForPrincipalPolicy

Create a value of GetContextKeysForPrincipalPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:policyInputList:GetContextKeysForPrincipalPolicy', getContextKeysForPrincipalPolicy_policyInputList - 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)

$sel:policySourceArn:GetContextKeysForPrincipalPolicy', getContextKeysForPrincipalPolicy_policySourceArn - 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) in the Amazon Web Services General Reference.

Request Lenses

getContextKeysForPrincipalPolicy_policyInputList :: Lens' GetContextKeysForPrincipalPolicy (Maybe [Text]) Source #

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)

getContextKeysForPrincipalPolicy_policySourceArn :: 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 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) in the Amazon Web Services General Reference.

Destructuring the Response

data GetContextKeysForPolicyResponse Source #

Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.

See: newGetContextKeysForPolicyResponse smart constructor.

Constructors

GetContextKeysForPolicyResponse'
Fields contextKeyNames :: Maybe [Text] The list of context keys that are referenced in the input policies.

Instances

Instances details

Eq GetContextKeysForPolicyResponse Source #
Instance details Defined in Amazonka.IAM.Types.GetContextKeysForPolicyResponse Methods (==) :: GetContextKeysForPolicyResponse -> GetContextKeysForPolicyResponse -> Bool # (/=) :: GetContextKeysForPolicyResponse -> GetContextKeysForPolicyResponse -> Bool #
Read GetContextKeysForPolicyResponse Source #
Instance details Defined in Amazonka.IAM.Types.GetContextKeysForPolicyResponse Methods readsPrec :: Int -> ReadS GetContextKeysForPolicyResponse # readList :: ReadS [GetContextKeysForPolicyResponse] # readPrec :: ReadPrec GetContextKeysForPolicyResponse # readListPrec :: ReadPrec [GetContextKeysForPolicyResponse] #
Show GetContextKeysForPolicyResponse Source #
Instance details Defined in Amazonka.IAM.Types.GetContextKeysForPolicyResponse Methods showsPrec :: Int -> GetContextKeysForPolicyResponse -> ShowS # show :: GetContextKeysForPolicyResponse -> String # showList :: [GetContextKeysForPolicyResponse] -> ShowS #
Generic GetContextKeysForPolicyResponse Source #
Instance details Defined in Amazonka.IAM.Types.GetContextKeysForPolicyResponse Associated Types type Rep GetContextKeysForPolicyResponse :: Type -> Type # Methods from :: GetContextKeysForPolicyResponse -> Rep GetContextKeysForPolicyResponse x # to :: Rep GetContextKeysForPolicyResponse x -> GetContextKeysForPolicyResponse #
NFData GetContextKeysForPolicyResponse Source #
Instance details Defined in Amazonka.IAM.Types.GetContextKeysForPolicyResponse Methods rnf :: GetContextKeysForPolicyResponse -> () #
Hashable GetContextKeysForPolicyResponse Source #
Instance details Defined in Amazonka.IAM.Types.GetContextKeysForPolicyResponse Methods hashWithSalt :: Int -> GetContextKeysForPolicyResponse -> Int # hash :: GetContextKeysForPolicyResponse -> Int #
FromXML GetContextKeysForPolicyResponse Source #
Instance details Defined in Amazonka.IAM.Types.GetContextKeysForPolicyResponse Methods parseXML :: [Node] -> Either String GetContextKeysForPolicyResponse #
type Rep GetContextKeysForPolicyResponse Source #
Instance details Defined in Amazonka.IAM.Types.GetContextKeysForPolicyResponse type Rep GetContextKeysForPolicyResponse = D1 ('MetaData "GetContextKeysForPolicyResponse" "Amazonka.IAM.Types.GetContextKeysForPolicyResponse" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "GetContextKeysForPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "contextKeyNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newGetContextKeysForPolicyResponse :: GetContextKeysForPolicyResponse Source #

Create a value of GetContextKeysForPolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contextKeyNames:GetContextKeysForPolicyResponse', getContextKeysForPolicyResponse_contextKeyNames - The list of context keys that are referenced in the input policies.

Response Lenses

getContextKeysForPolicyResponse_contextKeyNames :: Lens' GetContextKeysForPolicyResponse (Maybe [Text]) Source #

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