Experiment - CloudWatch Evidently

Experiment

A structure containing the configuration details of an experiment.

Contents

arn

The ARN of the experiment.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*/experiment/[-a-zA-Z0-9._]*

Required: Yes

createdTime

The date and time that the experiment is first created.

Type: Timestamp

Required: Yes

description

A description of the experiment.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 160.

Pattern: .*

Required: No

execution

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

Type: ExperimentExecution object

Required: No

lastUpdatedTime

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

Type: Timestamp

Required: Yes

metricGoals

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.

Type: Array of MetricGoal objects

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Required: No

name

The name of the experiment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 127.

Pattern: ^[-a-zA-Z0-9._]*$

Required: Yes

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.

Type: OnlineAbDefinition object

Required: No

project

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*

Required: No

randomizationSalt

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 127.

Pattern: .*

Required: No

samplingRate

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.

Type: Long

Valid Range: Minimum value of 0. Maximum value of 100000.

Required: No

schedule

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

Type: ExperimentSchedule object

Required: No

segment

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:segment/[-a-zA-Z0-9._]*

Required: No

status

The current state of the experiment.

Type: String

Valid Values: CREATED | UPDATING | RUNNING | COMPLETED | CANCELLED

Required: Yes

statusReason

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 160.

Pattern: .*

Required: No

tags

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

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

treatments

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

Type: Array of Treatment objects

Array Members: Minimum number of 2 items. Maximum number of 5 items.

Required: No

type

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

Type: String

Valid Values: aws.evidently.onlineab

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: