:doc:`IVS <../../ivs>` / Client / get_channel

***********
get_channel
***********



.. py:method:: IVS.Client.get_channel(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannel>`_  


  **Request Syntax**
  ::

    response = client.get_channel(
        arn='string'
    )
    
  :type arn: string
  :param arn: **[REQUIRED]** 

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

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'channel': {
              'arn': 'string',
              'authorized': True|False,
              'containerFormat': 'TS'|'FRAGMENTED_MP4',
              'ingestEndpoint': 'string',
              'insecureIngest': True|False,
              'latencyMode': 'NORMAL'|'LOW',
              'multitrackInputConfiguration': {
                  'enabled': True|False,
                  'maximumResolution': 'SD'|'HD'|'FULL_HD',
                  'policy': 'ALLOW'|'REQUIRE'
              },
              'name': 'string',
              'playbackRestrictionPolicyArn': 'string',
              'playbackUrl': 'string',
              'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
              'recordingConfigurationArn': 'string',
              'srt': {
                  'endpoint': 'string',
                  'passphrase': 'string'
              },
              'tags': {
                  'string': 'string'
              },
              'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **channel** *(dict) --* 
        

        - **arn** *(string) --* 

          Channel ARN.

          
        

        - **authorized** *(boolean) --* 

          Whether the channel is private (enabled for playback authorization). Default: ``false``.

          
        

        - **containerFormat** *(string) --* 

          Indicates which content-packaging format is used (MPEG-TS or fMP4). If ``multitrackInputConfiguration`` is specified and ``enabled`` is ``true``, then ``containerFormat`` is required and must be set to ``FRAGMENTED_MP4``. Otherwise, ``containerFormat`` may be set to ``TS`` or ``FRAGMENTED_MP4``. Default: ``TS``.

          
        

        - **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``.

          
        

        - **multitrackInputConfiguration** *(dict) --* 

          Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.

          
          

          - **enabled** *(boolean) --* 

            Indicates whether multitrack input is enabled. Can be set to ``true`` only if channel type is ``STANDARD``. Setting ``enabled`` to ``true`` with any other channel type will cause an exception. If ``true``, then ``policy``, ``maximumResolution``, and ``containerFormat`` are required, and ``containerFormat`` must be set to ``FRAGMENTED_MP4``. Default: ``false``.

            
          

          - **maximumResolution** *(string) --* 

            Maximum resolution for multitrack input. Required if ``enabled`` is ``true``.

            
          

          - **policy** *(string) --* 

            Indicates whether multitrack input is allowed or required. Required if ``enabled`` is ``true``.

            
      
        

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

          
        

        - **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.

            
      
        

        - **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 <https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html>`__ 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) --* 
      
    
        

        - **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 <https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html>`__.

          
    
  
  **Exceptions**
  
  *   :py:class:`IVS.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IVS.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`IVS.Client.exceptions.ValidationException`

  