[ aws . evidently ]

get-experiment-results

Description

Retrieves the results of a running or completed experiment.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-experiment-results
[--base-stat <value>]
[--end-time <value>]
--experiment <value>
--metric-names <value>
[--period <value>]
--project <value>
[--report-names <value>]
[--result-stats <value>]
[--start-time <value>]
--treatment-names <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

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

Possible values:

• Mean

--end-time (timestamp)

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 (list)

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

(string)

Syntax:

"string" "string" ...

--period (long)

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 (list)

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

(string)

Syntax:

"string" "string" ...

Where valid values are:
  BayesianInference

--result-stats (list)

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.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  BaseStat
  TreatmentEffect
  ConfidenceInterval
  PValue

--start-time (timestamp)

The date and time that the experiment started.

--treatment-names (list)

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

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

reports -> (list)

An array of structures that include the reports that you requested.

(structure)

A structure that contains results of an experiment.

content -> (string)

The content of the report.

metricName -> (string)

The name of the metric that is analyzed in this experiment report.

reportName -> (string)

The type of analysis used for this report.

treatmentName -> (string)

The name of the variation that this report pertains to.

resultsData -> (list)

An array of structures that include experiment results including metric names and values.

(structure)

A structure that contains experiment results for one metric that is monitored in the experiment.

metricName -> (string)

The name of the metric.

resultStat -> (string)

The experiment statistic that these results pertain to.

treatmentName -> (string)

The treatment, or variation, that returned the values in this structure.

values -> (list)

The values for the metricName that were recorded in the experiment.

(double)

timestamps -> (list)

The timestamps of each result returned.

(timestamp)