IVS / Client / batch_get_channel

batch_get_channel

IVS.Client.batch_get_channel(**kwargs)

Performs GetChannel on multiple ARNs simultaneously.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_channel(
    arns=[
        'string',
    ]
)

Parameters:

arns (list) –

[REQUIRED]

Array of ARNs, one per channel.

• (string) –

Return type:

dict

Returns:

Response Syntax

{
    'channels': [
        {
            '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'
        },
    ],
    'errors': [
        {
            'arn': 'string',
            'code': 'string',
            'message': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • channels (list) –

    • (dict) –

      Object specifying a channel.

      • 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. Use LOW 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 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) –

      • 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 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 ( "").

      • 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).

  • errors (list) –

    Each error object is related to a specific ARN in the request.

    • (dict) –

      Error related to a specific channel, specified by its ARN.

      • arn (string) –

        ARN of an IVS resource; e.g., channel.

      • code (string) –

        Error code.

      • message (string) –

        Error message, determined by the application.