Any documentation on how to use the Token for pagination (Admin Actions API)?

[hrqmonteiro]

Which Category is your question related to?

Questions

Amplify CLI Version

6.1.0

What AWS Services are you utilizing?

Cognito, Amplify

Provide additional details e.g. code snippets

I am following this tutorial: https://docs.amplify.aws/cli/auth/admin/#enable-admin-queries
For using the API requests related to the listUsers

And i did it, like this:

let nextToken

async function listUsers(limit: number) {
    const apiName = 'AdminQueries'
    const path = '/listUsers'
    const myInit = {
      queryStringParameters: {
        limit: limit,
        token: nextToken,
      },
      headers: {
        'Content-Type': 'application/json',
        Authorization: `${(await Auth.currentSession())
          .getAccessToken()
          .getJwtToken()}`,
      },
    }
    const { NextToken, ...rest } = await API.get(apiName, path, myInit)
    nextToken = NextToken
    return rest
  }

And, okay, it is working. I can list 60 users in my Cognito user pool. But there's no documentation or tutorial on how to use the pagination queries.
How can i list the next users on it? I can't do it and theres no clues for it.

[yuth]

The above code should get second page when you call the listUser second time as the nextToken is set from the first request. If you want to load all the user in a loop you could try something like this.

async function listAllUsers() {
  let nextToken;
  const results = [];
  const apiName = "AdminQueries";
  const path = "/listUsers";
  do {
    const myInit = {
      queryStringParameters: {
        limit: 100,
        token: nextToken,
      },
      headers: {
        "Content-Type": "application/json",
        Authorization: `${(await Auth.currentSession())
          .getAccessToken()
          .getJwtToken()}`,
      },
    };
    const { NextToken, Users } = await API.get(apiName, path, myInit);
    nextToken = NextToken;
    results.push(...Users);
  } while (nextToken);

  return results;
}

PS: I would not recommend loading all users at once. The above code is not optimized and is for demonstration purpose.

[hrqmonteiro]

The above code should get second page when you call the listUser second time as the nextToken is set from the first request. If you want to load all the user in a loop you could try something like this.

async function listAllUsers() {
  let nextToken;
  const results = [];
  const apiName = "AdminQueries";
  const path = "/listUsers";
  do {
    const myInit = {
      queryStringParameters: {
        limit: 100,
        token: nextToken,
      },
      headers: {
        "Content-Type": "application/json",
        Authorization: `${(await Auth.currentSession())
          .getAccessToken()
          .getJwtToken()}`,
      },
    };
    const { NextToken, Users } = await API.get(apiName, path, myInit);
    nextToken = NextToken;
    results.push(...Users);
  } while (nextToken);

  return results;
}

PS: I would not recommend loading all users at once. The above code is not optimized and is for demonstration purpose.

That didn't work, man. Any other suggestions.
And it is no problem to load all users at once, cause i have an elasticsearch for that, and the max numbers of my users won't be that much.

[github-actions]

This issue has been automatically locked since there hasn't been any recent activity after it was closed. Please open a new issue for related bugs.

Looking for a help forum? We recommend joining the Amplify Community Discord server *-help channels for those types of questions.