Class: Aws::Pinpoint::Types::EventDimensions

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::EventDimensions

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Note:

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

{
  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
    },
  },
}

Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #attributes ⇒ Hash<String,Types::AttributeDimension>

  One or more custom attributes that your application reports to Amazon Pinpoint.

• #event_type ⇒ Types::SetDimension

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

• #metrics ⇒ Hash<String,Types::MetricDimension>

  One or more custom metrics that your application reports to Amazon Pinpoint.

Instance Attribute Details

#attributes ⇒ Hash<String,Types::AttributeDimension>

One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

Returns:

• (Hash<String,Types::AttributeDimension>)

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

class EventDimensions < Struct.new(
  :attributes,
  :event_type,
  :metrics)
  include Aws::Structure
end

#event_type ⇒ Types::SetDimension

The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that’s specific to your application. For information about standard events, see [Streaming Amazon Pinpoint Events] in the *Amazon Pinpoint Developer Guide*.

[1]: docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html

Returns:

• (Types::SetDimension)

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

class EventDimensions < Struct.new(
  :attributes,
  :event_type,
  :metrics)
  include Aws::Structure
end

#metrics ⇒ Hash<String,Types::MetricDimension>

One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

Returns:

• (Hash<String,Types::MetricDimension>)

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

class EventDimensions < Struct.new(
  :attributes,
  :event_type,
  :metrics)
  include Aws::Structure
end