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

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

Overview

A structure containing the configuration details of an experiment.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN of the experiment.

Returns:

  • (String)


906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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_timeTime

The date and time that the experiment is first created.

Returns:

  • (Time)


906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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

#descriptionString

A description of the experiment.

Returns:

  • (String)


906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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

#executionTypes::ExperimentExecution

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



906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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_timeTime

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

Returns:

  • (Time)


906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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_goalsArray<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:



906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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

#nameString

The name of the experiment.

Returns:

  • (String)


906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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



906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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

#projectString

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

Returns:

  • (String)


906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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_saltString

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)


906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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_rateInteger

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)


906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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

#scheduleTypes::ExperimentSchedule

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



906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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

#segmentString

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

Returns:

  • (String)


906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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

#statusString

The current state of the experiment.

Returns:

  • (String)


906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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_reasonString

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)


906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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

#treatmentsArray<Types::Treatment>

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

Returns:



906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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

#typeString

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

Returns:

  • (String)


906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 906

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