class Aws::IAM::Types::SimulatePrincipalPolicyRequest

@note When making an API call, you may pass SimulatePrincipalPolicyRequest

data as a hash:

    {
      policy_source_arn: "arnType", # required
      policy_input_list: ["policyDocumentType"],
      permissions_boundary_policy_input_list: ["policyDocumentType"],
      action_names: ["ActionNameType"], # required
      resource_arns: ["ResourceNameType"],
      resource_policy: "policyDocumentType",
      resource_owner: "ResourceNameType",
      caller_arn: "ResourceNameType",
      context_entries: [
        {
          context_key_name: "ContextKeyNameType",
          context_key_values: ["ContextKeyValueType"],
          context_key_type: "string", # accepts string, stringList, numeric, numericList, boolean, booleanList, ip, ipList, binary, binaryList, date, dateList
        },
      ],
      resource_handling_option: "ResourceHandlingOptionType",
      max_items: 1,
      marker: "markerType",
    }

@!attribute [rw] policy_source_arn

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.

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][1].

For more information about ARNs, see [Amazon Resource Names
(ARNs)][2] in the *Amazon Web Services General Reference*.

[1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length
[2]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
@return [String]

@!attribute [rw] policy_input_list

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.

The [regex pattern][1] 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`)

[1]: http://wikipedia.org/wiki/regex
@return [Array<String>]

@!attribute [rw] permissions_boundary_policy_input_list

The IAM permissions boundary policy to simulate. The permissions
boundary sets the maximum permissions that the entity can have. You
can input only one permissions boundary when you pass a policy to
this operation. An IAM entity can only have one permissions boundary
in effect at a time. For example, if a permissions boundary is
attached to an entity and you pass in a different permissions
boundary policy using this parameter, then the new permissions
boundary policy is used for the simulation. For more information
about permissions boundaries, see [Permissions boundaries for IAM
entities][1] in the *IAM User Guide*. The policy input is specified
as a string containing 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][2].

The [regex pattern][3] 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`)

[1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html
[2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length
[3]: http://wikipedia.org/wiki/regex
@return [Array<String>]

@!attribute [rw] action_names

A list of names of API operations to evaluate in the simulation.
Each operation is evaluated for each resource. Each operation must
include the service identifier, such as `iam:CreateUser`.
@return [Array<String>]

@!attribute [rw] resource_arns

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 `*` (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. You can simulate
resources that don't exist in your account.

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.

For more information about ARNs, see [Amazon Resource Names
(ARNs)][1] in the *Amazon Web Services General Reference*.

[1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
@return [Array<String>]

@!attribute [rw] resource_policy

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][1].

The [regex pattern][2] 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`)

[1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length
[2]: http://wikipedia.org/wiki/regex
@return [String]

@!attribute [rw] resource_owner

An 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 `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`.
@return [String]

@!attribute [rw] caller_arn

The ARN of the IAM user that you want to specify as the simulated
caller of the API operations. 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 API operations 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.

For more information about ARNs, see [Amazon Resource Names
(ARNs)][1] in the *Amazon Web Services General Reference*.

[1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
@return [String]

@!attribute [rw] context_entries

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.
@return [Array<Types::ContextEntry>]

@!attribute [rw] resource_handling_option

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][1] 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

[1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html
@return [String]

@!attribute [rw] max_items

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, 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 `IsTruncated` response
element returns `true`, and `Marker` contains a value to include in
the subsequent call that tells the service where to continue from.
@return [Integer]

@!attribute [rw] 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 `Marker` element in the response that you
received to indicate where the next call should start.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/iam-2010-05-08/SimulatePrincipalPolicyRequest AWS API Documentation

Constants

SENSITIVE