Class: Aws::Pinpoint::Types::HoldoutActivity

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 HoldoutActivity data as a hash:

{
  next_activity: "__string",
  percentage: 1, # required
}

Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#next_activityString

The unique identifier for the next activity to perform, after performing the holdout activity.

Returns:

  • (String)


10152
10153
10154
10155
10156
10157
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10152

class HoldoutActivity < Struct.new(
  :next_activity,
  :percentage)
  SENSITIVE = []
  include Aws::Structure
end

#percentageInteger

The percentage of participants who shouldn't continue the journey.

To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.

Returns:

  • (Integer)


10152
10153
10154
10155
10156
10157
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10152

class HoldoutActivity < Struct.new(
  :next_activity,
  :percentage)
  SENSITIVE = []
  include Aws::Structure
end