Class: Aws::CloudWatchEvidently::Types::GetExperimentResultsRequest

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchEvidently::Types::GetExperimentResultsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cloudwatchevidently/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #base_stat ⇒ String

  The statistic used to calculate experiment results.

• #end_time ⇒ Time

  The date and time that the experiment ended, if it is completed.

• #experiment ⇒ String

  The name of the experiment to retrieve the results of.

• #metric_names ⇒ Array<String>

  The names of the experiment metrics that you want to see the results of.

• #period ⇒ Integer

  In seconds, the amount of time to aggregate results together.

• #project ⇒ String

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

• #report_names ⇒ Array<String>

  The names of the report types that you want to see.

• #result_stats ⇒ Array<String>

  The statistics that you want to see in the returned results.

• #start_time ⇒ Time

  The date and time that the experiment started.

• #treatment_names ⇒ Array<String>

  The names of the experiment treatments that you want to see the results for.

Instance Attribute Details

#base_stat ⇒ String

The statistic used to calculate experiment results. Currently the only valid value is ‘mean`, which uses the mean of the collected values as the statistic.

Returns:

• (String)

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

class GetExperimentResultsRequest < Struct.new(
  :base_stat,
  :end_time,
  :experiment,
  :metric_names,
  :period,
  :project,
  :report_names,
  :result_stats,
  :start_time,
  :treatment_names)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.

Returns:

• (Time)

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

class GetExperimentResultsRequest < Struct.new(
  :base_stat,
  :end_time,
  :experiment,
  :metric_names,
  :period,
  :project,
  :report_names,
  :result_stats,
  :start_time,
  :treatment_names)
  SENSITIVE = []
  include Aws::Structure
end

#experiment ⇒ String

The name of the experiment to retrieve the results of.

Returns:

• (String)

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

class GetExperimentResultsRequest < Struct.new(
  :base_stat,
  :end_time,
  :experiment,
  :metric_names,
  :period,
  :project,
  :report_names,
  :result_stats,
  :start_time,
  :treatment_names)
  SENSITIVE = []
  include Aws::Structure
end

#metric_names ⇒ Array<String>

The names of the experiment metrics that you want to see the results of.

Returns:

• (Array<String>)

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

class GetExperimentResultsRequest < Struct.new(
  :base_stat,
  :end_time,
  :experiment,
  :metric_names,
  :period,
  :project,
  :report_names,
  :result_stats,
  :start_time,
  :treatment_names)
  SENSITIVE = []
  include Aws::Structure
end

#period ⇒ Integer

In seconds, the amount of time to aggregate results together.

Returns:

• (Integer)

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

class GetExperimentResultsRequest < Struct.new(
  :base_stat,
  :end_time,
  :experiment,
  :metric_names,
  :period,
  :project,
  :report_names,
  :result_stats,
  :start_time,
  :treatment_names)
  SENSITIVE = []
  include Aws::Structure
end

#project ⇒ String

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

Returns:

• (String)

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

class GetExperimentResultsRequest < Struct.new(
  :base_stat,
  :end_time,
  :experiment,
  :metric_names,
  :period,
  :project,
  :report_names,
  :result_stats,
  :start_time,
  :treatment_names)
  SENSITIVE = []
  include Aws::Structure
end

#report_names ⇒ Array<String>

The names of the report types that you want to see. Currently, ‘BayesianInference` is the only valid value.

Returns:

• (Array<String>)

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

class GetExperimentResultsRequest < Struct.new(
  :base_stat,
  :end_time,
  :experiment,
  :metric_names,
  :period,
  :project,
  :report_names,
  :result_stats,
  :start_time,
  :treatment_names)
  SENSITIVE = []
  include Aws::Structure
end

#result_stats ⇒ Array<String>

The statistics that you want to see in the returned results.

• ‘PValue` specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

• ‘ConfidenceInterval` specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the `baseStat` of a variation and the baseline. Evidently returns the 95% confidence interval.

• ‘TreatmentEffect` is the difference in the statistic specified by the `baseStat` parameter between each variation and the default variation.

• ‘BaseStat` returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the `baseStat` parameter. Therefore, if `baseStat` is `mean`, this returns the mean of the values collected for each variation.

Returns:

• (Array<String>)

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

class GetExperimentResultsRequest < Struct.new(
  :base_stat,
  :end_time,
  :experiment,
  :metric_names,
  :period,
  :project,
  :report_names,
  :result_stats,
  :start_time,
  :treatment_names)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The date and time that the experiment started.

Returns:

• (Time)

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

class GetExperimentResultsRequest < Struct.new(
  :base_stat,
  :end_time,
  :experiment,
  :metric_names,
  :period,
  :project,
  :report_names,
  :result_stats,
  :start_time,
  :treatment_names)
  SENSITIVE = []
  include Aws::Structure
end

#treatment_names ⇒ Array<String>

The names of the experiment treatments that you want to see the results for.

Returns:

• (Array<String>)

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

class GetExperimentResultsRequest < Struct.new(
  :base_stat,
  :end_time,
  :experiment,
  :metric_names,
  :period,
  :project,
  :report_names,
  :result_stats,
  :start_time,
  :treatment_names)
  SENSITIVE = []
  include Aws::Structure
end