voice_connector_proxies

Creates, updates, deletes, gets or lists a voice_connector_proxies resource.

Overview

Name	voice_connector_proxies
Type	Resource
Id	aws.chime_sdk_voice.voice_connector_proxies

Fields

The following fields are returned by SELECT queries:

get_voice_connector_proxy

Name	Datatype	Description
default_session_expiry_minutes	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.
fall_back_phone_number	string	The phone number to route calls to after a proxy session expires. (pattern: <code>^+?[1-9]\d{1,14}$</code>)
phone_number_countries	array	The countries for proxy phone numbers to be selected from.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_voice_connector_proxy	select	voice_connector_id, region		Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.
put_voice_connector_proxy	replace	voice_connector_id, region, DefaultSessionExpiryMinutes, PhoneNumberPoolCountries		Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.
delete_voice_connector_proxy	delete	voice_connector_id, region		Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
voice_connector_id	string	The Voice Connector ID.

SELECT examples

get_voice_connector_proxy

Retrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.

SELECT
default_session_expiry_minutes,
disabled,
fall_back_phone_number,
phone_number_countries
FROM aws.chime_sdk_voice.voice_connector_proxies
WHERE voice_connector_id = '{{ voice_connector_id }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_voice_connector_proxy

Puts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.

REPLACE aws.chime_sdk_voice.voice_connector_proxies
SET 
DefaultSessionExpiryMinutes = {{ DefaultSessionExpiryMinutes }},
PhoneNumberPoolCountries = '{{ PhoneNumberPoolCountries }}',
FallBackPhoneNumber = '{{ FallBackPhoneNumber }}',
Disabled = {{ Disabled }}
WHERE 
voice_connector_id = '{{ voice_connector_id }}' --required
AND region = '{{ region }}' --required
AND DefaultSessionExpiryMinutes = '{{ DefaultSessionExpiryMinutes }}' --required
AND PhoneNumberPoolCountries = '{{ PhoneNumberPoolCountries }}' --required
RETURNING
proxy;

DELETE examples

delete_voice_connector_proxy

Deletes the proxy configuration from the specified Amazon Chime SDK Voice Connector. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.

DELETE FROM aws.chime_sdk_voice.voice_connector_proxies
WHERE voice_connector_id = '{{ voice_connector_id }}' --required
AND region = '{{ region }}' --required
;