---
title: "POST /ListChannels"
method: POST
path: "/ListChannels"
---

# POST /ListChannels

`POST /ListChannels`

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).

## Query parameters

- `maxResults` string
- `nextToken` string

## Request body

- object
  - `filterByName` string — Filters the channel list to match the specified name.
  - `filterByRecordingConfigurationArn` string — Filters the channel list to match the specified recording-configuration ARN.
  - `maxResults` integer — Maximum number of channels to return. Default: 100.
  - `nextToken` string — The first channel to retrieve. This is used for pagination; see the <code>nextToken</code> response field.

## Response `200`

Success

- ListChannelsResponse
  - `channels` ChannelSummary[], required — List of the matching channels.
    - `arn` string — Channel ARN.
    - `authorized` boolean — Whether the channel is private (enabled for playback authorization). Default: <code>false</code>.
    - `insecureIngest` boolean — Whether the channel allows insecure RTMP ingest. Default: <code>false</code>.
    - `latencyMode` 'NORMAL' | 'LOW' — Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. Default: <code>LOW</code>. (Note: In the Amazon IVS console, <code>LOW</code> and <code>NORMAL</code> correspond to Ultra-low and Standard, respectively.)
    - `name` string — Channel name.
    - `recordingConfigurationArn` string — Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
    - `tags` object — Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
  - `nextToken` string — If there are more channels than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.

## Other responses

- `480` — AccessDeniedException
- `481` — ValidationException
- `482` — ConflictException

---

[API](https://skmtc.net/aws/apis/ivs.md) · [All operations](https://skmtc.net/aws/apis/ivs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/ivs/versions/32a77504a115/schema)