case_event_configurations

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

Overview

Name	case_event_configurations
Type	Resource
Id	aws.connectcases.case_event_configurations

Fields

The following fields are returned by SELECT queries:

get_case_event_configuration

Name	Datatype	Description
enabled	boolean	Indicates whether the to broadcast case event data to the customer.
included_data	object	Details of what case and related item data is published through the case event stream.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_case_event_configuration	select	domain_id, region		Returns the case event publishing configuration.
put_case_event_configuration	replace	domain_id, region, eventBridge		Adds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the Amazon Connect Administrator 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
domain_id	string	The unique identifier of the Cases domain.
region	string	AWS region (default: us-east-1)

SELECT examples

get_case_event_configuration

Returns the case event publishing configuration.

SELECT
enabled,
included_data
FROM aws.connectcases.case_event_configurations
WHERE domain_id = '{{ domain_id }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_case_event_configuration

Adds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the Amazon Connect Administrator Guide

REPLACE aws.connectcases.case_event_configurations
SET 
eventBridge = '{{ eventBridge }}'
WHERE 
domain_id = '{{ domain_id }}' --required
AND region = '{{ region }}' --required
AND eventBridge = '{{ eventBridge }}' --required;