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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::CampaignEventFilter

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass CampaignEventFilter data as a hash:

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

An object that defines the events that cause the campaign to be sent.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #dimensions ⇒ Types::EventDimensions

  An object that defines the dimensions for the event filter.

• #filter_type ⇒ String

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

Instance Attribute Details

#dimensions ⇒ Types::EventDimensions

An object that defines the dimensions for the event filter.

Returns:

• (Types::EventDimensions)

# File 'lib/aws-sdk-pinpoint/types.rb', line 1532

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

#filter_type ⇒ String

The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 1532

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