@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ListUsersRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
ListUsersRequest() |
Modifier and Type | Method and Description |
---|---|
ListUsersRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
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.
|
String |
getPathPrefix()
The path prefix for filtering the results.
|
int |
hashCode() |
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 |
setPathPrefix(String pathPrefix)
The path prefix for filtering the results.
|
String |
toString()
Returns a string representation of this object.
|
ListUsersRequest |
withMarker(String marker)
Use this parameter only when paginating results and only after you receive a response indicating that the results
are truncated.
|
ListUsersRequest |
withMaxItems(Integer maxItems)
Use this only when paginating results to indicate the maximum number of items you want in the response.
|
ListUsersRequest |
withPathPrefix(String pathPrefix)
The path prefix for filtering the results.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
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. This
parameter allows (through its regex pattern) a string of characters
consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In
addition, it can contain any ASCII character from the ! (!
) through the DEL character (
), including most punctuation characters, digits, and upper and lowercased letters.
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.
This parameter allows (through its regex pattern) a string
of characters consisting of either a forward slash (/) by itself or a string that must begin and end with
forward slashes. In addition, it can contain any ASCII character from the ! (!
) through
the DEL character (
), including most punctuation characters, digits, and upper and
lowercased letters.
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. This
parameter allows (through its regex pattern) a string of characters
consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In
addition, it can contain any ASCII character from the ! (!
) through the DEL character (
), including most punctuation characters, digits, and upper and lowercased letters.
/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.
This parameter allows (through its regex pattern) a string
of characters consisting of either a forward slash (/) by itself or a string that must begin and end with
forward slashes. In addition, it can contain any ASCII character from the ! (!
) through
the DEL character (
), including most punctuation characters, digits, and upper and
lowercased letters.
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. This
parameter allows (through its regex pattern) a string of characters
consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In
addition, it can contain any ASCII character from the ! (!
) through the DEL character (
), including most punctuation characters, digits, and upper and lowercased letters.
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.
This parameter allows (through its regex pattern) a string
of characters consisting of either a forward slash (/) by itself or a string that must begin and end with
forward slashes. In addition, it can contain any ASCII character from the ! (!
) through
the DEL character (
), including most punctuation characters, digits, and upper and
lowercased letters.
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.
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.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.
Marker
element in the response that you
received to indicate where the next call should start.public ListUsersRequest 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.
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.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
.
If you do not include this parameter, the number of items 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.
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
.
If you do not include this parameter, the number of items 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.
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
.
If you do not include this parameter, the number of items 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.
IsTruncated
response element
is true
.
If you do not include this parameter, the number of items 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.
public ListUsersRequest 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
.
If you do not include this parameter, the number of items 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.
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
.
If you do not include this parameter, the number of items 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.
public String toString()
toString
in class Object
Object.toString()
public ListUsersRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()