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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass CampaignEventFilter data as a 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.

Instance Attribute Summary collapse

Instance Attribute Details

#dimensionsTypes::EventDimensions

The dimension settings of the event filter for the campaign.



1856
1857
1858
1859
1860
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1856

class CampaignEventFilter < Struct.new(
  :dimensions,
  :filter_type)
  include Aws::Structure
end

#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.

Returns:

  • (String)


1856
1857
1858
1859
1860
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1856

class CampaignEventFilter < Struct.new(
  :dimensions,
  :filter_type)
  include Aws::Structure
end