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.
You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation.
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. You can use the
element of an IAM policy to evaluate context keys. To get the list of context keys
that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.
If the output is long, you can use the
parameters to paginate the results.
Version: (assembly version)
public class SimulatePrincipalPolicyRequest : AmazonIdentityManagementServiceRequest IRequestEvents
The SimulatePrincipalPolicyRequest type exposes the following members
Gets and sets the property ActionNames.
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
Gets and sets the property CallerArn.
The ARN of the user that you want to specify as the simulated caller of the APIs.
If you do not specify a
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.
Gets and sets the property ContextEntries.
A list of context keys and corresponding values for the simulation to use. Whenever
a context key is evaluated by a
Gets and sets the property Marker.
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
Gets and sets the property MaxItems.
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
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. In that
Gets and sets the property PolicyInputList.
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.
Gets and sets the property PolicySourceArn.
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 that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.
Gets and sets the property ResourceArns.
A list of ARNs of AWS resources to include in the simulation. If this parameter is
not provided then the value defaults to
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
Gets and sets the property ResourceHandlingOption.
Specifies the type of simulation to run. Different APIs 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 AWS EC2 User Guide.
Gets and sets the property ResourceOwner.
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
Gets and sets the property ResourcePolicy.
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.
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1