pub struct GetExperimentResults { /* private fields */ }
Expand description
Fluent builder constructing a request to GetExperimentResults
.
Retrieves the results of a running or completed experiment.
Implementations
sourceimpl GetExperimentResults
impl GetExperimentResults
sourcepub async fn send(
self
) -> Result<GetExperimentResultsOutput, SdkError<GetExperimentResultsError>>
pub async fn send(
self
) -> Result<GetExperimentResultsOutput, SdkError<GetExperimentResultsError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn project(self, input: impl Into<String>) -> Self
pub fn project(self, input: impl Into<String>) -> Self
The name or ARN of the project that contains the experiment that you want to see the results of.
sourcepub fn set_project(self, input: Option<String>) -> Self
pub fn set_project(self, input: Option<String>) -> Self
The name or ARN of the project that contains the experiment that you want to see the results of.
sourcepub fn experiment(self, input: impl Into<String>) -> Self
pub fn experiment(self, input: impl Into<String>) -> Self
The name of the experiment to retrieve the results of.
sourcepub fn set_experiment(self, input: Option<String>) -> Self
pub fn set_experiment(self, input: Option<String>) -> Self
The name of the experiment to retrieve the results of.
sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
The date and time that the experiment started.
sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
The date and time that the experiment started.
sourcepub fn end_time(self, input: DateTime) -> Self
pub fn end_time(self, input: DateTime) -> Self
The date and time that the experiment ended, if it is completed.
sourcepub fn set_end_time(self, input: Option<DateTime>) -> Self
pub fn set_end_time(self, input: Option<DateTime>) -> Self
The date and time that the experiment ended, if it is completed.
sourcepub fn metric_names(self, input: impl Into<String>) -> Self
pub fn metric_names(self, input: impl Into<String>) -> Self
Appends an item to metricNames
.
To override the contents of this collection use set_metric_names
.
The names of the experiment metrics that you want to see the results of.
sourcepub fn set_metric_names(self, input: Option<Vec<String>>) -> Self
pub fn set_metric_names(self, input: Option<Vec<String>>) -> Self
The names of the experiment metrics that you want to see the results of.
sourcepub fn treatment_names(self, input: impl Into<String>) -> Self
pub fn treatment_names(self, input: impl Into<String>) -> Self
Appends an item to treatmentNames
.
To override the contents of this collection use set_treatment_names
.
The names of the experiment treatments that you want to see the results for.
sourcepub fn set_treatment_names(self, input: Option<Vec<String>>) -> Self
pub fn set_treatment_names(self, input: Option<Vec<String>>) -> Self
The names of the experiment treatments that you want to see the results for.
sourcepub fn base_stat(self, input: ExperimentBaseStat) -> Self
pub fn base_stat(self, input: ExperimentBaseStat) -> Self
The statistic used to calculate experiment results. Currently the only valid value is mean
, which uses the mean of the collected values as the statistic.
sourcepub fn set_base_stat(self, input: Option<ExperimentBaseStat>) -> Self
pub fn set_base_stat(self, input: Option<ExperimentBaseStat>) -> Self
The statistic used to calculate experiment results. Currently the only valid value is mean
, which uses the mean of the collected values as the statistic.
sourcepub fn result_stats(self, input: ExperimentResultRequestType) -> Self
pub fn result_stats(self, input: ExperimentResultRequestType) -> Self
Appends an item to resultStats
.
To override the contents of this collection use set_result_stats
.
The statistics that you want to see in the returned results.
-
PValue
specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05. -
ConfidenceInterval
specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between thebaseStat
of a variation and the baseline. Evidently returns the 95% confidence interval. -
TreatmentEffect
is the difference in the statistic specified by thebaseStat
parameter between each variation and the default variation. -
BaseStat
returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in thebaseStat
parameter. Therefore, ifbaseStat
ismean
, this returns the mean of the values collected for each variation.
sourcepub fn set_result_stats(
self,
input: Option<Vec<ExperimentResultRequestType>>
) -> Self
pub fn set_result_stats(
self,
input: Option<Vec<ExperimentResultRequestType>>
) -> Self
The statistics that you want to see in the returned results.
-
PValue
specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05. -
ConfidenceInterval
specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between thebaseStat
of a variation and the baseline. Evidently returns the 95% confidence interval. -
TreatmentEffect
is the difference in the statistic specified by thebaseStat
parameter between each variation and the default variation. -
BaseStat
returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in thebaseStat
parameter. Therefore, ifbaseStat
ismean
, this returns the mean of the values collected for each variation.
sourcepub fn report_names(self, input: ExperimentReportName) -> Self
pub fn report_names(self, input: ExperimentReportName) -> Self
Appends an item to reportNames
.
To override the contents of this collection use set_report_names
.
The names of the report types that you want to see. Currently, BayesianInference
is the only valid value.
sourcepub fn set_report_names(self, input: Option<Vec<ExperimentReportName>>) -> Self
pub fn set_report_names(self, input: Option<Vec<ExperimentReportName>>) -> Self
The names of the report types that you want to see. Currently, BayesianInference
is the only valid value.
sourcepub fn period(self, input: i64) -> Self
pub fn period(self, input: i64) -> Self
In seconds, the amount of time to aggregate results together.
sourcepub fn set_period(self, input: Option<i64>) -> Self
pub fn set_period(self, input: Option<i64>) -> Self
In seconds, the amount of time to aggregate results together.
Trait Implementations
sourceimpl Clone for GetExperimentResults
impl Clone for GetExperimentResults
sourcefn clone(&self) -> GetExperimentResults
fn clone(&self) -> GetExperimentResults
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for GetExperimentResults
impl Send for GetExperimentResults
impl Sync for GetExperimentResults
impl Unpin for GetExperimentResults
impl !UnwindSafe for GetExperimentResults
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more