pub struct GetExperimentResultsFluentBuilder { /* private fields */ }
Expand description

Fluent builder constructing a request to GetExperimentResults.

Retrieves the results of a running or completed experiment. No results are available until there have been 100 events for each variation and at least 10 minutes have passed since the start of the experiment. To increase the statistical power, Evidently performs an additional offline p-value analysis at the end of the experiment. Offline p-value analysis can detect statistical significance in some cases where the anytime p-values used during the experiment do not find statistical significance.

Experiment results are available up to 63 days after the start of the experiment. They are not available after that because of CloudWatch data retention policies.

Implementations§

source§

impl GetExperimentResultsFluentBuilder

source

pub fn as_input(&self) -> &GetExperimentResultsInputBuilder

Access the GetExperimentResults as a reference.

source

pub async fn send( self ) -> Result<GetExperimentResultsOutput, SdkError<GetExperimentResultsError, HttpResponse>>

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.

source

pub fn customize( self ) -> CustomizableOperation<GetExperimentResultsOutput, GetExperimentResultsError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

source

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.

source

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.

source

pub fn get_project(&self) -> &Option<String>

The name or ARN of the project that contains the experiment that you want to see the results of.

source

pub fn experiment(self, input: impl Into<String>) -> Self

The name of the experiment to retrieve the results of.

source

pub fn set_experiment(self, input: Option<String>) -> Self

The name of the experiment to retrieve the results of.

source

pub fn get_experiment(&self) -> &Option<String>

The name of the experiment to retrieve the results of.

source

pub fn start_time(self, input: DateTime) -> Self

The date and time that the experiment started.

source

pub fn set_start_time(self, input: Option<DateTime>) -> Self

The date and time that the experiment started.

source

pub fn get_start_time(&self) -> &Option<DateTime>

The date and time that the experiment started.

source

pub fn end_time(self, input: DateTime) -> Self

The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.

source

pub fn set_end_time(self, input: Option<DateTime>) -> Self

The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.

source

pub fn get_end_time(&self) -> &Option<DateTime>

The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.

source

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.

source

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.

source

pub fn get_metric_names(&self) -> &Option<Vec<String>>

The names of the experiment metrics that you want to see the results of.

source

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.

source

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.

source

pub fn get_treatment_names(&self) -> &Option<Vec<String>>

The names of the experiment treatments that you want to see the results for.

source

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.

source

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.

source

pub fn get_base_stat(&self) -> &Option<ExperimentBaseStat>

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.

source

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 the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

  • TreatmentEffect is the difference in the statistic specified by the baseStat 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 the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

source

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 the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

  • TreatmentEffect is the difference in the statistic specified by the baseStat 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 the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

source

pub fn get_result_stats(&self) -> &Option<Vec<ExperimentResultRequestType>>

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 the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

  • TreatmentEffect is the difference in the statistic specified by the baseStat 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 the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

source

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.

source

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.

source

pub fn get_report_names(&self) -> &Option<Vec<ExperimentReportName>>

The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

source

pub fn period(self, input: i64) -> Self

In seconds, the amount of time to aggregate results together.

source

pub fn set_period(self, input: Option<i64>) -> Self

In seconds, the amount of time to aggregate results together.

source

pub fn get_period(&self) -> &Option<i64>

In seconds, the amount of time to aggregate results together.

Trait Implementations§

source§

impl Clone for GetExperimentResultsFluentBuilder

source§

fn clone(&self) -> GetExperimentResultsFluentBuilder

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for GetExperimentResultsFluentBuilder

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more