com.amazonaws.services.identitymanagement.model
Class ListRolesRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.identitymanagement.model.ListRolesRequest

public class ListRolesRequest
extends AmazonWebServiceRequest

Container for the parameters to the ListRoles operation.

Lists the roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to Working with Roles .

You can paginate the results using the MaxItems and Marker parameters.

The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html .

See Also:

AmazonIdentityManagement.listRoles(ListRolesRequest)

Constructor Summary

ListRolesRequest()

Method Summary

boolean	equals(Object obj)
String	getMarker() Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated.
Integer	getMaxItems() Use this parameter only when paginating results to indicate the maximum number of user names you want in the response.
String	getPathPrefix() The path prefix for filtering the results.
int	hashCode()
void	setMarker(String marker) Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated.
void	setMaxItems(Integer maxItems) Use this parameter only when paginating results to indicate the maximum number of user names you want in the response.
void	setPathPrefix(String pathPrefix) The path prefix for filtering the results.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListRolesRequest	withMarker(String marker) Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated.
ListRolesRequest	withMaxItems(Integer maxItems) Use this parameter only when paginating results to indicate the maximum number of user names you want in the response.
ListRolesRequest	withPathPrefix(String pathPrefix) The path prefix for filtering the results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListRolesRequest

public ListRolesRequest()

Method Detail

getPathPrefix

public String getPathPrefix()

The path prefix for filtering the results. For example: /application_abc/component_xyz/, which would get all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles.

Constraints:
Length: 1 - 512
Pattern: /[!-]*

Returns:

The path prefix for filtering the results. For example: /application_abc/component_xyz/, which would get all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles.

setPathPrefix

public void setPathPrefix(String pathPrefix)

The path prefix for filtering the results. For example: /application_abc/component_xyz/, which would get all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles.

Constraints:
Length: 1 - 512
Pattern: /[!-]*

Parameters:

pathPrefix - The path prefix for filtering the results. For example: /application_abc/component_xyz/, which would get all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles.

withPathPrefix

public ListRolesRequest withPathPrefix(String pathPrefix)

The path prefix for filtering the results. For example: /application_abc/component_xyz/, which would get all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles.

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

Constraints:
Length: 1 - 512
Pattern: /[!-]*

Parameters:

pathPrefix - The path prefix for filtering the results. For example: /application_abc/component_xyz/, which would get all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles.

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 in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Returns:

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

setMarker

public void setMarker(String marker)

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Parameters:

marker - Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

withMarker

public ListRolesRequest withMarker(String marker)

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

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

Constraints:
Length: 1 - 320
Pattern: [ -?]*

Parameters:

marker - Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Returns:

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

getMaxItems

public Integer getMaxItems()

Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Returns:

Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

setMaxItems

public void setMaxItems(Integer maxItems)

Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

Constraints:
Range: 1 - 1000

Parameters:

maxItems - Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

withMaxItems

public ListRolesRequest withMaxItems(Integer maxItems)

Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

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

Constraints:
Range: 1 - 1000

Parameters:

maxItems - Use this parameter only when paginating results to indicate the maximum number of user names you want in the response. If there are additional user names beyond the maximum you specify, the IsTruncated response element is true.

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