POST
/describeSignalingChannel
http://kinesisvideo.{region}.amazonaws.com/describeSignalingChannelReturns 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.
Access Token Required: API Key
Body Params
ChannelARNstring
The ARN of the signaling channel that you want to describe.
ChannelNamestring
The name of the signaling channel that you want to describe.
Responses
{
"success": true,
"data": {
"id": "abc123",
"created_at": "2025-01-01T00:00:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters"
}
}Language
CredentialsAPI KEY
API Key
Enter token below to save for later
cURL Request
1curl --request POST \2 --url 'http://kinesisvideo.{region}.amazonaws.com/describeSignalingChannel' \3 --header 'accept: application/json' \4 --header 'content-type: application/json'Response
1{2 "success": true,3 "data": {4 "id": "abc123",5 "created_at": "2025-01-01T00:00:00Z"6 }7}