Network.AWS.IAM.GetContextKeysForCustomPolicy

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 AWS and its services that provide details about the context of an API query request, and 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

getContextKeysForCustomPolicy :: GetContextKeysForCustomPolicy

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

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

• gckfcpPolicyInputList - 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 any printable ASCII character ranging from the space character (u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF). It also includes the special characters tab (u0009), line feed (u000A), and carriage return (u000D).

data GetContextKeysForCustomPolicy

See: getContextKeysForCustomPolicy smart constructor.

Instances

Eq GetContextKeysForCustomPolicy

Methods

(==) :: GetContextKeysForCustomPolicy -> GetContextKeysForCustomPolicy -> Bool

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

Data GetContextKeysForCustomPolicy

Methods

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

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

toConstr :: GetContextKeysForCustomPolicy -> Constr

dataTypeOf :: GetContextKeysForCustomPolicy -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> GetContextKeysForCustomPolicy -> GetContextKeysForCustomPolicy

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

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

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

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

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

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

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

Read GetContextKeysForCustomPolicy

Methods

readsPrec :: Int -> ReadS GetContextKeysForCustomPolicy

readList :: ReadS [GetContextKeysForCustomPolicy]

readPrec :: ReadPrec GetContextKeysForCustomPolicy

readListPrec :: ReadPrec [GetContextKeysForCustomPolicy]

Show GetContextKeysForCustomPolicy

Methods

showsPrec :: Int -> GetContextKeysForCustomPolicy -> ShowS

show :: GetContextKeysForCustomPolicy -> String

showList :: [GetContextKeysForCustomPolicy] -> ShowS

Generic GetContextKeysForCustomPolicy

Associated Types

type Rep GetContextKeysForCustomPolicy :: * -> *

Methods

from :: GetContextKeysForCustomPolicy -> Rep GetContextKeysForCustomPolicy x

to :: Rep GetContextKeysForCustomPolicy x -> GetContextKeysForCustomPolicy

Hashable GetContextKeysForCustomPolicy

Methods

hashWithSalt :: Int -> GetContextKeysForCustomPolicy -> Int

hash :: GetContextKeysForCustomPolicy -> Int

NFData GetContextKeysForCustomPolicy

Methods

rnf :: GetContextKeysForCustomPolicy -> ()

AWSRequest GetContextKeysForCustomPolicy

Associated Types

type Rs GetContextKeysForCustomPolicy :: *

Methods

request :: GetContextKeysForCustomPolicy -> Request GetContextKeysForCustomPolicy

response :: MonadResource m => Logger -> Service -> Proxy * GetContextKeysForCustomPolicy -> ClientResponse -> m (Response GetContextKeysForCustomPolicy)

ToQuery GetContextKeysForCustomPolicy

Methods

toQuery :: GetContextKeysForCustomPolicy -> QueryString

ToPath GetContextKeysForCustomPolicy

Methods

toPath :: GetContextKeysForCustomPolicy -> ByteString

ToHeaders GetContextKeysForCustomPolicy

Methods

toHeaders :: GetContextKeysForCustomPolicy -> [Header]

type Rep GetContextKeysForCustomPolicy

type Rep GetContextKeysForCustomPolicy = D1 (MetaData "GetContextKeysForCustomPolicy" "Network.AWS.IAM.GetContextKeysForCustomPolicy" "amazonka-iam-1.5.0-2w4nVHAOrDgI2P1QVLKd9e" True) (C1 (MetaCons "GetContextKeysForCustomPolicy'" PrefixI True) (S1 (MetaSel (Just Symbol "_gckfcpPolicyInputList") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))

type Rs GetContextKeysForCustomPolicy

type Rs GetContextKeysForCustomPolicy = GetContextKeysForPolicyResponse

Request Lenses

gckfcpPolicyInputList :: Lens' GetContextKeysForCustomPolicy [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 any printable ASCII character ranging from the space character (u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF). It also includes the special characters tab (u0009), line feed (u000A), and carriage return (u000D).

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

Methods

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

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

Data GetContextKeysForPolicyResponse

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

Methods

readsPrec :: Int -> ReadS GetContextKeysForPolicyResponse

readList :: ReadS [GetContextKeysForPolicyResponse]

readPrec :: ReadPrec GetContextKeysForPolicyResponse

readListPrec :: ReadPrec [GetContextKeysForPolicyResponse]

Show GetContextKeysForPolicyResponse

Methods

showsPrec :: Int -> GetContextKeysForPolicyResponse -> ShowS

show :: GetContextKeysForPolicyResponse -> String

showList :: [GetContextKeysForPolicyResponse] -> ShowS

Generic GetContextKeysForPolicyResponse

Associated Types

type Rep GetContextKeysForPolicyResponse :: * -> *

Methods

from :: GetContextKeysForPolicyResponse -> Rep GetContextKeysForPolicyResponse x

to :: Rep GetContextKeysForPolicyResponse x -> GetContextKeysForPolicyResponse

Hashable GetContextKeysForPolicyResponse

Methods

hashWithSalt :: Int -> GetContextKeysForPolicyResponse -> Int

hash :: GetContextKeysForPolicyResponse -> Int

NFData GetContextKeysForPolicyResponse

Methods

rnf :: GetContextKeysForPolicyResponse -> ()

FromXML GetContextKeysForPolicyResponse

Methods

parseXML :: [Node] -> Either String GetContextKeysForPolicyResponse

type Rep GetContextKeysForPolicyResponse

type Rep GetContextKeysForPolicyResponse = D1 (MetaData "GetContextKeysForPolicyResponse" "Network.AWS.IAM.Types.Product" "amazonka-iam-1.5.0-2w4nVHAOrDgI2P1QVLKd9e" True) (C1 (MetaCons "GetContextKeysForPolicyResponse'" PrefixI True) (S1 (MetaSel (Just Symbol "_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.