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

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

Overview

Note:

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

{
  description: "__string",
  event_start_condition: {
    event_filter: {
      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
          },
        },
      },
      filter_type: "SYSTEM", # required, accepts SYSTEM, ENDPOINT
    },
    segment_id: "__string",
  },
  segment_start_condition: {
    segment_id: "__string", # required
  },
}

Specifies the conditions for the first activity in a journey. This activity and its conditions determine which users are participants in a journey.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The custom description of the condition.

Returns:

  • (String)

    The custom description of the condition.

#event_start_conditionTypes::EventStartCondition

Specifies the settings for an event that causes a journey activity to start.

Returns:

#segment_start_conditionTypes::SegmentCondition

The segment that\'s associated with the first activity in the journey. This segment determines which users are participants in the journey.

Returns: