voice_connector_streaming_configurations

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

Overview

Name	voice_connector_streaming_configurations
Type	Resource
Id	aws.chime_sdk_voice.voice_connector_streaming_configurations

Fields

The following fields are returned by SELECT queries:

get_voice_connector_streaming_configuration

Name	Datatype	Description
data_retention_in_hours	integer	The amount of time, in hours, to the Kinesis data.
disabled	boolean	When true, streaming to Kinesis is off.
media_insights_configuration	object	The call analytics configuration.
streaming_notification_targets	array	The streaming notification targets.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_voice_connector_streaming_configuration	select	voice_connector_id, region		Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.
put_voice_connector_streaming_configuration	replace	voice_connector_id, region, StreamingConfiguration		Updates a Voice Connector's streaming configuration settings.
delete_voice_connector_streaming_configuration	delete	voice_connector_id, region		Deletes a Voice Connector's streaming configuration.

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_streaming_configuration

Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

SELECT
data_retention_in_hours,
disabled,
media_insights_configuration,
streaming_notification_targets
FROM aws.chime_sdk_voice.voice_connector_streaming_configurations
WHERE voice_connector_id = '{{ voice_connector_id }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_voice_connector_streaming_configuration

Updates a Voice Connector's streaming configuration settings.

REPLACE aws.chime_sdk_voice.voice_connector_streaming_configurations
SET 
StreamingConfiguration = '{{ StreamingConfiguration }}'
WHERE 
voice_connector_id = '{{ voice_connector_id }}' --required
AND region = '{{ region }}' --required
AND StreamingConfiguration = '{{ StreamingConfiguration }}' --required
RETURNING
streaming_configuration;

DELETE examples

delete_voice_connector_streaming_configuration

Deletes a Voice Connector's streaming configuration.

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