com.amazonaws.services.identitymanagement.model

Class GetContextKeysForPrincipalPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.GetContextKeysForPrincipalPolicyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class GetContextKeysForPrincipalPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the GetContextKeysForPrincipalPolicy operation.

Gets a list of all of the context keys referenced in Condition elements in all of the IAM policies attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.

You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.

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

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the Condition element of an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.

See Also:

AmazonIdentityManagement.getContextKeysForPrincipalPolicy(GetContextKeysForPrincipalPolicyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetContextKeysForPrincipalPolicyRequest()

Method Summary

Methods

Modifier and Type	Method and Description
GetContextKeysForPrincipalPolicyRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getPolicyInputList() A optional list of additional policies for which you want list of context keys used in Condition elements.
String	getPolicySourceArn() The ARN of a user, group, or role whose policies contain the context keys that you want listed.
int	hashCode()
void	setPolicyInputList(Collection<String> policyInputList) A optional list of additional policies for which you want list of context keys used in Condition elements.
void	setPolicySourceArn(String policySourceArn) The ARN of a user, group, or role whose policies contain the context keys that you want listed.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetContextKeysForPrincipalPolicyRequest	withPolicyInputList(Collection<String> policyInputList) A optional list of additional policies for which you want list of context keys used in Condition elements.
GetContextKeysForPrincipalPolicyRequest	withPolicyInputList(String... policyInputList) A optional list of additional policies for which you want list of context keys used in Condition elements.
GetContextKeysForPrincipalPolicyRequest	withPolicySourceArn(String policySourceArn) The ARN of a user, group, or role whose policies contain the context keys that you want listed.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, 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

GetContextKeysForPrincipalPolicyRequest

public GetContextKeysForPrincipalPolicyRequest()

Method Detail

getPolicySourceArn

public String getPolicySourceArn()

The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. 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.

Constraints:
Length: 20 - 2048

Returns:

The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. 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.

setPolicySourceArn

public void setPolicySourceArn(String policySourceArn)

The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. 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.

Constraints:
Length: 20 - 2048

Parameters:

policySourceArn - The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. 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.

withPolicySourceArn

public GetContextKeysForPrincipalPolicyRequest withPolicySourceArn(String policySourceArn)

The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 20 - 2048

Parameters:

policySourceArn - The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. 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.

Returns:

A reference to this updated object so that method calls can be chained together.

getPolicyInputList

public List<String> getPolicyInputList()

A optional list of additional policies for which you want list of context keys used in Condition elements.

Returns:

A optional list of additional policies for which you want list of context keys used in Condition elements.

setPolicyInputList

public void setPolicyInputList(Collection<String> policyInputList)

A optional list of additional policies for which you want list of context keys used in Condition elements.

Parameters:

policyInputList - A optional list of additional policies for which you want list of context keys used in Condition elements.

withPolicyInputList

public GetContextKeysForPrincipalPolicyRequest withPolicyInputList(String... policyInputList)

A optional list of additional policies for which you want list of context keys used in Condition elements.

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 - A optional list of additional policies for which you want list of context keys used in Condition elements.

Returns:

A reference to this updated object so that method calls can be chained together.

withPolicyInputList

public GetContextKeysForPrincipalPolicyRequest withPolicyInputList(Collection<String> policyInputList)

A optional list of additional policies for which you want list of context keys used in Condition elements.

Returns a reference to this object so that method calls can be chained together.

Parameters:

policyInputList - A optional list of additional policies for which you want list of context keys used in Condition elements.

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 GetContextKeysForPrincipalPolicyRequest 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()