You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::EventFilter

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing EventFilter as input to an Aws::Client method, you can use a vanilla Hash:

{
  dimensions: { # required
    attributes: {
      "__string" => {
        attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
        values: ["__string"], # required
      },
    },
    event_type: {
      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
      values: ["__string"], # required
    },
    metrics: {
      "__string" => {
        comparison_operator: "__string", # required
        value: 1.0, # required
      },
    },
  },
  filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
}

Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#dimensions ⇒ Types::EventDimensions

The dimensions for the event filter to use for the campaign or the journey activity.

Returns:

  • (Types::EventDimensions) —

    The dimensions for the event filter to use for the campaign or the journey activity.

#filter_type ⇒ String

The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (

Events resource) occurs.

Possible values:

  • SYSTEM
  • ENDPOINT

Returns:

  • (String) —

    The type of event that causes the campaign to be sent or the journey activity to be performed.