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

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

Inherits:

Struct

Object
Struct
Aws::Pinpoint::Types::HoldoutActivity

show all

Defined in:: (unknown)

Overview

Note:

When passing HoldoutActivity as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

Activity#holdout

Instance Attribute Summary collapse

#next_activity ⇒ String
The unique identifier for the next activity to perform, after performing the holdout activity.
#percentage ⇒ Integer
The percentage of participants who shouldn\'t continue the journey.

Instance Attribute Details

#next_activity ⇒ `String`

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

Returns:

(String) —
The unique identifier for the next activity to perform, after performing the holdout activity.

#percentage ⇒ `Integer`

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.