:doc:`ChimeSDKVoice <../../chime-sdk-voice>` / Client / get_voice_connector_origination

*******************************
get_voice_connector_origination
*******************************



.. py:method:: ChimeSDKVoice.Client.get_voice_connector_origination(**kwargs)

  

  Retrieves the origination settings for the specified Voice Connector.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorOrigination>`_  


  **Request Syntax**
  ::

    response = client.get_voice_connector_origination(
        VoiceConnectorId='string'
    )
    
  :type VoiceConnectorId: string
  :param VoiceConnectorId: **[REQUIRED]** 

    The Voice Connector ID.

    

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

    
    ::

      {
          'Origination': {
              'Routes': [
                  {
                      'Host': 'string',
                      'Port': 123,
                      'Protocol': 'TCP'|'UDP',
                      'Priority': 123,
                      'Weight': 123
                  },
              ],
              'Disabled': True|False
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Origination** *(dict) --* 

        The origination setting details.

        
        

        - **Routes** *(list) --* 

          The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20. This parameter is not required, but you must specify this parameter or ``Disabled``.

          
          

          - *(dict) --* 

            Origination routes define call distribution properties for your SIP hosts to receive inbound calls using an Amazon Chime SDK Voice Connector. Limit: Ten origination routes for each Voice Connector.

             

            .. note::

              

              The parameters listed below are not required, but you must use at least one.

              

            
            

            - **Host** *(string) --* 

              The FQDN or IP address to contact for origination traffic.

              
            

            - **Port** *(integer) --* 

              The designated origination route port. Defaults to 5060.

              
            

            - **Protocol** *(string) --* 

              The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use TCP protocol by default.

              
            

            - **Priority** *(integer) --* 

              The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

              
            

            - **Weight** *(integer) --* 

              The weight assigned to an origination route. When hosts have equal priority, calls are distributed between them based on their relative weights.

              
        
      
        

        - **Disabled** *(boolean) --* 

          When origination settings are disabled, inbound calls are not enabled for your Amazon Chime SDK Voice Connector. This parameter is not required, but you must specify this parameter or ``Routes``.

          
    
  
  **Exceptions**
  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.UnauthorizedClientException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.NotFoundException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ForbiddenException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.BadRequestException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ThrottledClientException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ServiceFailureException`

  