• Public
  • Public/Protected
  • All

Interface CreateExperimentRequest




Optional description

description: undefined | string

An optional description of the experiment.


metricGoals: MetricGoalConfig[] | undefined

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.


name: string | undefined

A name for the new experiment.

Optional onlineAbConfig

onlineAbConfig: OnlineAbConfig

A structure that contains the configuration of which variation to use as the "control" version. tThe "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.


project: string | undefined

The name or ARN of the project that you want to create the new experiment in.

Optional randomizationSalt

randomizationSalt: undefined | string

When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the experiment name as the randomizationSalt.

Optional samplingRate

samplingRate: undefined | number

The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. 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. For example, specify 10,000 to allocate 10% of the available audience.

Optional segment

segment: undefined | string

Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.

Optional tags

tags: Record<string, string>

Assigns one or more tags (key-value pairs) to the experiment.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with an experiment.

For more information, see Tagging Amazon Web Services resources.


treatments: TreatmentConfig[] | undefined

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