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

# POST /describeSignalingChannel

`POST /describeSignalingChannel`

Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.

## Request body

- object
  - `ChannelName` string — The name of the signaling channel that you want to describe.
  - `ChannelARN` string — The ARN of the signaling channel that you want to describe.

## Response `200`

Success

- DescribeSignalingChannelOutput
  - `ChannelInfo` object — A structure that encapsulates the specified signaling channel's metadata and properties.
    - `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.

## Other responses

- `480` — InvalidArgumentException
- `481` — ClientLimitExceededException
- `482` — ResourceNotFoundException
- `483` — 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)