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

Class: Aws::Pinpoint::Types::Condition

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

Overview

Note:

When passing Condition as input to an Aws::Client method, you can use a vanilla Hash:

{
  conditions: [
    {
      event_condition: {
        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
            },
          },
        },
        message_activity: "__string",
      },
      segment_condition: {
        segment_id: "__string", # required
      },
      segment_dimensions: {
        attributes: {
          "__string" => {
            attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
            values: ["__string"], # required
          },
        },
        behavior: {
          recency: {
            duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
            recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
          },
        },
        demographic: {
          app_version: {
            dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
            values: ["__string"], # required
          },
          channel: {
            dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
            values: ["__string"], # required
          },
          device_type: {
            dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
            values: ["__string"], # required
          },
          make: {
            dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
            values: ["__string"], # required
          },
          model: {
            dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
            values: ["__string"], # required
          },
          platform: {
            dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
            values: ["__string"], # required
          },
        },
        location: {
          country: {
            dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
            values: ["__string"], # required
          },
          gps_point: {
            coordinates: { # required
              latitude: 1.0, # required
              longitude: 1.0, # required
            },
            range_in_kilometers: 1.0,
          },
        },
        metrics: {
          "__string" => {
            comparison_operator: "__string", # required
            value: 1.0, # required
          },
        },
        user_attributes: {
          "__string" => {
            attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
            values: ["__string"], # required
          },
        },
      },
    },
  ],
  operator: "ALL", # accepts ALL, ANY
}

Specifies the conditions to evaluate for an activity in a journey, and how to evaluate those conditions.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#conditionsArray<Types::SimpleCondition>

The conditions to evaluate for the activity.

Returns:

#operatorString

Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.

Possible values:

  • ALL
  • ANY

Returns:

  • (String)

    Specifies how to handle multiple conditions for the activity.