Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Experiment = Experiment' {
- description :: Maybe Text
- execution :: Maybe ExperimentExecution
- metricGoals :: Maybe (NonEmpty MetricGoal)
- onlineAbDefinition :: Maybe OnlineAbDefinition
- project :: Maybe Text
- randomizationSalt :: Maybe Text
- samplingRate :: Maybe Natural
- schedule :: Maybe ExperimentSchedule
- segment :: Maybe Text
- statusReason :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- treatments :: Maybe (NonEmpty Treatment)
- arn :: Text
- createdTime :: POSIX
- lastUpdatedTime :: POSIX
- name :: Text
- status :: ExperimentStatus
- type' :: ExperimentType
- newExperiment :: Text -> UTCTime -> UTCTime -> Text -> ExperimentStatus -> ExperimentType -> Experiment
- experiment_description :: Lens' Experiment (Maybe Text)
- experiment_execution :: Lens' Experiment (Maybe ExperimentExecution)
- experiment_metricGoals :: Lens' Experiment (Maybe (NonEmpty MetricGoal))
- experiment_onlineAbDefinition :: Lens' Experiment (Maybe OnlineAbDefinition)
- experiment_project :: Lens' Experiment (Maybe Text)
- experiment_randomizationSalt :: Lens' Experiment (Maybe Text)
- experiment_samplingRate :: Lens' Experiment (Maybe Natural)
- experiment_schedule :: Lens' Experiment (Maybe ExperimentSchedule)
- experiment_segment :: Lens' Experiment (Maybe Text)
- experiment_statusReason :: Lens' Experiment (Maybe Text)
- experiment_tags :: Lens' Experiment (Maybe (HashMap Text Text))
- experiment_treatments :: Lens' Experiment (Maybe (NonEmpty Treatment))
- experiment_arn :: Lens' Experiment Text
- experiment_createdTime :: Lens' Experiment UTCTime
- experiment_lastUpdatedTime :: Lens' Experiment UTCTime
- experiment_name :: Lens' Experiment Text
- experiment_status :: Lens' Experiment ExperimentStatus
- experiment_type :: Lens' Experiment ExperimentType
Documentation
data Experiment Source #
A structure containing the configuration details of an experiment.
See: newExperiment
smart constructor.
Experiment' | |
|
Instances
:: Text | |
-> UTCTime | |
-> UTCTime | |
-> Text | |
-> ExperimentStatus | |
-> ExperimentType | |
-> Experiment |
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
.
experiment_description :: Lens' Experiment (Maybe Text) Source #
A description of the experiment.
experiment_execution :: Lens' Experiment (Maybe ExperimentExecution) Source #
A structure that contains the date and time that the experiment started and ended.
experiment_metricGoals :: Lens' Experiment (Maybe (NonEmpty MetricGoal)) Source #
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.
experiment_onlineAbDefinition :: Lens' Experiment (Maybe OnlineAbDefinition) Source #
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.
experiment_project :: Lens' Experiment (Maybe Text) Source #
The name or ARN of the project that contains this experiment.
experiment_randomizationSalt :: Lens' Experiment (Maybe Text) Source #
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
.
experiment_samplingRate :: Lens' Experiment (Maybe Natural) Source #
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.
experiment_schedule :: Lens' Experiment (Maybe ExperimentSchedule) Source #
A structure that contains the time and date that Evidently completed the analysis of the experiment.
experiment_segment :: Lens' Experiment (Maybe Text) Source #
The audience segment being used for the experiment, if a segment is being used.
experiment_statusReason :: Lens' Experiment (Maybe Text) Source #
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.
experiment_tags :: Lens' Experiment (Maybe (HashMap Text Text)) Source #
The list of tag keys and values associated with this experiment.
experiment_treatments :: Lens' Experiment (Maybe (NonEmpty Treatment)) Source #
An array of structures that describe the configuration of each feature variation used in the experiment.
experiment_arn :: Lens' Experiment Text Source #
The ARN of the experiment.
experiment_createdTime :: Lens' Experiment UTCTime Source #
The date and time that the experiment is first created.
experiment_lastUpdatedTime :: Lens' Experiment UTCTime Source #
The date and time that the experiment was most recently updated.
experiment_name :: Lens' Experiment Text Source #
The name of the experiment.
experiment_status :: Lens' Experiment ExperimentStatus Source #
The current state of the experiment.
experiment_type :: Lens' Experiment ExperimentType Source #
The type of this experiment. Currently, this value must be
aws.experiment.onlineab
.