Struct aws_sdk_evidently::operation::update_experiment::UpdateExperimentInput

#[non_exhaustive]
pub struct UpdateExperimentInput {
    pub project: Option<String>,
    pub experiment: Option<String>,
    pub description: Option<String>,
    pub treatments: Option<Vec<TreatmentConfig>>,
    pub metric_goals: Option<Vec<MetricGoalConfig>>,
    pub randomization_salt: Option<String>,
    pub sampling_rate: Option<i64>,
    pub segment: Option<String>,
    pub remove_segment: Option<bool>,
    pub online_ab_config: Option<OnlineAbConfig>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

project: Option<String>

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

experiment: Option<String>

The name of the experiment to update.

description: Option<String>

An optional description of the experiment.

treatments: Option<Vec<TreatmentConfig>>

An array of structures that define the variations being tested in the experiment.

metric_goals: 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.

randomization_salt: 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.

sampling_rate: 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 20,000 to allocate 20% of the available audience.

segment: Option<String>

Adds an audience segment to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.

remove_segment: Option<bool>

Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.

online_ab_config: Option<OnlineAbConfig>

A structure that contains the configuration of which variation o 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.

Implementations

impl UpdateExperimentInput

pub fn project(&self) -> Option<&str>

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

pub fn experiment(&self) -> Option<&str>

The name of the experiment to update.

pub fn description(&self) -> Option<&str>

An optional description of the experiment.

pub fn treatments(&self) -> &[TreatmentConfig]

An array of structures that define the variations being tested 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().

pub fn metric_goals(&self) -> &[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.

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().

pub fn randomization_salt(&self) -> Option<&str>

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.

pub fn 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 20,000 to allocate 20% of the available audience.

pub fn segment(&self) -> Option<&str>

Adds an audience segment to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.

pub fn remove_segment(&self) -> Option<bool>

Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.

pub fn online_ab_config(&self) -> Option<&OnlineAbConfig>

A structure that contains the configuration of which variation o 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.

impl UpdateExperimentInput

pub fn builder() -> UpdateExperimentInputBuilder

Creates a new builder-style object to manufacture UpdateExperimentInput.

Trait Implementations

impl Clone for UpdateExperimentInput

fn clone(&self) -> UpdateExperimentInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateExperimentInput

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

Formats the value using the given formatter.

impl PartialEq for UpdateExperimentInput

fn eq(&self, other: &UpdateExperimentInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateExperimentInput