The response from the request to list users.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceResponse
Amazon.CognitoIdentityProvider.Model.ListUsersResponse
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
Syntax
public class ListUsersResponse : AmazonWebServiceResponse
The ListUsersResponse type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListUsersResponse() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ContentLength | System.Int64 | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
|
|
HttpStatusCode | System.Net.HttpStatusCode | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
|
|
PaginationToken | System.String |
Gets and sets the property PaginationToken. The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items. |
|
|
ResponseMetadata | Amazon.Runtime.ResponseMetadata | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
|
|
Users | System.Collections.Generic.List<Amazon.CognitoIdentityProvider.Model.UserType> |
Gets and sets the property Users. An array of user pool users who match your query, and their attributes. Between different requests, you might observe variations in the sequence that users in this response object are sorted into. The sort order of users isn't guaranteed to follow a single pattern, but the paginated list from a single chain of requests won't return duplicates. |
Examples
This request submits a value for all possible parameters for ListUsers. By iterating the PaginationToken, you can page through and collect all users in a user pool.
A ListUsers request for the next 3 users whose email address starts with "testuser."
var client = new AmazonCognitoIdentityProviderClient();
var response = client.ListUsers(new ListUsersRequest
{
AttributesToGet = new List<string> {
"email",
"sub"
},
Filter = "\"email\"^=\"testuser\"",
Limit = 3,
PaginationToken = "abcd1234EXAMPLE",
UserPoolId = "us-east-1_EXAMPLE"
});
string paginationToken = response.PaginationToken;
List<UserType> users = response.Users;
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5