messaging_streaming_configurations

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

Overview

Name	messaging_streaming_configurations
Type	Resource
Id	aws.chime_sdk_messaging.messaging_streaming_configurations

Fields

The following fields are returned by SELECT queries:

get_messaging_streaming_configurations

Name	Datatype	Description
streaming_configurations	array	The streaming settings.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_messaging_streaming_configurations	select	app_instance_arn, region		Retrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.
put_messaging_streaming_configurations	replace	app_instance_arn, region, StreamingConfigurations		Sets the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.
delete_messaging_streaming_configurations	delete	app_instance_arn, region		Deletes the streaming configurations for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

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
app_instance_arn	string	The ARN of the streaming configurations being deleted.
region	string	AWS region (default: us-east-1)

SELECT examples

get_messaging_streaming_configurations

Retrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

SELECT
streaming_configurations
FROM aws.chime_sdk_messaging.messaging_streaming_configurations
WHERE app_instance_arn = '{{ app_instance_arn }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_messaging_streaming_configurations

Sets the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

REPLACE aws.chime_sdk_messaging.messaging_streaming_configurations
SET 
StreamingConfigurations = '{{ StreamingConfigurations }}'
WHERE 
app_instance_arn = '{{ app_instance_arn }}' --required
AND region = '{{ region }}' --required
AND StreamingConfigurations = '{{ StreamingConfigurations }}' --required
RETURNING
streaming_configurations;

DELETE examples

delete_messaging_streaming_configurations

Deletes the streaming configurations for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.

DELETE FROM aws.chime_sdk_messaging.messaging_streaming_configurations
WHERE app_instance_arn = '{{ app_instance_arn }}' --required
AND region = '{{ region }}' --required
;