event_triggers

Creates, updates, deletes, gets or lists an event_triggers resource.

Overview

Name	event_triggers
Type	Resource
Id	aws.customer_profiles.event_triggers

Fields

The following fields are returned by SELECT queries:

get_event_trigger

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the event trigger was created.
description	string	The description of the event trigger.
event_trigger_conditions	array	A list of conditions that determine when an event should trigger the destination.
event_trigger_limits	object	Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
event_trigger_name	string	The unique name of the event trigger. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
last_updated_at	string (date-time)	The timestamp of when the event trigger was most recently updated.
object_type_name	string	The unique name of the object type. (pattern: <code>^[a-zA-Z_][a-zA-Z_0-9-]*$</code>)
segment_filter	string	The destination is triggered only for profiles that meet the criteria of a segment definition. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
tags	object	An array of key-value pairs to apply to this resource.

list_event_triggers

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the event trigger was created.
description	string	The description of the event trigger.
event_trigger_name	string	The unique name of the event trigger. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
last_updated_at	string (date-time)	The timestamp of when the event trigger was most recently updated.
object_type_name	string	The unique name of the object type. (pattern: <code>^[a-zA-Z_][a-zA-Z_0-9-]*$</code>)
tags	object	An array of key-value pairs to apply to this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_event_trigger	select	domain_name, event_trigger_name, region		Get a specific Event Trigger from the domain.
list_event_triggers	select	domain_name, region	next-token, max-results	List all Event Triggers under a domain.
create_event_trigger	insert	domain_name, event_trigger_name, region, ObjectTypeName, EventTriggerConditions		Creates an event trigger, which specifies the rules when to perform action based on customer's ingested data. Each event stream can be associated with only one integration in the same region and AWS account as the event stream.
update_event_trigger	update	domain_name, event_trigger_name, region		Update the properties of an Event Trigger.
delete_event_trigger	delete	domain_name, event_trigger_name, region		Disable and deletes the Event Trigger. You cannot delete an Event Trigger with an active Integration associated.

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_name	string	The unique name of the domain.
event_trigger_name	string	The unique name of the event trigger.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to return per page.
next-token	string	The pagination token to use with ListEventTriggers.

SELECT examples

get_event_trigger

Get a specific Event Trigger from the domain.

SELECT
created_at,
description,
event_trigger_conditions,
event_trigger_limits,
event_trigger_name,
last_updated_at,
object_type_name,
segment_filter,
tags
FROM aws.customer_profiles.event_triggers
WHERE domain_name = '{{ domain_name }}' -- required
AND event_trigger_name = '{{ event_trigger_name }}' -- required
AND region = '{{ region }}' -- required
;

list_event_triggers

List all Event Triggers under a domain.

SELECT
created_at,
description,
event_trigger_name,
last_updated_at,
object_type_name,
tags
FROM aws.customer_profiles.event_triggers
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_event_trigger

Creates an event trigger, which specifies the rules when to perform action based on customer's ingested data. Each event stream can be associated with only one integration in the same region and AWS account as the event stream.

INSERT INTO aws.customer_profiles.event_triggers (
ObjectTypeName,
Description,
EventTriggerConditions,
SegmentFilter,
EventTriggerLimits,
Tags,
domain_name,
event_trigger_name,
region
)
SELECT 
'{{ ObjectTypeName }}' /* required */,
'{{ Description }}',
'{{ EventTriggerConditions }}' /* required */,
'{{ SegmentFilter }}',
'{{ EventTriggerLimits }}',
'{{ Tags }}',
'{{ domain_name }}',
'{{ event_trigger_name }}',
'{{ region }}'
RETURNING
created_at,
description,
event_trigger_conditions,
event_trigger_limits,
event_trigger_name,
last_updated_at,
object_type_name,
segment_filter,
tags
;

Manifest

# Description fields are for documentation purposes
- name: event_triggers
props:
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the event_triggers resource.
  - name: event_trigger_name
    value: "{{ event_trigger_name }}"
    description: Required parameter for the event_triggers resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the event_triggers resource.
  - name: ObjectTypeName
    value: "{{ ObjectTypeName }}"
  - name: Description
    value: "{{ Description }}"
  - name: EventTriggerConditions
    value:
      - EventTriggerDimensions: "{{ EventTriggerDimensions }}"
        LogicalOperator: "{{ LogicalOperator }}"
  - name: SegmentFilter
    value: "{{ SegmentFilter }}"
  - name: EventTriggerLimits
    description: |
      Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
    value:
      EventExpiration: {{ EventExpiration }}
      Periods:
        - Unit: "{{ Unit }}"
          Value: {{ Value }}
          MaxInvocationsPerProfile: {{ MaxInvocationsPerProfile }}
          Unlimited: {{ Unlimited }}
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_event_trigger

Update the properties of an Event Trigger.

UPDATE aws.customer_profiles.event_triggers
SET 
ObjectTypeName = '{{ ObjectTypeName }}',
Description = '{{ Description }}',
EventTriggerConditions = '{{ EventTriggerConditions }}',
SegmentFilter = '{{ SegmentFilter }}',
EventTriggerLimits = '{{ EventTriggerLimits }}'
WHERE 
domain_name = '{{ domain_name }}' --required
AND event_trigger_name = '{{ event_trigger_name }}' --required
AND region = '{{ region }}' --required
RETURNING
created_at,
description,
event_trigger_conditions,
event_trigger_limits,
event_trigger_name,
last_updated_at,
object_type_name,
segment_filter,
tags;

DELETE examples

delete_event_trigger

Disable and deletes the Event Trigger. You cannot delete an Event Trigger with an active Integration associated.

DELETE FROM aws.customer_profiles.event_triggers
WHERE domain_name = '{{ domain_name }}' --required
AND event_trigger_name = '{{ event_trigger_name }}' --required
AND region = '{{ region }}' --required
;