proxy_sessions

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

Overview

Name	proxy_sessions
Type	Resource
Id	aws.chime_sdk_voice.proxy_sessions

Fields

The following fields are returned by SELECT queries:

get_proxy_session

Name	Datatype	Description
capabilities	array	The proxy session capabilities.
created_timestamp	string (date-time)	The created time stamp, in ISO 8601 format.
ended_timestamp	string (date-time)	The ended time stamp, in ISO 8601 format.
expiry_minutes	integer	The number of minutes allowed for the proxy session.
geo_match_level	string	The preference for matching the country or area code of the proxy phone number with that of the first participant. (Country, AreaCode)
geo_match_params	object	The country and area code for a proxy phone number in a proxy phone session.
name	string	The proxy session name.
number_selection_behavior	string	The preference for proxy phone number reuse, or stickiness, between the same participants across sessions. (PreferSticky, AvoidSticky)
participants	array	The proxy session participants.
proxy_session_id	string	The proxy session ID. (pattern: <code>.\S.</code>)
status	string	The proxy session status. (Open, InProgress, Closed)
updated_timestamp	string (date-time)	The updated time stamp, in ISO 8601 format.
voice_connector_id	string	The Voice Connector ID. (pattern: <code>([a-z0-9]{21,22}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})</code>)

list_proxy_sessions

Name	Datatype	Description
next_token	string	The token used to retrieve the next page of results.
proxy_sessions	array	The proxy sessions' details.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_proxy_session	select	voice_connector_id, proxy_session_id, region		Retrieves the specified proxy session 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.
list_proxy_sessions	select	voice_connector_id, region	status, next-token, max-results	Lists the proxy sessions 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.
create_proxy_session	insert	voice_connector_id, region, ParticipantPhoneNumbers, Capabilities		Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.
update_proxy_session	update	voice_connector_id, proxy_session_id, region, Capabilities		Updates the specified proxy session details, such as voice or SMS capabilities. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.
delete_proxy_session	delete	voice_connector_id, proxy_session_id, region		Deletes the specified proxy session 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
proxy_session_id	string	The proxy session ID.
region	string	AWS region (default: us-east-1)
voice_connector_id	string	The Voice Connector ID.
max-results	integer	The maximum number of results to return in a single call.
next-token	string	The token used to retrieve the next page of results.
status	string	The proxy session status.

SELECT examples

get_proxy_session

Retrieves the specified proxy session 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
capabilities,
created_timestamp,
ended_timestamp,
expiry_minutes,
geo_match_level,
geo_match_params,
name,
number_selection_behavior,
participants,
proxy_session_id,
status,
updated_timestamp,
voice_connector_id
FROM aws.chime_sdk_voice.proxy_sessions
WHERE voice_connector_id = '{{ voice_connector_id }}' -- required
AND proxy_session_id = '{{ proxy_session_id }}' -- required
AND region = '{{ region }}' -- required
;

list_proxy_sessions

Lists the proxy sessions 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
next_token,
proxy_sessions
FROM aws.chime_sdk_voice.proxy_sessions
WHERE voice_connector_id = '{{ voice_connector_id }}' -- required
AND region = '{{ region }}' -- required
AND status = '{{ status }}'
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_proxy_session

Creates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.

INSERT INTO aws.chime_sdk_voice.proxy_sessions (
ParticipantPhoneNumbers,
Name,
ExpiryMinutes,
Capabilities,
NumberSelectionBehavior,
GeoMatchLevel,
GeoMatchParams,
voice_connector_id,
region
)
SELECT 
'{{ ParticipantPhoneNumbers }}' /* required */,
'{{ Name }}',
{{ ExpiryMinutes }},
'{{ Capabilities }}' /* required */,
'{{ NumberSelectionBehavior }}',
'{{ GeoMatchLevel }}',
'{{ GeoMatchParams }}',
'{{ voice_connector_id }}',
'{{ region }}'
RETURNING
proxy_session
;

Manifest

# Description fields are for documentation purposes
- name: proxy_sessions
props:
  - name: voice_connector_id
    value: "{{ voice_connector_id }}"
    description: Required parameter for the proxy_sessions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the proxy_sessions resource.
  - name: ParticipantPhoneNumbers
    value:
      - "{{ ParticipantPhoneNumbers }}"
  - name: Name
    value: "{{ Name }}"
  - name: ExpiryMinutes
    value: {{ ExpiryMinutes }}
  - name: Capabilities
    value:
      - "{{ Capabilities }}"
  - name: NumberSelectionBehavior
    value: "{{ NumberSelectionBehavior }}"
    valid_values: ['PreferSticky', 'AvoidSticky']
  - name: GeoMatchLevel
    value: "{{ GeoMatchLevel }}"
    valid_values: ['Country', 'AreaCode']
  - name: GeoMatchParams
    description: |
      The country and area code for a proxy phone number in a proxy phone session.
    value:
      Country: "{{ Country }}"
      AreaCode: "{{ AreaCode }}"

UPDATE examples

update_proxy_session

Updates the specified proxy session details, such as voice or SMS capabilities. End of support notice: On April 7, 2026, AWS will end support for Amazon Chime SDK proxy sessions.

UPDATE aws.chime_sdk_voice.proxy_sessions
SET 
Capabilities = '{{ Capabilities }}',
ExpiryMinutes = {{ ExpiryMinutes }}
WHERE 
voice_connector_id = '{{ voice_connector_id }}' --required
AND proxy_session_id = '{{ proxy_session_id }}' --required
AND region = '{{ region }}' --required
AND Capabilities = '{{ Capabilities }}' --required
RETURNING
proxy_session;

DELETE examples

delete_proxy_session

Deletes the specified proxy session 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.proxy_sessions
WHERE voice_connector_id = '{{ voice_connector_id }}' --required
AND proxy_session_id = '{{ proxy_session_id }}' --required
AND region = '{{ region }}' --required
;