Class: Aws::CloudWatchEvidently::Types::UpdateExperimentRequest

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchEvidently::Types::UpdateExperimentRequest

Defined in:

gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  An optional description of the experiment.

• #experiment ⇒ String

  The name of the experiment to update.

• #metric_goals ⇒ Array<Types::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.

• #online_ab_config ⇒ Types::OnlineAbConfig

  A structure that contains the configuration of which variation o use as the "control" version.

• #project ⇒ String

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

• #randomization_salt ⇒ 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.

• #remove_segment ⇒ Boolean

  Removes a segment from being used in an experiment.

• #sampling_rate ⇒ Integer

  The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.

• #segment ⇒ String

  Adds an audience segment to an experiment.

• #treatments ⇒ Array<Types::TreatmentConfig>

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

Instance Attribute Details

#description ⇒ String

An optional description of the experiment.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 3265

class UpdateExperimentRequest < Struct.new(
  :description,
  :experiment,
  :metric_goals,
  :online_ab_config,
  :project,
  :randomization_salt,
  :remove_segment,
  :sampling_rate,
  :segment,
  :treatments)
  SENSITIVE = []
  include Aws::Structure
end

#experiment ⇒ String

The name of the experiment to update.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 3265

class UpdateExperimentRequest < Struct.new(
  :description,
  :experiment,
  :metric_goals,
  :online_ab_config,
  :project,
  :randomization_salt,
  :remove_segment,
  :sampling_rate,
  :segment,
  :treatments)
  SENSITIVE = []
  include Aws::Structure
end

#metric_goals ⇒ Array<Types::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.

Returns:

• (Array<Types::MetricGoalConfig>)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 3265

class UpdateExperimentRequest < Struct.new(
  :description,
  :experiment,
  :metric_goals,
  :online_ab_config,
  :project,
  :randomization_salt,
  :remove_segment,
  :sampling_rate,
  :segment,
  :treatments)
  SENSITIVE = []
  include Aws::Structure
end

#online_ab_config ⇒ Types::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.

Returns:

• (Types::OnlineAbConfig)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 3265

class UpdateExperimentRequest < Struct.new(
  :description,
  :experiment,
  :metric_goals,
  :online_ab_config,
  :project,
  :randomization_salt,
  :remove_segment,
  :sampling_rate,
  :segment,
  :treatments)
  SENSITIVE = []
  include Aws::Structure
end

#project ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 3265

class UpdateExperimentRequest < Struct.new(
  :description,
  :experiment,
  :metric_goals,
  :online_ab_config,
  :project,
  :randomization_salt,
  :remove_segment,
  :sampling_rate,
  :segment,
  :treatments)
  SENSITIVE = []
  include Aws::Structure
end

#randomization_salt ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 3265

class UpdateExperimentRequest < Struct.new(
  :description,
  :experiment,
  :metric_goals,
  :online_ab_config,
  :project,
  :randomization_salt,
  :remove_segment,
  :sampling_rate,
  :segment,
  :treatments)
  SENSITIVE = []
  include Aws::Structure
end

#remove_segment ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 3265

class UpdateExperimentRequest < Struct.new(
  :description,
  :experiment,
  :metric_goals,
  :online_ab_config,
  :project,
  :randomization_salt,
  :remove_segment,
  :sampling_rate,
  :segment,
  :treatments)
  SENSITIVE = []
  include Aws::Structure
end

#sampling_rate ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 3265

class UpdateExperimentRequest < Struct.new(
  :description,
  :experiment,
  :metric_goals,
  :online_ab_config,
  :project,
  :randomization_salt,
  :remove_segment,
  :sampling_rate,
  :segment,
  :treatments)
  SENSITIVE = []
  include Aws::Structure
end

#segment ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 3265

class UpdateExperimentRequest < Struct.new(
  :description,
  :experiment,
  :metric_goals,
  :online_ab_config,
  :project,
  :randomization_salt,
  :remove_segment,
  :sampling_rate,
  :segment,
  :treatments)
  SENSITIVE = []
  include Aws::Structure
end

#treatments ⇒ Array<Types::TreatmentConfig>

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

Returns:

• (Array<Types::TreatmentConfig>)

# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 3265

class UpdateExperimentRequest < Struct.new(
  :description,
  :experiment,
  :metric_goals,
  :online_ab_config,
  :project,
  :randomization_salt,
  :remove_segment,
  :sampling_rate,
  :segment,
  :treatments)
  SENSITIVE = []
  include Aws::Structure
end