IVS / Client / create_channel
create_channel#
- IVS.Client.create_channel(**kwargs)#
Creates a new channel and an associated stream key to start streaming.
See also: AWS API Documentation
Request Syntax
response = client.create_channel( name='string', latencyMode='NORMAL'|'LOW', type='BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD', authorized=True|False, recordingConfigurationArn='string', tags={ 'string': 'string' }, insecureIngest=True|False, preset='HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY', playbackRestrictionPolicyArn='string' )
- Parameters:
name (string) – Channel name.
latencyMode (string) – Channel latency mode. Use
NORMAL
to broadcast and deliver live video up to Full HD. UseLOW
for near-real-time interaction with viewers. Default:LOW
.type (string) – Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default:
STANDARD
. For details, see Channel Types.authorized (boolean) – Whether the channel is private (enabled for playback authorization). Default:
false
.recordingConfigurationArn (string) – Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: “” (empty string, recording is disabled).
tags (dict) –
Array of 1-50 maps, each of the form
string:string (key:value)
. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.(string) –
(string) –
insecureIngest (boolean) – Whether the channel allows insecure RTMP and SRT ingest. Default:
false
.preset (string) – Optional transcode preset for the channel. This is selectable only for
ADVANCED_HD
andADVANCED_SD
channel types. For those channel types, the defaultpreset
isHIGHER_BANDWIDTH_DELIVERY
. For other channel types (BASIC
andSTANDARD
),preset
is the empty string (""
).playbackRestrictionPolicyArn (string) – Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: “” (empty string, no playback restriction policy is applied).
- Return type:
dict
- Returns:
Response Syntax
{ 'channel': { 'arn': 'string', 'name': 'string', 'latencyMode': 'NORMAL'|'LOW', 'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD', 'recordingConfigurationArn': 'string', 'ingestEndpoint': 'string', 'playbackUrl': 'string', 'authorized': True|False, 'tags': { 'string': 'string' }, 'insecureIngest': True|False, 'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY', 'srt': { 'endpoint': 'string', 'passphrase': 'string' }, 'playbackRestrictionPolicyArn': 'string' }, 'streamKey': { 'arn': 'string', 'value': 'string', 'channelArn': 'string', 'tags': { 'string': 'string' } } }
Response Structure
(dict) –
channel (dict) –
arn (string) –
Channel ARN.
name (string) –
Channel name.
latencyMode (string) –
Channel latency mode. Use
NORMAL
to broadcast and deliver live video up to Full HD. UseLOW
for near-real-time interaction with viewers. Default:LOW
.type (string) –
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default:
STANDARD
. For details, see Channel Types.recordingConfigurationArn (string) –
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: “” (empty string, recording is disabled).
ingestEndpoint (string) –
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
playbackUrl (string) –
Channel playback URL.
authorized (boolean) –
Whether the channel is private (enabled for playback authorization). Default:
false
.tags (dict) –
Tags attached to the resource. Array of 1-50 maps, each of the form
string:string (key:value)
. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.(string) –
(string) –
insecureIngest (boolean) –
Whether the channel allows insecure RTMP ingest. Default:
false
.preset (string) –
Optional transcode preset for the channel. This is selectable only for
ADVANCED_HD
andADVANCED_SD
channel types. For those channel types, the defaultpreset
isHIGHER_BANDWIDTH_DELIVERY
. For other channel types (BASIC
andSTANDARD
),preset
is the empty string (""
).srt (dict) –
Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
endpoint (string) –
The endpoint to be used when streaming with IVS using the SRT protocol.
passphrase (string) –
Auto-generated passphrase to enable encryption. This field is applicable only if the end user has not enabled the
insecureIngest
option for the channel.
playbackRestrictionPolicyArn (string) –
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: “” (empty string, no playback restriction policy is applied).
streamKey (dict) –
arn (string) –
Stream-key ARN.
value (string) –
Stream-key value.
channelArn (string) –
Channel ARN for the stream.
tags (dict) –
Tags attached to the resource. Array of 1-50 maps, each of the form
string:string (key:value)
. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.(string) –
(string) –
Exceptions
IVS.Client.exceptions.ResourceNotFoundException
IVS.Client.exceptions.AccessDeniedException
IVS.Client.exceptions.ValidationException
IVS.Client.exceptions.PendingVerification
IVS.Client.exceptions.ServiceQuotaExceededException