如何在Android Java项目中调用Amazon Cognito ListUsers接口获取用户池用户名

首先明确：Amplify官方Auth模块没有直接封装Cognito的ListUsers管理接口，你需要配合AWS Android SDK的Cognito Identity Provider组件完成调用，具体操作步骤如下：

前置权限配置 #

ListUsers属于Cognito用户池的管理类接口，默认普通用户身份没有调用权限：

• 如果你是做内部管理类应用，可以在AWS IAM控制台给移动端用户对应的身份池角色添加cognito-idp:ListUsers权限，资源指定为你的Cognito用户池ARN即可
• 如果你开发的是面向普通C端用户的应用，不建议直接在移动端调用该接口，避免泄露全量用户信息，最好把查询逻辑封装到你的自有后端服务，移动端仅调用后端的封装接口即可

步骤1：添加依赖 #

在app模块的build.gradle文件的dependencies节点中添加以下依赖，同步项目：

implementation 'com.amazonaws:aws-android-sdk-cognitoidentityprovider:2.73.0'

你可以根据自己项目的AWS SDK版本调整版本号，保持版本统一即可。

步骤2：编写调用代码 #

因为你已经完成了Amplify的初始化，可以直接从Amplify的授权会话中获取AWS凭证发起请求，代码示例如下：

// 替换为你自己的Cognito用户池ID和对应区域
String userPoolId = "你的用户池ID，格式类似us-east-1_XXXXXXXXX";
Regions cognitoRegion = Regions.US_EAST_1; // 替换为你的用户池所在区域

// 异步获取授权会话后发起请求
Amplify.Auth.fetchAuthSession(
    authSession -> {
        if (!authSession.isSignedIn()) {
            Log.e("ListUsers", "用户未登录，无法调用接口");
            return;
        }
        // 构建Cognito IDP客户端
        AWSCognitoIdentityProviderClient idpClient = new AWSCognitoIdentityProviderClient(
            ((AWSCognitoAuthSession) authSession).getAWSCredentials().getValue(),
            cognitoRegion
        );
        // 构建请求参数
        ListUsersRequest listRequest = new ListUsersRequest();
        listRequest.setUserPoolId(userPoolId);
        // 可选：仅返回用户名字段，减少返回数据体积
        listRequest.setAttributesToGet(Collections.singletonList("username"));

        List<String> allUsernameList = new ArrayList<>();
        try {
            ListUsersResult result = idpClient.listUsers(listRequest);
            // 处理第一页数据
            for (UserType user : result.getUsers()) {
                allUsernameList.add(user.getUsername());
            }
            // 处理分页：单次请求最多返回60条用户，有分页令牌的话循环拉取剩余数据
            while (result.getPaginationToken() != null) {
                listRequest.setPaginationToken(result.getPaginationToken());
                result = idpClient.listUsers(listRequest);
                for (UserType user : result.getUsers()) {
                    allUsernameList.add(user.getUsername());
                }
            }
            // 拉取完成，这里可以切回主线程更新UI
            Log.i("ListUsers", "全量用户名列表：" + allUsernameList);
        } catch (Exception e) {
            Log.e("ListUsers", "调用接口失败", e);
        }
    },
    error -> Log.e("ListUsers", "获取授权会话失败", error)
);

注意事项 #

• 调用逻辑为异步操作，不要在主线程直接执行
• 如果你的用户池用户量超过60，必须处理分页逻辑，避免只拿到部分用户数据
• 注意控制接口的调用频率，Cognito对ListUsers接口有流控限制，短时间大量调用会被拒绝服务

内容的提问来源于stack exchange，提问作者davyioner