SimulatePrincipalPolicyRequest

Class

Container for the parameters to the SimulatePrincipalPolicy operation.
Simulate how a set of IAM policies attached to an IAM entity works with 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 that are attached to groups that the user belongs
to .

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 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 GetContextKeysForPrincipalPolicy.

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

The ARN of the user that you want to specify as the simulated caller of the APIs.
If you do not specify a CallerArn, it defaults to the ARN of the user
that you specify in PolicySourceArn, if you specified a user. If you
include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David)
and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob),
the result is that you simulate calling the APIs as Bob, as if Bob had David's policies.

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.

CallerArn is required if you include a ResourcePolicy and
the PolicySourceArn is not the ARN for an IAM user. This is required
so that the resource-based policy's Principal element has a value to
use in evaluating the policy.

A list of context keys and corresponding values for the simulation to use. Whenever
a context key is evaluated by a Condition element in one of the simulated
policies, the corresponding value is supplied.

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.

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.

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
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.

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.

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.

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.

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.

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.