AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon CloudWatch Evidently GetExperimentResults API operation.

Syntax

Get-CWEVDExperimentResult
-BaseStat <ExperimentBaseStat>
-EndTime <DateTime>
-Experiment <String>
-MetricName <String[]>
-Period <Int64>
-Project <String>
-ReportName <String[]>
-ResultStat <String[]>
-StartTime <DateTime>
-TreatmentName <String[]>
-Select <String>
-ClientConfig <AmazonCloudWatchEvidentlyConfig>

Description

Retrieves the results of a running or completed experiment. No results are available until there have been 100 events for each variation and at least 10 minutes have passed since the start of the experiment. To increase the statistical power, Evidently performs an additional offline p-value analysis at the end of the experiment. Offline p-value analysis can detect statistical significance in some cases where the anytime p-values used during the experiment do not find statistical significance. Experiment results are available up to 63 days after the start of the experiment. They are not available after that because of CloudWatch data retention policies.

Parameters

-BaseStat <ExperimentBaseStat>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonCloudWatchEvidentlyConfig>
Amazon.PowerShell.Cmdlets.CWEVD.AmazonCloudWatchEvidentlyClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndTime <DateTime>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Experiment <String>
The name of the experiment to retrieve the results of.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-MetricName <String[]>
The names of the experiment metrics that you want to see the results of.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricNames
-Period <Int64>
In seconds, the amount of time to aggregate results together.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Project <String>
The name or ARN of the project that contains the experiment that you want to see the results of.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReportName <String[]>
The names of the report types that you want to see. Currently, BayesianInference is the only valid value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReportNames
-ResultStat <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResultStats
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatchEvidently.Model.GetExperimentResultsResponse). Specifying the name of a property of type Amazon.CloudWatchEvidently.Model.GetExperimentResultsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartTime <DateTime>
The date and time that the experiment started.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TreatmentName <String[]>
The names of the experiment treatments that you want to see the results for.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTreatmentNames

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.CloudWatchEvidently.Model.GetExperimentResultsResponse
This cmdlet returns an Amazon.CloudWatchEvidently.Model.GetExperimentResultsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z