Network.AWS.IAM.SimulatePrincipalPolicy

Simulate the set of IAM policies attached to an IAM entity against a list of API actions and AWS resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation 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 to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead.

The simulation does not perform the API actions, it only checks the authorization to determine if the simulated policies allow or deny the actions.

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 SimulateCustomPolicy 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 using the Condition element of an IAM policy. To get the list of context keys required by the policies to simulate them correctly, use GetContextKeysForPrincipalPolicy.

If the output is long, you can paginate the results using the MaxItems and Marker parameters.

See: AWS API Reference for SimulatePrincipalPolicy.

Creating a Request

simulatePrincipalPolicy

Arguments

:: Text

sppPolicySourceARN

-> SimulatePrincipalPolicy

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

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

• sppPolicyInputList
• sppResourceARNs
• sppMarker
• sppMaxItems
• sppContextEntries
• sppPolicySourceARN
• sppActionNames

data SimulatePrincipalPolicy

See: simulatePrincipalPolicy smart constructor.

Instances

Eq SimulatePrincipalPolicy

Data SimulatePrincipalPolicy

Read SimulatePrincipalPolicy

Show SimulatePrincipalPolicy

Generic SimulatePrincipalPolicy

AWSRequest SimulatePrincipalPolicy

ToPath SimulatePrincipalPolicy

ToHeaders SimulatePrincipalPolicy

ToQuery SimulatePrincipalPolicy

type Rep SimulatePrincipalPolicy

type Rs SimulatePrincipalPolicy = SimulatePolicyResponse

Request Lenses

sppPolicyInputList :: Lens' SimulatePrincipalPolicy [Text]

An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

sppResourceARNs :: Lens' SimulatePrincipalPolicy [Text]

A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.

sppMarker :: Lens' SimulatePrincipalPolicy (Maybe Text)

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response you received to inform the next call about where to start.

sppMaxItems :: Lens' SimulatePrincipalPolicy (Maybe Natural)

Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the IsTruncated response element is true.

This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

sppContextEntries :: Lens' SimulatePrincipalPolicy [ContextEntry]

A list of context keys and corresponding values that are used by the simulation. Whenever a context key is evaluated by a Condition element in one of the simulated IAM permission policies, the corresponding value is supplied.

sppPolicySourceARN :: Lens' SimulatePrincipalPolicy Text

The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies associated with that entity. If you specify a user, the simulation also includes all policies attached to any groups the user is a member of.

sppActionNames :: Lens' SimulatePrincipalPolicy [Text]

A list of names of API actions to evaluate in the simulation. Each action is evaluated for each resource. Each action must include the service identifier, such as 'iam:CreateUser'.

Destructuring the Response

simulatePolicyResponse :: SimulatePolicyResponse

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

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

• spEvaluationResults
• spMarker
• spIsTruncated

data SimulatePolicyResponse

Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request.

See: simulatePolicyResponse smart constructor.

Instances

Eq SimulatePolicyResponse

Data SimulatePolicyResponse

Read SimulatePolicyResponse

Show SimulatePolicyResponse

Generic SimulatePolicyResponse

FromXML SimulatePolicyResponse

type Rep SimulatePolicyResponse

Response Lenses

spEvaluationResults :: Lens' SimulatePolicyResponse [EvaluationResult]

The results of the simulation.

spMarker :: Lens' SimulatePolicyResponse (Maybe Text)

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

spIsTruncated :: Lens' SimulatePolicyResponse (Maybe Bool)

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.