List Channels
chime_sdk_messaging.list_channels
ActionAmazon Web Servicesconnection required
Calls the AWS chime_sdk_messaging API (SigV4).
Lists all Channels created under a single Chime App as a paginated list.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Amazon Chime SDK Messaging
- Secret shape
- {"access_key_id", "secret_access_key"}
- Config it needs
- region
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, 2 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 | — | — | — |
app_instance_arn The ARN of the AppInstance. | string | Yes | — | — | — |
chime_bearer The ARN of the AppInstanceUser or AppInstanceBot that makes the API call. | string | Yes | — | — | — |
max_results Maximum items to return. | number | No | 50 | ≥ 1 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"max_results": 50
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
Channels | array | — |
NextToken | string | — |
{
"Channels": [],
"NextToken": ""
}Related Amazon Chime SDK Messaging nodes
See List Channels run in a workflow.
In a technical demo we add the Amazon Chime SDK Messaging connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.