class Aws::CloudWatchEvidently::Types::UpdateExperimentRequest

@note When making an API call, you may pass UpdateExperimentRequest

data as a hash:

    {
      description: "Description",
      experiment: "ExperimentName", # required
      metric_goals: [
        {
          desired_change: "INCREASE", # accepts INCREASE, DECREASE
          metric_definition: { # required
            entity_id_key: "JsonPath", # required
            event_pattern: "MetricDefinitionConfigEventPatternString",
            name: "CwDimensionSafeName", # required
            unit_label: "MetricUnitLabel",
            value_key: "JsonPath", # required
          },
        },
      ],
      online_ab_config: {
        control_treatment_name: "TreatmentName",
        treatment_weights: {
          "TreatmentName" => 1,
        },
      },
      project: "ProjectRef", # required
      randomization_salt: "RandomizationSalt",
      sampling_rate: 1,
      treatments: [
        {
          description: "Description",
          feature: "FeatureName", # required
          name: "TreatmentName", # required
          variation: "VariationName", # required
        },
      ],
    }

@!attribute [rw] description

An optional description of the experiment.
@return [String]

@!attribute [rw] experiment

The name of the experiment to update.
@return [String]

@!attribute [rw] 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.
@return [Array<Types::MetricGoalConfig>]

@!attribute [rw] online_ab_config

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.
@return [Types::OnlineAbConfig]

@!attribute [rw] project

The name or ARN of the project that contains the experiment that you
want to update.
@return [String]

@!attribute [rw] randomization_salt

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`.
@return [String]

@!attribute [rw] sampling_rate

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.
@return [Integer]

@!attribute [rw] treatments

An array of structures that define the variations being tested in
the experiment.
@return [Array<Types::TreatmentConfig>]

@see docs.aws.amazon.com/goto/WebAPI/evidently-2021-02-01/UpdateExperimentRequest AWS API Documentation

Constants

SENSITIVE