IVS / Client / create_channel

create_channel#

IVS.Client.create_channel(**kwargs)#

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

Request Syntax

response = client.create_channel(
    authorized=True|False,
    insecureIngest=True|False,
    latencyMode='NORMAL'|'LOW',
    name='string',
    playbackRestrictionPolicyArn='string',
    preset='HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
    recordingConfigurationArn='string',
    tags={
        'string': 'string'
    },
    type='BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
)

Parameters:

authorized (boolean) – Whether the channel is private (enabled for playback authorization). Default: false.
insecureIngest (boolean) – Whether the channel allows insecure RTMP ingest. Default: false.
latencyMode (string) – Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
name (string) – Channel name.
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).
preset (string) – Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types ( BASIC and STANDARD), preset is the empty string ( "").
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 Tagging Amazon Web Services Resources for more information, 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) –
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.

Return type:

dict

Returns:

Response Syntax

{
    'channel': {
        'arn': 'string',
        'authorized': True|False,
        'ingestEndpoint': 'string',
        'insecureIngest': True|False,
        'latencyMode': 'NORMAL'|'LOW',
        'name': 'string',
        'playbackRestrictionPolicyArn': 'string',
        'playbackUrl': 'string',
        'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
        'recordingConfigurationArn': 'string',
        'tags': {
            'string': 'string'
        },
        'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
    },
    'streamKey': {
        'arn': 'string',
        'channelArn': 'string',
        'tags': {
            'string': 'string'
        },
        'value': 'string'
    }
}

Response Structure

(dict) –
- channel (dict) –
  - arn (string) –
    
    Channel ARN.
  - authorized (boolean) –
    
    Whether the channel is private (enabled for playback authorization). Default: false.
  - ingestEndpoint (string) –
    
    Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
  - insecureIngest (boolean) –
    
    Whether the channel allows insecure RTMP ingest. Default: false.
  - latencyMode (string) –
    
    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
  - name (string) –
    
    Channel name.
  - 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).
  - playbackUrl (string) –
    
    Channel playback URL.
  - preset (string) –
    
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types ( BASIC and STANDARD), preset is the empty string ( "").
  - 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) –
    
    Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, 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) –
  - 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.
- streamKey (dict) –
  - arn (string) –
    
    Stream-key ARN.
  - 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 Tagging Amazon Web Services Resources for more information, 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) –
  - value (string) –
    
    Stream-key value.

Exceptions

IVS.Client.exceptions.ResourceNotFoundException
IVS.Client.exceptions.AccessDeniedException
IVS.Client.exceptions.ValidationException
IVS.Client.exceptions.PendingVerification
IVS.Client.exceptions.ServiceQuotaExceededException