AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::Pinpoint::Types::CampaignEventFilter

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

Overview

Note:

When passing CampaignEventFilter 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 events that cause a campaign to be sent.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#dimensionsTypes::EventDimensions

The dimension settings of the event filter for the campaign.

Returns:

#filter_typeString

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

Events resource) occurs.

Possible values:

  • SYSTEM
  • ENDPOINT

Returns:

  • (String)

    The type of event that causes the campaign to be sent.