com.amazonaws.services.identitymanagement.model

Class ListUsersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.ListUsersRequest

All Implemented Interfaces:

Serializable

public class ListUsersRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ListUsers operation.

Lists the users that have the specified path prefix. If there are none, the action returns an empty list.

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

See Also:

AmazonIdentityManagement.listUsers(ListUsersRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListUsersRequest() Default constructor for a new ListUsersRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
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.
ListUsersRequest	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.
ListUsersRequest	withMaxItems(Integer maxItems) Use this parameter only when paginating results to indicate the maximum number of user names you want in the response.
ListUsersRequest	withPathPrefix(String pathPrefix) The path prefix for filtering the results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListUsersRequest

public ListUsersRequest()

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

Method Detail

getPathPrefix

public String getPathPrefix()

The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.

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

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

Returns:

The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.

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

setPathPrefix

public void setPathPrefix(String pathPrefix)

The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.

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

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

Parameters:

pathPrefix - The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.

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

withPathPrefix

public ListUsersRequest withPathPrefix(String pathPrefix)

The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.

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

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: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.

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

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 ListUsersRequest 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. This parameter is optional. If you do not include it, it defaults to 100.

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. This parameter is optional. If you do not include it, it defaults to 100.

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. This parameter is optional. If you do not include it, it defaults to 100.

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. This parameter is optional. If you do not include it, it defaults to 100.

withMaxItems

public ListUsersRequest 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. This parameter is optional. If you do not include it, it defaults to 100.

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. This parameter is optional. If you do not include it, it defaults to 100.

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