CreateChannel - Amazon Interactive Video Service


Creates a new channel and an associated stream key to start streaming.

Request Syntax

POST /CreateChannel HTTP/1.1 Content-type: application/json { "authorized": boolean, "latencyMode": "string", "name": "string", "tags": { "string" : "string" }, "type": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


Whether the channel is authorized. Default: false.

Type: Boolean

Required: No


Channel latency mode. Default: LOW.

Type: String

Valid Values: NORMAL | LOW

Required: No


Channel name.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: ^[a-zA-Z0-9-_]*$

Required: No


See Channel:tags.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No


Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:

  • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.

  • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.

Type: String

Valid Values: BASIC | STANDARD

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "channel": { "arn": "string", "authorized": boolean, "ingestEndpoint": "string", "latencyMode": "string", "name": "string", "playbackUrl": "string", "tags": { "string" : "string" }, "type": "string" }, "streamKey": { "arn": "string", "channelArn": "string", "tags": { "string" : "string" }, "value": "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.


Type: Channel object


Type: StreamKey object


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


HTTP Status Code: 403


HTTP Status Code: 403


HTTP Status Code: 402


HTTP Status Code: 400

See Also

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