Documentation

A structure containing the configuration details of an experiment.

See: newExperiment smart constructor.

Create a value of Experiment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

Experiment, experiment_description - A description of the experiment.

$sel:execution:Experiment', experiment_execution - A structure that contains the date and time that the experiment started and ended.

$sel:metricGoals:Experiment', experiment_metricGoals - 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.

$sel:onlineAbDefinition:Experiment', experiment_onlineAbDefinition - 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.

$sel:project:Experiment', experiment_project - The name or ARN of the project that contains this experiment.

$sel:randomizationSalt:Experiment', experiment_randomizationSalt - This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.

$sel:samplingRate:Experiment', experiment_samplingRate - In thousandths of a percent, the amount of the available audience that is allocated to this experiment. 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, so a value of 10,000 is 10% of the available audience.

$sel:schedule:Experiment', experiment_schedule - A structure that contains the time and date that Evidently completed the analysis of the experiment.

$sel:segment:Experiment', experiment_segment - The audience segment being used for the experiment, if a segment is being used.

$sel:statusReason:Experiment', experiment_statusReason - If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.

$sel:tags:Experiment', experiment_tags - The list of tag keys and values associated with this experiment.

$sel:treatments:Experiment', experiment_treatments - An array of structures that describe the configuration of each feature variation used in the experiment.

$sel:arn:Experiment', experiment_arn - The ARN of the experiment.

$sel:createdTime:Experiment', experiment_createdTime - The date and time that the experiment is first created.

$sel:lastUpdatedTime:Experiment', experiment_lastUpdatedTime - The date and time that the experiment was most recently updated.

Experiment, experiment_name - The name of the experiment.

$sel:status:Experiment', experiment_status - The current state of the experiment.

$sel:type':Experiment', experiment_type - The type of this experiment. Currently, this value must be aws.experiment.onlineab.

A description of the experiment.

A structure that contains the date and time that the experiment started and ended.

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.

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.

The name or ARN of the project that contains this experiment.

This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.

In thousandths of a percent, the amount of the available audience that is allocated to this experiment. 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, so a value of 10,000 is 10% of the available audience.

A structure that contains the time and date that Evidently completed the analysis of the experiment.

The audience segment being used for the experiment, if a segment is being used.

If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.

The list of tag keys and values associated with this experiment.

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

The ARN of the experiment.

The date and time that the experiment is first created.

The date and time that the experiment was most recently updated.

The name of the experiment.

The current state of the experiment.

The type of this experiment. Currently, this value must be aws.experiment.onlineab.