Struct aws_sdk_evidently::operation::create_experiment::builders::CreateExperimentFluentBuilder
source · pub struct CreateExperimentFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateExperiment
.
Creates an Evidently experiment. Before you create an experiment, you must create the feature to use for the experiment.
An experiment helps you make feature design decisions based on evidence and data. An experiment can test as many as five variations at once. Evidently collects experiment data and analyzes it by statistical methods, and provides clear recommendations about which variations perform better.
You can optionally specify a segment
to have the experiment consider only certain audience types in the experiment, such as using only user sessions from a certain location or who use a certain internet browser.
Don't use this operation to update an existing experiment. Instead, use UpdateExperiment.
Implementations§
source§impl CreateExperimentFluentBuilder
impl CreateExperimentFluentBuilder
sourcepub fn as_input(&self) -> &CreateExperimentInputBuilder
pub fn as_input(&self) -> &CreateExperimentInputBuilder
Access the CreateExperiment as a reference.
sourcepub async fn send(
self
) -> Result<CreateExperimentOutput, SdkError<CreateExperimentError, HttpResponse>>
pub async fn send( self ) -> Result<CreateExperimentOutput, SdkError<CreateExperimentError, 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.
sourcepub fn customize(
self
) -> CustomizableOperation<CreateExperimentOutput, CreateExperimentError, Self>
pub fn customize( self ) -> CustomizableOperation<CreateExperimentOutput, CreateExperimentError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
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 you want to create the new experiment in.
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 you want to create the new experiment in.
sourcepub fn get_project(&self) -> &Option<String>
pub fn get_project(&self) -> &Option<String>
The name or ARN of the project that you want to create the new experiment in.
sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
An optional description of the experiment.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
An optional description of the experiment.
sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
An optional description of the experiment.
sourcepub fn treatments(self, input: TreatmentConfig) -> Self
pub fn treatments(self, input: TreatmentConfig) -> Self
Appends an item to treatments
.
To override the contents of this collection use set_treatments
.
An array of structures that describe the configuration of each feature variation used in the experiment.
sourcepub fn set_treatments(self, input: Option<Vec<TreatmentConfig>>) -> Self
pub fn set_treatments(self, input: Option<Vec<TreatmentConfig>>) -> Self
An array of structures that describe the configuration of each feature variation used in the experiment.
sourcepub fn get_treatments(&self) -> &Option<Vec<TreatmentConfig>>
pub fn get_treatments(&self) -> &Option<Vec<TreatmentConfig>>
An array of structures that describe the configuration of each feature variation used in the experiment.
sourcepub fn metric_goals(self, input: MetricGoalConfig) -> Self
pub fn metric_goals(self, input: MetricGoalConfig) -> Self
Appends an item to metricGoals
.
To override the contents of this collection use set_metric_goals
.
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.
sourcepub fn set_metric_goals(self, input: Option<Vec<MetricGoalConfig>>) -> Self
pub fn set_metric_goals(self, input: Option<Vec<MetricGoalConfig>>) -> Self
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.
sourcepub fn get_metric_goals(&self) -> &Option<Vec<MetricGoalConfig>>
pub fn get_metric_goals(&self) -> &Option<Vec<MetricGoalConfig>>
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.
sourcepub fn randomization_salt(self, input: impl Into<String>) -> Self
pub fn randomization_salt(self, input: impl Into<String>) -> Self
When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt
. If you omit randomizationSalt
, Evidently uses the experiment name as the randomizationSalt
.
sourcepub fn set_randomization_salt(self, input: Option<String>) -> Self
pub fn set_randomization_salt(self, input: Option<String>) -> Self
When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt
. If you omit randomizationSalt
, Evidently uses the experiment name as the randomizationSalt
.
sourcepub fn get_randomization_salt(&self) -> &Option<String>
pub fn get_randomization_salt(&self) -> &Option<String>
When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt
. If you omit randomizationSalt
, Evidently uses the experiment name as the randomizationSalt
.
sourcepub fn sampling_rate(self, input: i64) -> Self
pub fn sampling_rate(self, input: i64) -> Self
The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. 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. For example, specify 10,000 to allocate 10% of the available audience.
sourcepub fn set_sampling_rate(self, input: Option<i64>) -> Self
pub fn set_sampling_rate(self, input: Option<i64>) -> Self
The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. 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. For example, specify 10,000 to allocate 10% of the available audience.
sourcepub fn get_sampling_rate(&self) -> &Option<i64>
pub fn get_sampling_rate(&self) -> &Option<i64>
The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. 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. For example, specify 10,000 to allocate 10% of the available audience.
sourcepub fn online_ab_config(self, input: OnlineAbConfig) -> Self
pub fn online_ab_config(self, input: OnlineAbConfig) -> Self
A structure that contains the configuration of which variation to use as the "control" version. tThe "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
sourcepub fn set_online_ab_config(self, input: Option<OnlineAbConfig>) -> Self
pub fn set_online_ab_config(self, input: Option<OnlineAbConfig>) -> Self
A structure that contains the configuration of which variation to use as the "control" version. tThe "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
sourcepub fn get_online_ab_config(&self) -> &Option<OnlineAbConfig>
pub fn get_online_ab_config(&self) -> &Option<OnlineAbConfig>
A structure that contains the configuration of which variation to use as the "control" version. tThe "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
sourcepub fn segment(self, input: impl Into<String>) -> Self
pub fn segment(self, input: impl Into<String>) -> Self
Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.
sourcepub fn set_segment(self, input: Option<String>) -> Self
pub fn set_segment(self, input: Option<String>) -> Self
Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.
sourcepub fn get_segment(&self) -> &Option<String>
pub fn get_segment(&self) -> &Option<String>
Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
Assigns one or more tags (key-value pairs) to the experiment.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with an experiment.
For more information, see Tagging Amazon Web Services resources.
Assigns one or more tags (key-value pairs) to the experiment.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with an experiment.
For more information, see Tagging Amazon Web Services resources.
Assigns one or more tags (key-value pairs) to the experiment.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with an experiment.
For more information, see Tagging Amazon Web Services resources.
Trait Implementations§
source§impl Clone for CreateExperimentFluentBuilder
impl Clone for CreateExperimentFluentBuilder
source§fn clone(&self) -> CreateExperimentFluentBuilder
fn clone(&self) -> CreateExperimentFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateExperimentFluentBuilder
impl !RefUnwindSafe for CreateExperimentFluentBuilder
impl Send for CreateExperimentFluentBuilder
impl Sync for CreateExperimentFluentBuilder
impl Unpin for CreateExperimentFluentBuilder
impl !UnwindSafe for CreateExperimentFluentBuilder
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