ChimeSDKVoice / Client / get_voice_connector_proxy

get_voice_connector_proxy#

ChimeSDKVoice.Client.get_voice_connector_proxy(**kwargs)#

Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.

Request Syntax

response = client.get_voice_connector_proxy(
    VoiceConnectorId='string'
)

Parameters:

VoiceConnectorId (string) –

[REQUIRED]

The Voice Connector ID.

Return type:

dict

Returns:

Response Syntax

{
    'Proxy': {
        'DefaultSessionExpiryMinutes': 123,
        'Disabled': True|False,
        'FallBackPhoneNumber': 'string',
        'PhoneNumberCountries': [
            'string',
        ]
    }
}

Response Structure

(dict) –
- Proxy (dict) –
  
  The proxy configuration details.
  - DefaultSessionExpiryMinutes (integer) –
    
    The default number of minutes allowed for proxy sessions.
  - Disabled (boolean) –
    
    When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.
  - FallBackPhoneNumber (string) –
    
    The phone number to route calls to after a proxy session expires.
  - PhoneNumberCountries (list) –
    
    The countries for proxy phone numbers to be selected from.
    - (string) –

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