Struct aws_sdk_evidently::types::Experiment
source · #[non_exhaustive]pub struct Experiment {Show 18 fields
pub arn: String,
pub name: String,
pub project: Option<String>,
pub status: ExperimentStatus,
pub status_reason: Option<String>,
pub description: Option<String>,
pub created_time: DateTime,
pub last_updated_time: DateTime,
pub schedule: Option<ExperimentSchedule>,
pub execution: Option<ExperimentExecution>,
pub treatments: Option<Vec<Treatment>>,
pub metric_goals: Option<Vec<MetricGoal>>,
pub randomization_salt: Option<String>,
pub sampling_rate: i64,
pub segment: Option<String>,
pub type: ExperimentType,
pub online_ab_definition: Option<OnlineAbDefinition>,
pub tags: Option<HashMap<String, String>>,
}
Expand description
A structure containing the configuration details of an experiment.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.arn: String
The ARN of the experiment.
name: String
The name of the experiment.
project: Option<String>
The name or ARN of the project that contains this experiment.
status: ExperimentStatus
The current state of the experiment.
status_reason: Option<String>
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.
description: Option<String>
A description of the experiment.
created_time: DateTime
The date and time that the experiment is first created.
last_updated_time: DateTime
The date and time that the experiment was most recently updated.
schedule: Option<ExperimentSchedule>
A structure that contains the time and date that Evidently completed the analysis of the experiment.
execution: Option<ExperimentExecution>
A structure that contains the date and time that the experiment started and ended.
treatments: Option<Vec<Treatment>>
An array of structures that describe the configuration of each feature variation used in the experiment.
metric_goals: Option<Vec<MetricGoal>>
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.
randomization_salt: Option<String>
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
.
sampling_rate: i64
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.
segment: Option<String>
The audience segment being used for the experiment, if a segment is being used.
type: ExperimentType
The type of this experiment. Currently, this value must be aws.experiment.onlineab
.
online_ab_definition: Option<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.
The list of tag keys and values associated with this experiment.
Implementations§
source§impl Experiment
impl Experiment
sourcepub fn project(&self) -> Option<&str>
pub fn project(&self) -> Option<&str>
The name or ARN of the project that contains this experiment.
sourcepub fn status(&self) -> &ExperimentStatus
pub fn status(&self) -> &ExperimentStatus
The current state of the experiment.
sourcepub fn status_reason(&self) -> Option<&str>
pub fn status_reason(&self) -> Option<&str>
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.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description of the experiment.
sourcepub fn created_time(&self) -> &DateTime
pub fn created_time(&self) -> &DateTime
The date and time that the experiment is first created.
sourcepub fn last_updated_time(&self) -> &DateTime
pub fn last_updated_time(&self) -> &DateTime
The date and time that the experiment was most recently updated.
sourcepub fn schedule(&self) -> Option<&ExperimentSchedule>
pub fn schedule(&self) -> Option<&ExperimentSchedule>
A structure that contains the time and date that Evidently completed the analysis of the experiment.
sourcepub fn execution(&self) -> Option<&ExperimentExecution>
pub fn execution(&self) -> Option<&ExperimentExecution>
A structure that contains the date and time that the experiment started and ended.
sourcepub fn treatments(&self) -> &[Treatment]
pub fn treatments(&self) -> &[Treatment]
An array of structures that describe the configuration of each feature variation used in the experiment.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .treatments.is_none()
.
sourcepub fn metric_goals(&self) -> &[MetricGoal]
pub fn metric_goals(&self) -> &[MetricGoal]
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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .metric_goals.is_none()
.
sourcepub fn randomization_salt(&self) -> Option<&str>
pub fn randomization_salt(&self) -> Option<&str>
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
.
sourcepub fn sampling_rate(&self) -> i64
pub fn sampling_rate(&self) -> i64
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.
sourcepub fn segment(&self) -> Option<&str>
pub fn segment(&self) -> Option<&str>
The audience segment being used for the experiment, if a segment is being used.
sourcepub fn type(&self) -> &ExperimentType
pub fn type(&self) -> &ExperimentType
The type of this experiment. Currently, this value must be aws.experiment.onlineab
.
sourcepub fn online_ab_definition(&self) -> Option<&OnlineAbDefinition>
pub fn online_ab_definition(&self) -> Option<&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.
The list of tag keys and values associated with this experiment.
source§impl Experiment
impl Experiment
sourcepub fn builder() -> ExperimentBuilder
pub fn builder() -> ExperimentBuilder
Creates a new builder-style object to manufacture Experiment
.
Trait Implementations§
source§impl Clone for Experiment
impl Clone for Experiment
source§fn clone(&self) -> Experiment
fn clone(&self) -> Experiment
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for Experiment
impl Debug for Experiment
source§impl PartialEq for Experiment
impl PartialEq for Experiment
source§fn eq(&self, other: &Experiment) -> bool
fn eq(&self, other: &Experiment) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for Experiment
Auto Trait Implementations§
impl Freeze for Experiment
impl RefUnwindSafe for Experiment
impl Send for Experiment
impl Sync for Experiment
impl Unpin for Experiment
impl UnwindSafe for Experiment
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more