POST

/createSignalingChannel

http://kinesisvideo.{region}.amazonaws.com/createSignalingChannel

Creates a signaling channel. <code>CreateSignalingChannel</code> is an asynchronous operation.

Access Token Required: API Key

Body Params

Tagsarray

A set of tags (key-value pairs) that you want to associate with this channel.

ChannelNamestringrequired

A name for the signaling channel that you are creating. It must be unique for each Amazon Web Services account and Amazon Web Services Region.

ChannelTypestring

A type of the signaling channel that you are creating. Currently, <code>SINGLE_MASTER</code> is the only supported channel type.

SingleMasterConfigurationobject

A structure that contains the configuration for the <code>SINGLE_MASTER</code> channel type.

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/createSignalingChannel' \
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}