List Users
cognito.list_users
ActionAmazon Web Servicesconnection required
Calls the AWS cognito API (SigV4).
List users in a Cognito user pool.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Amazon Cognito
- Secret shape
- {"access_key_id", "secret_access_key"}
- Config it needs
- region
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
region AWS region (overrides the connection). | string | No | — | — | — |
user_pool_id Id of the user pool to act on, from its Cognito URL or console — not its name. | string | Yes | — | — | — |
limit Max users (default 25). | number | No | — | ≥ 1 | — |
filter Cognito filter, e.g. email ^= "a". | string | No | — | — | — |
next_token Continues a previous run of this node, using that run's next_token output. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
users | array | — |
count | number | — |
next_token Cursor for the next page; empty when there are no further pages. | string | — |
{
"count": 0,
"next_token": "",
"users": []
}Related Amazon Cognito nodes
See List Users run in a workflow.
In a technical demo we add the Amazon Cognito connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.