ChimeSDKVoice / Client / put_voice_connector_origination

put_voice_connector_origination#

ChimeSDKVoice.Client.put_voice_connector_origination(**kwargs)#

Updates a Voice Connector’s origination settings.

Request Syntax

response = client.put_voice_connector_origination(
    VoiceConnectorId='string',
    Origination={
        'Routes': [
            {
                'Host': 'string',
                'Port': 123,
                'Protocol': 'TCP'|'UDP',
                'Priority': 123,
                'Weight': 123
            },
        ],
        'Disabled': True|False
    }
)

Parameters:

VoiceConnectorId (string) –
[REQUIRED]

The Voice Connector ID.
Origination (dict) –
[REQUIRED]

The origination settings being updated.
- 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.

Return type:

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 updated origination settings.
  - 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

ChimeSDKVoice.Client.exceptions.UnauthorizedClientException
ChimeSDKVoice.Client.exceptions.NotFoundException
ChimeSDKVoice.Client.exceptions.ForbiddenException
ChimeSDKVoice.Client.exceptions.BadRequestException
ChimeSDKVoice.Client.exceptions.ThrottledClientException
ChimeSDKVoice.Client.exceptions.ServiceUnavailableException
ChimeSDKVoice.Client.exceptions.ServiceFailureException