voice_connector_originations

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

Overview

Name	voice_connector_originations
Type	Resource
Id	aws.chime_sdk_voice.voice_connector_originations

Fields

The following fields are returned by SELECT queries:

get_voice_connector_origination

Name	Datatype	Description
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.
routes	array	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_voice_connector_origination	select	voice_connector_id, region		Retrieves the origination settings for the specified Voice Connector.
put_voice_connector_origination	replace	voice_connector_id, region		Updates a Voice Connector's origination settings.
delete_voice_connector_origination	delete	voice_connector_id, region		Deletes the origination settings for the specified Amazon Chime SDK Voice Connector. If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the origination settings.

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_origination

Retrieves the origination settings for the specified Voice Connector.

SELECT
disabled,
routes
FROM aws.chime_sdk_voice.voice_connector_originations
WHERE voice_connector_id = '{{ voice_connector_id }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_voice_connector_origination

Updates a Voice Connector's origination settings.

REPLACE aws.chime_sdk_voice.voice_connector_originations
SET 
Origination = '{{ Origination }}'
WHERE 
voice_connector_id = '{{ voice_connector_id }}' --required
AND region = '{{ region }}' --required
RETURNING
origination;

DELETE examples

delete_voice_connector_origination

Deletes the origination settings for the specified Amazon Chime SDK Voice Connector. If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the origination settings.

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