com.amazonaws.services.identitymanagement.model

Class GetUserPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.GetUserPolicyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class GetUserPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the GetUserPolicy operation.

Retrieves the specified inline policy document that is embedded in the specified user.

A user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide .

See Also:

AmazonIdentityManagement.getUserPolicy(GetUserPolicyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetUserPolicyRequest() Default constructor for a new GetUserPolicyRequest object.
GetUserPolicyRequest(String userName, String policyName) Constructs a new GetUserPolicyRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
GetUserPolicyRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getPolicyName() The name of the policy document to get.
String	getUserName() The name of the user who the policy is associated with.
int	hashCode()
void	setPolicyName(String policyName) The name of the policy document to get.
void	setUserName(String userName) The name of the user who the policy is associated with.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetUserPolicyRequest	withPolicyName(String policyName) The name of the policy document to get.
GetUserPolicyRequest	withUserName(String userName) The name of the user who the policy is associated with.

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

GetUserPolicyRequest

public GetUserPolicyRequest()

Default constructor for a new GetUserPolicyRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

GetUserPolicyRequest

public GetUserPolicyRequest(String userName,
                    String policyName)

Constructs a new GetUserPolicyRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

userName - The name of the user who the policy is associated with.

policyName - The name of the policy document to get.

Method Detail

getUserName

public String getUserName()

The name of the user who the policy is associated with.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Returns:

The name of the user who the policy is associated with.

setUserName

public void setUserName(String userName)

The name of the user who the policy is associated with.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Parameters:

userName - The name of the user who the policy is associated with.

withUserName

public GetUserPolicyRequest withUserName(String userName)

The name of the user who the policy is associated with.

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

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Parameters:

userName - The name of the user who the policy is associated with.

Returns:

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

getPolicyName

public String getPolicyName()

The name of the policy document to get.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Returns:

The name of the policy document to get.

setPolicyName

public void setPolicyName(String policyName)

The name of the policy document to get.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Parameters:

policyName - The name of the policy document to get.

withPolicyName

public GetUserPolicyRequest withPolicyName(String policyName)

The name of the policy document to get.

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

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]+

Parameters:

policyName - The name of the policy document to get.

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