IVS / Client / get_channel

get_channel

IVS.Client.get_channel(**kwargs)

Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.

See also: AWS API Documentation

Request Syntax

response = client.get_channel(
    arn='string'
)

Parameters:

arn (string) –

[REQUIRED]

ARN of the channel for which the configuration is to be retrieved.

Return type:

dict

Returns:

Response Syntax

{
    'channel': {
        'arn': 'string',
        'authorized': True|False,
        'ingestEndpoint': 'string',
        'latencyMode': 'NORMAL'|'LOW',
        'name': 'string',
        'playbackUrl': 'string',
        'recordingConfigurationArn': 'string',
        'tags': {
            'string': 'string'
        },
        'type': 'BASIC'|'STANDARD'
    }
}

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.

    • 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. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

    • name (string) –

      Channel name.

    • playbackUrl (string) –

      Channel playback URL.

    • recordingConfigurationArn (string) –

      Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. 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 resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:

      • STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default.

      • BASIC: Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

Exceptions

• IVS.Client.exceptions.ResourceNotFoundException

• IVS.Client.exceptions.AccessDeniedException

• IVS.Client.exceptions.ValidationException