Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and AWS resources to determine the policies' effective permissions. The policies are provided as strings.
The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.
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. You can use the Condition
element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy
.
If the output is long, you can use MaxItems
and Marker
parameters to paginate the results.
This operation returns paginated results.
Synopsis
- simulateCustomPolicy :: SimulateCustomPolicy
- data SimulateCustomPolicy
- scpResourcePolicy :: Lens' SimulateCustomPolicy (Maybe Text)
- scpCallerARN :: Lens' SimulateCustomPolicy (Maybe Text)
- scpResourceHandlingOption :: Lens' SimulateCustomPolicy (Maybe Text)
- scpResourceARNs :: Lens' SimulateCustomPolicy [Text]
- scpMarker :: Lens' SimulateCustomPolicy (Maybe Text)
- scpMaxItems :: Lens' SimulateCustomPolicy (Maybe Natural)
- scpContextEntries :: Lens' SimulateCustomPolicy [ContextEntry]
- scpResourceOwner :: Lens' SimulateCustomPolicy (Maybe Text)
- 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:
scpResourcePolicy
- A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation. 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)scpCallerARN
- The ARN of the IAM user that you want to use as the simulated caller of the API operations.CallerArn
is required if you include aResourcePolicy
so that the policy'sPrincipal
element has a value to use in evaluating the policy. You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.scpResourceHandlingOption
- Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation. Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the Amazon EC2 User Guide . * EC2-Classic-InstanceStore instance, image, security-group * EC2-Classic-EBS instance, image, security-group, volume * EC2-VPC-InstanceStore instance, image, security-group, network-interface * EC2-VPC-InstanceStore-Subnet instance, image, security-group, network-interface, subnet * EC2-VPC-EBS instance, image, security-group, network-interface, volume * EC2-VPC-EBS-Subnet instance, image, security-group, network-interface, subnet, volumescpResourceARNs
- 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 theActionNames
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. The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in theResourcePolicy
parameter. If you include aResourcePolicy
, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .scpMarker
- 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 theMarker
element in the response that you received to indicate where the next call should start.scpMaxItems
- (Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, theIsTruncated
response element istrue
. If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, theIsTruncated
response element returnstrue
andMarker
contains a value to include in the subsequent call that tells the service where to continue from.scpContextEntries
- A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.scpResourceOwner
- An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. IfResourceOwner
is specified, it is also used as the account owner of anyResourcePolicy
included in the simulation. If theResourceOwner
parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided inCallerArn
. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling userCallerArn
.scpPolicyInputList
- 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. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with theResourcePolicy
parameter. The policies cannot be "scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole API operations. In other words, do not use policies designed to restrict what a user can do while using the temporary credentials. 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)scpActionNames
- A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such asiam:CreateUser
.
data SimulateCustomPolicy Source #
See: simulateCustomPolicy
smart constructor.
Instances
Request Lenses
scpResourcePolicy :: Lens' SimulateCustomPolicy (Maybe Text) Source #
A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation. 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)
scpCallerARN :: Lens' SimulateCustomPolicy (Maybe Text) Source #
The ARN of the IAM user that you want to use as the simulated caller of the API operations. CallerArn
is required if you include a ResourcePolicy
so that the policy's Principal
element has a value to use in evaluating the policy. You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.
scpResourceHandlingOption :: Lens' SimulateCustomPolicy (Maybe Text) Source #
Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation. Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the Amazon EC2 User Guide . * EC2-Classic-InstanceStore instance, image, security-group * EC2-Classic-EBS instance, image, security-group, volume * EC2-VPC-InstanceStore instance, image, security-group, network-interface * EC2-VPC-InstanceStore-Subnet instance, image, security-group, network-interface, subnet * EC2-VPC-EBS instance, image, security-group, network-interface, volume * EC2-VPC-EBS-Subnet instance, image, security-group, network-interface, subnet, volume
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. The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy
parameter. If you include a ResourcePolicy
, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
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 that you received to indicate where the next call should start.
scpMaxItems :: Lens' SimulateCustomPolicy (Maybe Natural) Source #
(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated
response element is true
. If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that 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 for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.
scpResourceOwner :: Lens' SimulateCustomPolicy (Maybe Text) Source #
An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If ResourceOwner
is specified, it is also used as the account owner of any ResourcePolicy
included in the simulation. If the ResourceOwner
parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn
. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn
.
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. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy
parameter. The policies cannot be "scope-down" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole API operations. In other words, do not use policies designed to restrict what a user can do while using the temporary credentials. 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)
scpActionNames :: Lens' SimulateCustomPolicy [Text] Source #
A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation 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:
spEvaluationResults
- The results of the simulation.spMarker
- WhenIsTruncated
istrue
, this element is present and contains the value to use for theMarker
parameter in a subsequent pagination request.spIsTruncated
- A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using theMarker
request parameter to retrieve more items. Note that IAM might return fewer than theMaxItems
number of results even when there are more results available. We recommend that you checkIsTruncated
after every call to ensure that you receive all of your results.
data SimulatePolicyResponse Source #
Contains the response to a successful SimulatePrincipalPolicy
or SimulateCustomPolicy
request.
See: simulatePolicyResponse
smart constructor.
Instances
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.