Class: Aws::CloudWatchEvidently::Types::Experiment

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudwatchevidently/types.rb

Overview

A structure containing the configuration details of an experiment.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The ARN of the experiment.

Returns:

  • (String) 


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#created_time ⇒ Time

The date and time that the experiment is first created.

Returns:

  • (Time) 


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the experiment.

Returns:

  • (String) 


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#execution ⇒ Types::ExperimentExecution

A structure that contains the date and time that the experiment started and ended.

Returns:



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_time ⇒ Time

The date and time that the experiment was most recently updated.

Returns:

  • (Time) 


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#metric_goals ⇒ Array<Types::MetricGoal>

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:



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the experiment.

Returns:

  • (String) 


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#online_ab_definition ⇒ Types::OnlineAbDefinition

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



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#project ⇒ String

The name or ARN of the project that contains this experiment.

Returns:

  • (String) 


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#randomization_salt ⇒ String

This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and ‘randomizationSalt`.

Returns:

  • (String) 


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#sampling_rate ⇒ Integer

In thousandths of a percent, the amount of the available audience that is allocated to this experiment. 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, so a value of 10,000 is 10% of the available audience.

Returns:

  • (Integer) 


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#schedule ⇒ Types::ExperimentSchedule

A structure that contains the time and date that Evidently completed the analysis of the experiment.

Returns:



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#segment ⇒ String

The audience segment being used for the experiment, if a segment is being used.

Returns:

  • (String) 


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current state of the experiment.

Returns:

  • (String) 


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.

Returns:

  • (String) 


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The list of tag keys and values associated with this experiment.

Returns:

  • (Hash<String,String>) 


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#treatments ⇒ Array<Types::Treatment>

An array of structures that describe the configuration of each feature variation used in the experiment.

Returns:



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of this experiment. Currently, this value must be ‘aws.experiment.onlineab`.

Returns:

  • (String) 


945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 945

class Experiment < Struct.new(
  :arn,
  :created_time,
  :description,
  :execution,
  :last_updated_time,
  :metric_goals,
  :name,
  :online_ab_definition,
  :project,
  :randomization_salt,
  :sampling_rate,
  :schedule,
  :segment,
  :status,
  :status_reason,
  :tags,
  :treatments,
  :type)
  SENSITIVE = []
  include Aws::Structure
end