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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.

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 specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. 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.

Creating a Request

data GetContextKeysForCustomPolicy Source #

See: newGetContextKeysForCustomPolicy smart constructor.

Constructors

GetContextKeysForCustomPolicy'

Fields

policyInputList :: [Text]
A list of policies for which you want the list of context keys referenced in those policies. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.
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)

Instances

Instances details

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

newGetContextKeysForCustomPolicy :: GetContextKeysForCustomPolicy Source #

Create a value of GetContextKeysForCustomPolicy 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:GetContextKeysForCustomPolicy', getContextKeysForCustomPolicy_policyInputList - A list of policies for which you want the list of context keys referenced in those policies. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

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)

Request Lenses

getContextKeysForCustomPolicy_policyInputList :: Lens' GetContextKeysForCustomPolicy [Text] Source #

A list of policies for which you want the list of context keys referenced in those policies. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

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)

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.