Class: Aws::Pinpoint::Types::StartCondition

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

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

{
  description: "__string",
  event_start_condition: {
    event_filter: {
      dimensions: { # required
        attributes: {
          "__string" => {
            attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
            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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

The custom description of the condition.

Returns:

  • (String) 


17190
17191
17192
17193
17194
17195
17196
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 17190

class StartCondition < Struct.new(
  :description,
  :event_start_condition,
  :segment_start_condition)
  SENSITIVE = []
  include Aws::Structure
end

#event_start_condition ⇒ Types::EventStartCondition

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

Returns:



17190
17191
17192
17193
17194
17195
17196
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 17190

class StartCondition < Struct.new(
  :description,
  :event_start_condition,
  :segment_start_condition)
  SENSITIVE = []
  include Aws::Structure
end

#segment_start_condition ⇒ Types::SegmentCondition

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

Returns:



17190
17191
17192
17193
17194
17195
17196
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 17190

class StartCondition < Struct.new(
  :description,
  :event_start_condition,
  :segment_start_condition)
  SENSITIVE = []
  include Aws::Structure
end