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

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

Overview

Note:

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

{
  condition: {
    conditions: [
      {
        event_condition: {
          dimensions: {
            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
  },
  evaluation_wait_time: {
    wait_for: "__string",
    wait_until: "__string",
  },
  false_activity: "__string",
  true_activity: "__string",
}

Specifies the settings for a yes/no split activity in a journey. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

To create yes/no split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#conditionTypes::Condition

The conditions that define the paths for the activity, and the relationship between the conditions.

Returns:

  • (Types::Condition)

    The conditions that define the paths for the activity, and the relationship between the conditions.

#evaluation_wait_timeTypes::WaitTime

The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.

Returns:

  • (Types::WaitTime)

    The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.

#false_activityString

The unique identifier for the activity to perform if the conditions aren\'t met.

Returns:

  • (String)

    The unique identifier for the activity to perform if the conditions aren\'t met.

#true_activityString

The unique identifier for the activity to perform if the conditions are met.

Returns:

  • (String)

    The unique identifier for the activity to perform if the conditions are met.