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

# POST /listSignalingChannels

`POST /listSignalingChannels`

Returns an array of <code>ChannelInfo</code> objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a <code>ChannelNameCondition</code>.

## Query parameters

- `MaxResults` string
- `NextToken` string

## Request body

- object
  - `MaxResults` integer — The maximum number of channels to return in the response. The default is 500.
  - `NextToken` string — If you specify this parameter, when the result of a <code>ListSignalingChannels</code> operation is truncated, the call returns the <code>NextToken</code> in the response. To get another batch of channels, provide this token in your next request.
  - `ChannelNameCondition` object — An optional input parameter for the <code>ListSignalingChannels</code> API. When this parameter is specified while invoking <code>ListSignalingChannels</code>, the API returns only the channels that satisfy a condition specified in <code>ChannelNameCondition</code>.
    - `ComparisonOperator` 'BEGINS_WITH' — A comparison operator. Currently, you can only specify the <code>BEGINS_WITH</code> operator, which finds signaling channels whose names begin with a given prefix.
    - `ComparisonValue` string — A value to compare.

## Response `200`

Success

- ListSignalingChannelsOutput
  - `ChannelInfoList` ChannelInfo[] — An array of <code>ChannelInfo</code> objects.
    - `ChannelName` string — The name of the signaling channel.
    - `ChannelARN` string — The Amazon Resource Name (ARN) of the signaling channel.
    - `ChannelType` 'SINGLE_MASTER' | 'FULL_MESH' — The type of the signaling channel.
    - `ChannelStatus` 'CREATING' | 'ACTIVE' | 'UPDATING' | 'DELETING' — Current status of the signaling channel.
    - `CreationTime` string, date-time — The time at which the signaling channel was created.
    - `SingleMasterConfiguration` object — A structure that contains the configuration for the <code>SINGLE_MASTER</code> channel type.
      - `MessageTtlSeconds` integer — The period of time a signaling channel retains undelivered messages before they are discarded.
    - `Version` string — The current version of the signaling channel.
  - `NextToken` string — If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.

## Other responses

- `480` — InvalidArgumentException
- `481` — ClientLimitExceededException
- `482` — AccessDeniedException

---

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