CreateSignalingChannel - Amazon Kinesis Video Streams


Creates a signaling channel.

CreateSignalingChannel is an asynchronous operation.

Request Syntax

POST /createSignalingChannel HTTP/1.1 Content-type: application/json { "ChannelName": "string", "ChannelType": "string", "SingleMasterConfiguration": { "MessageTtlSeconds": number }, "Tags": [ { "Key": "string", "Value": "string" } ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes


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

Type: String


Required: No


A structure containing the configuration for the SINGLE_MASTER channel type.

Type: SingleMasterConfiguration object

Required: No


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

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ChannelARN": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The Amazon Resource Name (ARN) of the created channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+


For information about the errors that are common to all actions, see Common Errors.


You do not have required permissions to perform this operation.

HTTP Status Code: 401


You have reached the maximum limit of active signaling channels for this AWS account in this region.

HTTP Status Code: 400


Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

HTTP Status Code: 400


The value for this input parameter is invalid.

HTTP Status Code: 400


The resource is currently not available for this operation. New resources cannot be created with the same name as existing resources. Also, resources cannot be updated or deleted unless they are in an ACTIVE state.

If this exception is returned, do not use it to determine whether the requested resource already exists. Instead, it is recommended you use the resource-specific describe API, for example, DescribeStream for video streams.

HTTP Status Code: 400


You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: