voice_connector_external_systems_configurations

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

Overview

Name	voice_connector_external_systems_configurations
Type	Resource
Id	aws.chime_sdk_voice.voice_connector_external_systems_configurations

Fields

The following fields are returned by SELECT queries:

get_voice_connector_external_systems_configuration

Name	Datatype	Description
contact_center_system_types	array	The contact center system.
session_border_controller_types	array	The session border controllers.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_voice_connector_external_systems_configuration	select	voice_connector_id, region		Gets information about an external systems configuration for a Voice Connector.
put_voice_connector_external_systems_configuration	replace	voice_connector_id, region		Adds an external systems configuration to a Voice Connector.
delete_voice_connector_external_systems_configuration	delete	voice_connector_id, region		Deletes the external systems configuration for a Voice Connector.

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 ID of the Voice Connector for which to delete the external system configuration.

SELECT examples

get_voice_connector_external_systems_configuration

Gets information about an external systems configuration for a Voice Connector.

SELECT
contact_center_system_types,
session_border_controller_types
FROM aws.chime_sdk_voice.voice_connector_external_systems_configurations
WHERE voice_connector_id = '{{ voice_connector_id }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_voice_connector_external_systems_configuration

Adds an external systems configuration to a Voice Connector.

REPLACE aws.chime_sdk_voice.voice_connector_external_systems_configurations
SET 
SessionBorderControllerTypes = '{{ SessionBorderControllerTypes }}',
ContactCenterSystemTypes = '{{ ContactCenterSystemTypes }}'
WHERE 
voice_connector_id = '{{ voice_connector_id }}' --required
AND region = '{{ region }}' --required
RETURNING
external_systems_configuration;

DELETE examples

delete_voice_connector_external_systems_configuration

Deletes the external systems configuration for a Voice Connector.

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