AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Lists users and their basic details in a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests
for this API operation. For this operation, you must use IAM credentials to authorize
requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
For .NET Core this operation is only available in asynchronous form. Please refer to ListUsersAsync.
Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public virtual ListUsersResponse ListUsers( ListUsersRequest request )
Container for the necessary parameters to execute the ListUsers service method.
| Exception | Condition |
|---|---|
| InternalErrorException | This exception is thrown when Amazon Cognito encounters an internal error. |
| InvalidParameterException | This exception is thrown when the Amazon Cognito service encounters an invalid parameter. |
| NotAuthorizedException | This exception is thrown when a user isn't authorized. |
| ResourceNotFoundException | This exception is thrown when the Amazon Cognito service can't find the requested resource. |
| TooManyRequestsException | This exception is thrown when the user has made too many requests for a given operation. |
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.
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;
.NET Framework:
Supported in: 4.5, 4.0, 3.5