GetExperimentResult

data class GetExperimentResult(val arn: String? = null, val description: String? = null, val metricGoals: List<ExperimentMetricGoalObject>? = null, val onlineAbConfig: ExperimentOnlineAbConfigObject? = null, val randomizationSalt: String? = null, val removeSegment: Boolean? = null, val runningStatus: ExperimentRunningStatusObject? = null, val samplingRate: Int? = null, val segment: String? = null, val tags: List<Tag>? = null, val treatments: List<ExperimentTreatmentObject>? = null)

Constructors

Link copied to clipboard
constructor(arn: String? = null, description: String? = null, metricGoals: List<ExperimentMetricGoalObject>? = null, onlineAbConfig: ExperimentOnlineAbConfigObject? = null, randomizationSalt: String? = null, removeSegment: Boolean? = null, runningStatus: ExperimentRunningStatusObject? = null, samplingRate: Int? = null, segment: String? = null, tags: List<Tag>? = null, treatments: List<ExperimentTreatmentObject>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String? = null

The ARN of the experiment. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/experiment/myExperiment

Link copied to clipboard
val description: String? = null

An optional description of the experiment.

Link copied to clipboard

An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal. You can use up to three metrics in an experiment.

Link copied to clipboard

A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

Link copied to clipboard

When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt . If you omit randomizationSalt , Evidently uses the experiment name as the randomizationSalt .

Link copied to clipboard
val removeSegment: Boolean? = null

Set this to true to remove the segment that is associated with this experiment. You can't use this parameter if the experiment is currently running.

Link copied to clipboard

Start Experiment. Default is False

Link copied to clipboard
val samplingRate: Int? = null

The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature. This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.

Link copied to clipboard
val segment: String? = null

Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. For more information, see Segment rule pattern syntax .

Link copied to clipboard
val tags: List<Tag>? = null

An array of key-value pairs to apply to this resource.

Link copied to clipboard

An array of structures that describe the configuration of each feature variation used in the experiment.