:doc:`ivsrealtime <../../ivs-realtime>` / Client / get_encoder_configuration

*************************
get_encoder_configuration
*************************



.. py:method:: ivsrealtime.Client.get_encoder_configuration(**kwargs)

  

  Gets information about the specified EncoderConfiguration resource.

  

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


  **Request Syntax**
  ::

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

    ARN of the EncoderConfiguration resource.

    

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

    
    ::

      {
          'encoderConfiguration': {
              'arn': 'string',
              'name': 'string',
              'video': {
                  'width': 123,
                  'height': 123,
                  'framerate': ...,
                  'bitrate': 123
              },
              'tags': {
                  'string': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **encoderConfiguration** *(dict) --* 

        The EncoderConfiguration that was returned.

        
        

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

          ARN of the EncoderConfiguration resource.

          
        

        - **name** *(string) --* 

          Optional name to identify the resource.

          
        

        - **video** *(dict) --* 

          Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps

          
          

          - **width** *(integer) --* 

            Video-resolution width. This must be an even number. Note that the maximum value is determined by ``width`` times ``height``, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.

            
          

          - **height** *(integer) --* 

            Video-resolution height. This must be an even number. Note that the maximum value is determined by ``width`` times ``height``, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.

            
          

          - **framerate** *(float) --* 

            Video frame rate, in fps. Default: 30.

            
          

          - **bitrate** *(integer) --* 

            Bitrate for generated output, in bps. Default: 2500000.

            
      
        

        - **tags** *(dict) --* 

          Tags attached to the resource. Array of 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 AWS Resources and Tag Editor* for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
    
  
  **Exceptions**
  
  *   :py:class:`ivsrealtime.Client.exceptions.ResourceNotFoundException`

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

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

  
  *   :py:class:`ivsrealtime.Client.exceptions.InternalServerException`

  
  *   :py:class:`ivsrealtime.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`ivsrealtime.Client.exceptions.ConflictException`

  