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::EventDimensions

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

Overview

Note:

When passing EventDimensions as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#attributesHash<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>)

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

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

Returns:

  • (Types::SetDimension)

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

#metricsHash<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>)

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