Skip to content

Create Event Trigger

customerprofiles_create_event_trigger R Documentation

Creates an event trigger, which specifies the rules when to perform action based on customer's ingested data

Description

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.

Usage

customerprofiles_create_event_trigger(DomainName, EventTriggerName,
  ObjectTypeName, Description, EventTriggerConditions, SegmentFilter,
  EventTriggerLimits, Tags)

Arguments

DomainName

[required] The unique name of the domain.

EventTriggerName

[required] The unique name of the event trigger.

ObjectTypeName

[required] The unique name of the object type.

Description

The description of the event trigger.

EventTriggerConditions

[required] A list of conditions that determine when an event should trigger the destination.

SegmentFilter

The destination is triggered only for profiles that meet the criteria of a segment definition.

EventTriggerLimits

Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.

Tags

An array of key-value pairs to apply to this resource.

Value

A list with the following syntax: 

list(
  EventTriggerName = "string",
  ObjectTypeName = "string",
  Description = "string",
  EventTriggerConditions = list(
    list(
      EventTriggerDimensions = list(
        list(
          ObjectAttributes = list(
            list(
              Source = "string",
              FieldName = "string",
              ComparisonOperator = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH"|"GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_OR_EQUAL"|"LESS_THAN_OR_EQUAL"|"EQUAL"|"BEFORE"|"AFTER"|"ON"|"BETWEEN"|"NOT_BETWEEN",
              Values = list(
                "string"
              )
            )
          )
        )
      ),
      LogicalOperator = "ANY"|"ALL"|"NONE"
    )
  ),
  SegmentFilter = "string",
  EventTriggerLimits = list(
    EventExpiration = 123,
    Periods = list(
      list(
        Unit = "HOURS"|"DAYS"|"WEEKS"|"MONTHS",
        Value = 123,
        MaxInvocationsPerProfile = 123,
        Unlimited = TRUE|FALSE
      )
    )
  ),
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  LastUpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  Tags = list(
    "string"
  )
)

Request syntax

svc$create_event_trigger(
  DomainName = "string",
  EventTriggerName = "string",
  ObjectTypeName = "string",
  Description = "string",
  EventTriggerConditions = list(
    list(
      EventTriggerDimensions = list(
        list(
          ObjectAttributes = list(
            list(
              Source = "string",
              FieldName = "string",
              ComparisonOperator = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH"|"GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_OR_EQUAL"|"LESS_THAN_OR_EQUAL"|"EQUAL"|"BEFORE"|"AFTER"|"ON"|"BETWEEN"|"NOT_BETWEEN",
              Values = list(
                "string"
              )
            )
          )
        )
      ),
      LogicalOperator = "ANY"|"ALL"|"NONE"
    )
  ),
  SegmentFilter = "string",
  EventTriggerLimits = list(
    EventExpiration = 123,
    Periods = list(
      list(
        Unit = "HOURS"|"DAYS"|"WEEKS"|"MONTHS",
        Value = 123,
        MaxInvocationsPerProfile = 123,
        Unlimited = TRUE|FALSE
      )
    )
  ),
  Tags = list(
    "string"
  )
)