Simulate Custom Policy
| iam_simulate_custom_policy | R Documentation |
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services resources to determine the policies' effective permissions¶
Description¶
Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and Amazon Web Services 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. You can simulate resources that don't exist in your account.
If you want to simulate existing policies that are attached to an IAM
user, group, or role, use simulate_principal_policy instead.
Context keys are variables that are maintained by Amazon Web Services
and its services and which 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
get_context_keys_for_custom_policy.
If the output is long, you can use MaxItems and Marker parameters to
paginate the results.
The IAM policy simulator evaluates statements in the identity-based policy and the inputs that you provide during simulation. The policy simulator results can differ from your live Amazon Web Services environment. We recommend that you check your policies against your live Amazon Web Services environment after testing using the policy simulator to confirm that you have the desired results. For more information about using the policy simulator, see Testing IAM policies with the IAM policy simulator in the IAM User Guide.
Usage¶
iam_simulate_custom_policy(PolicyInputList,
PermissionsBoundaryPolicyInputList, ActionNames, ResourceArns,
ResourcePolicy, ResourceOwner, CallerArn, ContextEntries,
ResourceHandlingOption, MaxItems, Marker)
Arguments¶
PolicyInputList |
[required] 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 The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas. The regex pattern used to validate this parameter is a string of characters consisting of the following:
|
PermissionsBoundaryPolicyInputList |
The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy. The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas. The regex pattern used to validate this parameter is a string of characters consisting of the following:
|
ActionNames |
[required] 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
|
ResourceArns |
A list of ARNs of Amazon Web Services 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
If you include a For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. Simulation of resource-based policies isn't supported for IAM roles. |
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. The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas. The regex pattern used to validate this parameter is a string of characters consisting of the following:
Simulation of resource-based policies isn't supported for IAM roles. |
ResourceOwner |
An ARN representing the Amazon Web Services account ID that
specifies the owner of any simulated resource that does not identify its
owner in the resource ARN. Examples of resource ARNs include an S3
bucket or object. If The ARN for an account uses the following syntax:
|
CallerArn |
The ARN of the IAM user that you want to use as the simulated
caller of the API operations. 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. |
ContextEntries |
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 permissions policies, the corresponding value is supplied. |
ResourceHandlingOption |
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 Amazon 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 Amazon 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 Amazon EC2 scenario options, see Supported platforms in the Amazon EC2 User Guide.
|
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 If you do not include this parameter, the number of items defaults to
100. Note that IAM might return fewer results, even when there are more
results available. In that case, the |
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 |
Value¶
A list with the following syntax:
list(
EvaluationResults = list(
list(
EvalActionName = "string",
EvalResourceName = "string",
EvalDecision = "allowed"|"explicitDeny"|"implicitDeny",
MatchedStatements = list(
list(
SourcePolicyId = "string",
SourcePolicyType = "user"|"group"|"role"|"aws-managed"|"user-managed"|"resource"|"none",
StartPosition = list(
Line = 123,
Column = 123
),
EndPosition = list(
Line = 123,
Column = 123
)
)
),
MissingContextValues = list(
"string"
),
OrganizationsDecisionDetail = list(
AllowedByOrganizations = TRUE|FALSE
),
PermissionsBoundaryDecisionDetail = list(
AllowedByPermissionsBoundary = TRUE|FALSE
),
EvalDecisionDetails = list(
"allowed"|"explicitDeny"|"implicitDeny"
),
ResourceSpecificResults = list(
list(
EvalResourceName = "string",
EvalResourceDecision = "allowed"|"explicitDeny"|"implicitDeny",
MatchedStatements = list(
list(
SourcePolicyId = "string",
SourcePolicyType = "user"|"group"|"role"|"aws-managed"|"user-managed"|"resource"|"none",
StartPosition = list(
Line = 123,
Column = 123
),
EndPosition = list(
Line = 123,
Column = 123
)
)
),
MissingContextValues = list(
"string"
),
EvalDecisionDetails = list(
"allowed"|"explicitDeny"|"implicitDeny"
),
PermissionsBoundaryDecisionDetail = list(
AllowedByPermissionsBoundary = TRUE|FALSE
)
)
)
)
),
IsTruncated = TRUE|FALSE,
Marker = "string"
)
Request syntax¶
svc$simulate_custom_policy(
PolicyInputList = list(
"string"
),
PermissionsBoundaryPolicyInputList = list(
"string"
),
ActionNames = list(
"string"
),
ResourceArns = list(
"string"
),
ResourcePolicy = "string",
ResourceOwner = "string",
CallerArn = "string",
ContextEntries = list(
list(
ContextKeyName = "string",
ContextKeyValues = list(
"string"
),
ContextKeyType = "string"|"stringList"|"numeric"|"numericList"|"boolean"|"booleanList"|"ip"|"ipList"|"binary"|"binaryList"|"date"|"dateList"
)
),
ResourceHandlingOption = "string",
MaxItems = 123,
Marker = "string"
)