SimulatePrincipalPolicyRequest (AWS SDK For Java for OSGi 1.10.29 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.identitymanagement.model.SimulatePrincipalPolicyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable
```
public class SimulatePrincipalPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
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.
Example This example simulates calling the Amazon S3 APIs GetObject, PutObject, and DeleteObject for a specific S3 bucket. The simulation includes all policies that are attached to the user Jill. In this example, the user Jill has only the managed policy "AmazonS3ReadOnlyAccess" attached. Note that all parameters are shown in unencoded form here for clarity but must be URL encoded to be included as a part of a real HTML request. In the results, the simulation shows that Jill can add new files to the bucket because of the additional policy specified as a string parameter. In addition, she can read from the bucket because of the managed policy attached to the user. However, she cannot delete anything from the S3 bucket because of the default implicitDeny. https://iam.amazonaws.com/Action=SimulatePrincipalPolicy &ActionNames.member.1=s3:PutObject &ActionNames.member.2=s3:GetObject &ActionNames.member.3=s3:DeleteObject &ResourceArns.member.1="arn:aws:s3:::my-test-bucket" &PolicySourceArn=arn:aws:iam:::user/Jill &PolicyInputList.member.1='{ "Version":"2012-10-17", "Statement":{ "Effect":"Allow", "Action":"s3:PutObject", "Resource":"arn:aws:s3:::my-test-bucket" } }' &Version=2010-05-08 &AUTHPARAMS false PolicyInputList.1 2 8 14 3 arn:aws:s3:::my-test-bucket allowed s3:PutObject AmazonS3ReadOnlyAccess 6 11 17 3 arn:aws:s3:::my-test-bucket allowed s3:GetObject arn:aws:s3:::my-test-bucket implicitDeny s3:DeleteObject 004d7059-4c14-11e5-b121-bd8c7EXAMPLE

See Also:
AmazonIdentityManagement.simulatePrincipalPolicy(SimulatePrincipalPolicyRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

SimulatePrincipalPolicyRequest()

Constructors
Constructor and Description
`SimulatePrincipalPolicyRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`SimulatePrincipalPolicyRequest`	`clone()` Creates a shallow clone of this request.
`boolean`	`equals(Object obj)`
`List<String>`	`getActionNames()` A list of names of API actions to evaluate in the simulation.
`String`	`getCallerArn()` The ARN of the user that you want to specify as the simulated caller of the APIs.
`List<ContextEntry>`	`getContextEntries()` A list of context keys and corresponding values for the simulation to use.
`String`	`getMarker()` Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.
`Integer`	`getMaxItems()` Use this only when paginating results to indicate the maximum number of items you want in the response.
`List<String>`	`getPolicyInputList()` An optional list of additional policy documents to include in the simulation.
`String`	`getPolicySourceArn()` The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation.
`List<String>`	`getResourceArns()` A list of ARNs of AWS resources to include in the simulation.
`String`	`getResourceOwner()` 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.
`String`	`getResourcePolicy()` A resource-based policy to include in the simulation provided as a string.
`int`	`hashCode()`
`void`	`setActionNames(Collection<String> actionNames)` A list of names of API actions to evaluate in the simulation.
`void`	`setCallerArn(String callerArn)` The ARN of the user that you want to specify as the simulated caller of the APIs.
`void`	`setContextEntries(Collection<ContextEntry> contextEntries)` A list of context keys and corresponding values for the simulation to use.
`void`	`setMarker(String marker)` Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.
`void`	`setMaxItems(Integer maxItems)` Use this only when paginating results to indicate the maximum number of items you want in the response.
`void`	`setPolicyInputList(Collection<String> policyInputList)` An optional list of additional policy documents to include in the simulation.
`void`	`setPolicySourceArn(String policySourceArn)` The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation.
`void`	`setResourceArns(Collection<String> resourceArns)` A list of ARNs of AWS resources to include in the simulation.
`void`	`setResourceOwner(String 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.
`void`	`setResourcePolicy(String resourcePolicy)` A resource-based policy to include in the simulation provided as a string.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`SimulatePrincipalPolicyRequest`	`withActionNames(Collection<String> actionNames)` A list of names of API actions to evaluate in the simulation.
`SimulatePrincipalPolicyRequest`	`withActionNames(String... actionNames)` A list of names of API actions to evaluate in the simulation.
`SimulatePrincipalPolicyRequest`	`withCallerArn(String callerArn)` The ARN of the user that you want to specify as the simulated caller of the APIs.
`SimulatePrincipalPolicyRequest`	`withContextEntries(Collection<ContextEntry> contextEntries)` A list of context keys and corresponding values for the simulation to use.
`SimulatePrincipalPolicyRequest`	`withContextEntries(ContextEntry... contextEntries)` A list of context keys and corresponding values for the simulation to use.
`SimulatePrincipalPolicyRequest`	`withMarker(String marker)` Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.
`SimulatePrincipalPolicyRequest`	`withMaxItems(Integer maxItems)` Use this only when paginating results to indicate the maximum number of items you want in the response.
`SimulatePrincipalPolicyRequest`	`withPolicyInputList(Collection<String> policyInputList)` An optional list of additional policy documents to include in the simulation.
`SimulatePrincipalPolicyRequest`	`withPolicyInputList(String... policyInputList)` An optional list of additional policy documents to include in the simulation.
`SimulatePrincipalPolicyRequest`	`withPolicySourceArn(String policySourceArn)` The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation.
`SimulatePrincipalPolicyRequest`	`withResourceArns(Collection<String> resourceArns)` A list of ARNs of AWS resources to include in the simulation.
`SimulatePrincipalPolicyRequest`	`withResourceArns(String... resourceArns)` A list of ARNs of AWS resources to include in the simulation.
`SimulatePrincipalPolicyRequest`	`withResourceOwner(String 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.
`SimulatePrincipalPolicyRequest`	`withResourcePolicy(String resourcePolicy)` A resource-based policy to include in the simulation provided as a string.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SimulatePrincipalPolicyRequest
```
public SimulatePrincipalPolicyRequest()
```
- Method Detail
  - getPolicySourceArn
```
public String getPolicySourceArn()
```
    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.
    Constraints:
    Length: 20 - 2048
    
    Returns:
    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.
  - setPolicySourceArn
```
public void setPolicySourceArn(String 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.
    Constraints:
    Length: 20 - 2048
    
    Parameters:
    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.
  - withPolicySourceArn
```
public SimulatePrincipalPolicyRequest withPolicySourceArn(String 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    
    Parameters:
    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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPolicyInputList
```
public List<String> getPolicyInputList()
```
    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.
    
    Returns:
    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.
  - setPolicyInputList
```
public void setPolicyInputList(Collection<String> 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.
    
    Parameters:
    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.
  - withPolicyInputList
```
public SimulatePrincipalPolicyRequest withPolicyInputList(String... 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.
    NOTE: This method appends the values to the existing list (if any). Use setPolicyInputList(java.util.Collection) or withPolicyInputList(java.util.Collection) if you want to override the existing values.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withPolicyInputList
```
public SimulatePrincipalPolicyRequest withPolicyInputList(Collection<String> 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getActionNames
```
public List<String> getActionNames()
```
    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 iam:CreateUser.
    
    Returns:
    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 iam:CreateUser.
  - setActionNames
```
public void setActionNames(Collection<String> 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 iam:CreateUser.
    
    Parameters:
    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 iam:CreateUser.
  - withActionNames
```
public SimulatePrincipalPolicyRequest withActionNames(String... 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 iam:CreateUser.
    NOTE: This method appends the values to the existing list (if any). Use setActionNames(java.util.Collection) or withActionNames(java.util.Collection) if you want to override the existing values.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    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 iam:CreateUser.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withActionNames
```
public SimulatePrincipalPolicyRequest withActionNames(Collection<String> 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 iam:CreateUser.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    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 iam:CreateUser.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getResourceArns
```
public List<String> getResourceArns()
```
    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.
    
    Returns:
    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.
  - setResourceArns
```
public void setResourceArns(Collection<String> resourceArns)
```
    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.
    
    Parameters:
    resourceArns - 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.
  - withResourceArns
```
public SimulatePrincipalPolicyRequest withResourceArns(String... resourceArns)
```
    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.
    NOTE: This method appends the values to the existing list (if any). Use setResourceArns(java.util.Collection) or withResourceArns(java.util.Collection) if you want to override the existing values.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    resourceArns - 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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withResourceArns
```
public SimulatePrincipalPolicyRequest withResourceArns(Collection<String> resourceArns)
```
    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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    resourceArns - 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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getResourcePolicy
```
public String getResourcePolicy()
```
    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.
    Constraints:
    Length: 1 - 131072
    Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
    
    Returns:
    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.
  - setResourcePolicy
```
public void setResourcePolicy(String 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.
    Constraints:
    Length: 1 - 131072
    Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
    
    Parameters:
    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.
  - withResourcePolicy
```
public SimulatePrincipalPolicyRequest withResourcePolicy(String 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 131072
    Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
    
    Parameters:
    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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getResourceOwner
```
public String getResourceOwner()
```
    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.
    Constraints:
    Length: 1 - 2048
    
    Returns:
    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.
  - setResourceOwner
```
public void setResourceOwner(String 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 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.
    Constraints:
    Length: 1 - 2048
    
    Parameters:
    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 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.
  - withResourceOwner
```
public SimulatePrincipalPolicyRequest withResourceOwner(String 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 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    
    Parameters:
    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 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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getCallerArn
```
public String getCallerArn()
```
    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.
    Constraints:
    Length: 1 - 2048
    
    Returns:
    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.
  - setCallerArn
```
public void setCallerArn(String callerArn)
```
    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.
    Constraints:
    Length: 1 - 2048
    
    Parameters:
    callerArn - 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.
  - withCallerArn
```
public SimulatePrincipalPolicyRequest withCallerArn(String callerArn)
```
    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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    
    Parameters:
    callerArn - 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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getContextEntries
```
public List<ContextEntry> getContextEntries()
```
    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.
    
    Returns:
    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.
  - setContextEntries
```
public void setContextEntries(Collection<ContextEntry> contextEntries)
```
    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.
    
    Parameters:
    contextEntries - 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.
  - withContextEntries
```
public SimulatePrincipalPolicyRequest withContextEntries(ContextEntry... contextEntries)
```
    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.
    NOTE: This method appends the values to the existing list (if any). Use setContextEntries(java.util.Collection) or withContextEntries(java.util.Collection) if you want to override the existing values.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    contextEntries - 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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withContextEntries
```
public SimulatePrincipalPolicyRequest withContextEntries(Collection<ContextEntry> contextEntries)
```
    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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    contextEntries - 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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getMaxItems
```
public Integer getMaxItems()
```
    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.
    Constraints:
    Range: 1 - 1000
    
    Returns:
    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.
  - setMaxItems
```
public void setMaxItems(Integer 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 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.
    Constraints:
    Range: 1 - 1000
    
    Parameters:
    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 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.
  - withMaxItems
```
public SimulatePrincipalPolicyRequest withMaxItems(Integer 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 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 1000
    
    Parameters:
    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 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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getMarker
```
public String getMarker()
```
    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.
    Constraints:
    Length: 1 - 320
    Pattern: [\u0020-\u00FF]+
    
    Returns:
    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.
  - setMarker
```
public void setMarker(String 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.
    Constraints:
    Length: 1 - 320
    Pattern: [\u0020-\u00FF]+
    
    Parameters:
    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.
  - withMarker
```
public SimulatePrincipalPolicyRequest withMarker(String 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 320
    Pattern: [\u0020-\u00FF]+
    
    Parameters:
    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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - clone
```
public SimulatePrincipalPolicyRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    Object.clone()

Class SimulatePrincipalPolicyRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SimulatePrincipalPolicyRequest

Method Detail

getPolicySourceArn

setPolicySourceArn

withPolicySourceArn

getPolicyInputList

setPolicyInputList

withPolicyInputList

withPolicyInputList

getActionNames

setActionNames

withActionNames

withActionNames

getResourceArns

setResourceArns

withResourceArns

withResourceArns

getResourcePolicy

setResourcePolicy

withResourcePolicy

getResourceOwner

setResourceOwner

withResourceOwner

getCallerArn

setCallerArn

withCallerArn

getContextEntries

setContextEntries

withContextEntries

withContextEntries

getMaxItems

setMaxItems

withMaxItems

getMarker

setMarker

withMarker

toString

hashCode

equals

clone