Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Simulate a set of IAM policies against a list of API actions and AWS resources to determine the policies' effective permissions. The policies are provided as a list of strings.
The simulation does not perform the API actions, it only checks the authorization to determine if the simulated policies allow or deny the actions.
If you want to simulate existing policies attached to an IAM user, group, or role, use SimulatePrincipalPolicy 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 GetContextKeysForCustomPolicy.
If the output is long, you can paginate the results using the MaxItems
and Marker
parameters.
See: AWS API Reference for SimulateCustomPolicy.
- simulateCustomPolicy :: SimulateCustomPolicy
- data SimulateCustomPolicy
- scpResourceARNs :: Lens' SimulateCustomPolicy [Text]
- scpMarker :: Lens' SimulateCustomPolicy (Maybe Text)
- scpMaxItems :: Lens' SimulateCustomPolicy (Maybe Natural)
- scpContextEntries :: Lens' SimulateCustomPolicy [ContextEntry]
- scpPolicyInputList :: Lens' SimulateCustomPolicy [Text]
- scpActionNames :: Lens' SimulateCustomPolicy [Text]
- simulatePolicyResponse :: SimulatePolicyResponse
- data SimulatePolicyResponse
- spEvaluationResults :: Lens' SimulatePolicyResponse [EvaluationResult]
- spMarker :: Lens' SimulatePolicyResponse (Maybe Text)
- spIsTruncated :: Lens' SimulatePolicyResponse (Maybe Bool)
Creating a Request
simulateCustomPolicy :: SimulateCustomPolicy Source
Creates a value of SimulateCustomPolicy
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data SimulateCustomPolicy Source
See: simulateCustomPolicy
smart constructor.
Request Lenses
scpResourceARNs :: Lens' SimulateCustomPolicy [Text] Source
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.
scpMarker :: Lens' SimulateCustomPolicy (Maybe Text) Source
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.
scpMaxItems :: Lens' SimulateCustomPolicy (Maybe Natural) Source
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.
scpContextEntries :: Lens' SimulateCustomPolicy [ContextEntry] Source
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.
scpPolicyInputList :: Lens' SimulateCustomPolicy [Text] Source
A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.
scpActionNames :: Lens' SimulateCustomPolicy [Text] Source
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 Source
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:
data SimulatePolicyResponse Source
Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request.
See: simulatePolicyResponse
smart constructor.
Response Lenses
spEvaluationResults :: Lens' SimulatePolicyResponse [EvaluationResult] Source
The results of the simulation.
spMarker :: Lens' SimulatePolicyResponse (Maybe Text) Source
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) Source
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.