latest--aws-evidently-experiment

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-evidently-experiment.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::Evidently::Experiment.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-evidently

Properties

Name string | Aws_CF_FunctionString required
Project string | Aws_CF_FunctionString required
Treatments TreatmentObject[] required
minItems=2maxItems=5uniqueItems=true
MetricGoals MetricGoalObject[] required
minItems=1maxItems=3uniqueItems=true
OnlineAbConfig object required
2 nested properties
ControlTreatmentName string | Aws_CF_FunctionString
TreatmentWeights TreatmentToWeight[]
uniqueItems=true
Description string | Aws_CF_FunctionString
RunningStatus object
One of: variant, variant
4 nested properties
Status string | Aws_CF_FunctionString

Provide START or STOP action to apply on an experiment

AnalysisCompleteTime string | Aws_CF_FunctionString

Provide the analysis Completion time for an experiment

Reason string | Aws_CF_FunctionString

Reason is a required input for stopping the experiment

DesiredState string | Aws_CF_FunctionString

Provide CANCELLED or COMPLETED desired state when stopping an experiment

RandomizationSalt string | Aws_CF_FunctionString
SamplingRate integer
min=0max=100000
Segment string | Aws_CF_FunctionString
RemoveSegment boolean
Tags Tag[]

An array of key-value pairs to apply to this resource.

uniqueItems=true

Definitions

RunningStatusObject object
Status string | Aws_CF_FunctionString

Provide START or STOP action to apply on an experiment

AnalysisCompleteTime string | Aws_CF_FunctionString

Provide the analysis Completion time for an experiment

Reason string | Aws_CF_FunctionString

Reason is a required input for stopping the experiment

DesiredState string | Aws_CF_FunctionString

Provide CANCELLED or COMPLETED desired state when stopping an experiment

TreatmentObject object
TreatmentName string | Aws_CF_FunctionString required
Feature string | Aws_CF_FunctionString required
Variation string | Aws_CF_FunctionString required
Description string | Aws_CF_FunctionString
MetricGoalObject object
MetricName string | Aws_CF_FunctionString required
EntityIdKey string | Aws_CF_FunctionString required

The JSON path to reference the entity id in the event.

ValueKey string | Aws_CF_FunctionString required

The JSON path to reference the numerical metric value in the event.

DesiredChange string | Aws_CF_FunctionString required
EventPattern string | Aws_CF_FunctionString

Event patterns have the same structure as the events they match. Rules use event patterns to select events. An event pattern either matches an event or it doesn't.

UnitLabel string | Aws_CF_FunctionString
OnlineAbConfigObject object
ControlTreatmentName string | Aws_CF_FunctionString
TreatmentWeights TreatmentToWeight[]
uniqueItems=true
TreatmentToWeight object
Treatment string | Aws_CF_FunctionString required
SplitWeight integer required
min=0max=100000
Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string | Aws_CF_FunctionString required

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.