MetricDefinitionConfig
This structure defines a metric that you want to use to evaluate the variations during a launch or experiment.
Contents
entityIdKey
The entity, such as a user or session, that does an action that causes a metric value to be recorded.
An example is userDetails.userID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: .*
Required: Yes eventPattern
The EventBridge event pattern that defines how the metric is recorded.
For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No name
A name for the metric.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[\S]+$
Required: Yes unitLabel
A label for the units that the metric is measuring.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: .*
Required: No valueKey
The value that is tracked to produce the metric.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
See Also
Pattern: .*
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
MetricGoal
MetricGoal
A structure that tells Evidently whether higher or lower values are desired for a metric that is used in an experiment.
Contents
desiredChange
INCREASE means that a variation with a higher number for this metric is performing better.
DECREASE means that a variation with a lower number for this metric is performing better.
Type: String
Valid Values: INCREASE | DECREASE Required: No
metricDefinition
A structure that contains details about the metric.
Type: MetricDefinition (p. 136) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
MetricGoalConfig
MetricGoalConfig
Use this structure to tell Evidently whether higher or lower values are desired for a metric that is used in an experiment.
Contents
desiredChange
INCREASE means that a variation with a higher number for this metric is performing better.
DECREASE means that a variation with a lower number for this metric is performing better.
Type: String
Valid Values: INCREASE | DECREASE Required: No
metricDefinition
A structure that contains details about the metric.
Type: MetricDefinitionConfig (p. 138) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
MetricMonitor
MetricMonitor
A structure that defines a metric to be used to monitor performance of the variations during a launch.
Contents
metricDefinition
A structure that defines the metric.
Type: MetricDefinition (p. 136) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
MetricMonitorConfig
MetricMonitorConfig
A structure that defines a metric to be used to monitor performance of the variations during a launch.
Contents
metricDefinition
A structure that defines the metric.
Type: MetricDefinitionConfig (p. 138) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
OnlineAbConfig
OnlineAbConfig
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.
Contents
controlTreatmentName
The name of the variation that is to be the default variation that the other variations are compared to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern: ^[-a-zA-Z0-9._]*$
Required: No treatmentWeights
A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.
Type: String to long map
Key Length Constraints: Minimum length of 1. Maximum length of 127.
Key Pattern: ^[-a-zA-Z0-9._]*$
Valid Range: Minimum value of 0. Maximum value of 100000.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
OnlineAbDefinition
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.
Contents
controlTreatmentName
The name of the variation that is the default variation that the other variations are compared to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern: ^[-a-zA-Z0-9._]*$
Required: No treatmentWeights
A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. The traffic portion is specified in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.
Type: String to long map
Key Length Constraints: Minimum length of 1. Maximum length of 127.
Key Pattern: ^[-a-zA-Z0-9._]*$
Valid Range: Minimum value of 0. Maximum value of 100000.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Project
Project
This structure defines a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together.
Contents
activeExperimentCount
The number of ongoing experiments currently in the project.
Type: Long Required: No activeLaunchCount
The number of ongoing launches currently in the project.
Type: Long Required: No arn
The name or ARN of the project.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*
Required: Yes createdTime
The date and time that the project is created.
Type: Timestamp Required: Yes dataDelivery
A structure that contains information about where Evidently is to store evaluation events for longer term storage.
Type: ProjectDataDelivery (p. 149) object Required: No
description
The user-entered description of the project.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 160.
Pattern: .*
Required: No
Contents
experimentCount
The number of experiments currently in the project. This includes all experiments that have been created and not deleted, whether they are ongoing or not.
Type: Long Required: No featureCount
The number of features currently in the project.
Type: Long Required: No lastUpdatedTime
The date and time that the project was most recently updated.
Type: Timestamp Required: Yes launchCount
The number of launches currently in the project. This includes all launches that have been created and not deleted, whether they are ongoing or not.
Type: Long Required: No name
The name of the project.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern: ^[-a-zA-Z0-9._]*$
Required: Yes status
The current state of the project.
Type: String
Valid Values: AVAILABLE | UPDATING Required: Yes
tags
The list of tag keys and values associated with this project.
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.
See Also
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ProjectDataDelivery
ProjectDataDelivery
A structure that contains information about where Evidently is to store evaluation events for longer term storage.
Contents
cloudWatchLogs
If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.
Type: CloudWatchLogsDestination (p. 108) object Required: No
s3Destination
If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
Type: S3Destination (p. 155) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ProjectDataDeliveryConfig
ProjectDataDeliveryConfig
A structure that contains information about where Evidently is to store evaluation events for longer term storage.
Contents
cloudWatchLogs
If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.
Type: CloudWatchLogsDestinationConfig (p. 109) object Required: No
s3Destination
If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
Type: S3DestinationConfig (p. 156) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ProjectSummary
ProjectSummary
A structure that contains configuration information about an Evidently project.
Contents
activeExperimentCount
The number of experiments currently in the project.
Type: Long Required: No activeLaunchCount
The number of ongoing launches currently in the project.
Type: Long Required: No arn
The name or ARN of the project.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*
Required: Yes createdTime
The date and time that the project is created.
Type: Timestamp Required: Yes description
The description of the project.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 160.
Pattern: .*
Required: No experimentCount
The number of experiments currently in the project.
Type: Long Required: No featureCount
The number of features currently in the project.
See Also
Type: Long Required: No lastUpdatedTime
The date and time that the project was most recently updated.
Type: Timestamp Required: Yes launchCount
The number of launches currently in the project, including launches that are ongoing, completed, and not started yet.
Type: Long Required: No name
The name of the project.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern: ^[-a-zA-Z0-9._]*$
Required: Yes status
The current state of the project.
Type: String
Valid Values: AVAILABLE | UPDATING Required: Yes
tags
The list of tag keys and values associated with this project.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
See Also
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PutProjectEventsResultEntry
PutProjectEventsResultEntry
A structure that contains Evidently's response to the sent events, including an event ID and error codes, if any.
Contents
errorCode
If the PutProjectEvents operation has an error, the error code is returned here.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No errorMessage
If the PutProjectEvents operation has an error, the error message is returned here.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: .*
Required: No eventId
A unique ID assigned to this PutProjectEvents operation.
Type: String
Length Constraints: Fixed length of 36.
Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
S3Destination
S3Destination
If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
Contents
bucket
The name of the bucket in which Evidently stores evaluation events.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern: ^[a-z0-9][-a-z0-9]*[a-z0-9]$
Required: No prefix
The bucket prefix in which Evidently stores evaluation events.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: ^[-a-zA-Z0-9!_.*'()/]*$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
S3DestinationConfig
S3DestinationConfig
If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
Contents
bucket
The name of the bucket in which Evidently stores evaluation events.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern: ^[a-z0-9][-a-z0-9]*[a-z0-9]$
Required: No prefix
The bucket prefix in which Evidently stores evaluation events.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: ^[-a-zA-Z0-9!_.*'()/]*$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ScheduledSplit
ScheduledSplit
This structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.
Contents
groupWeights
The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.
Type: String to long map
Map Entries: Minimum number of 0 items. Maximum number of 5 items.
Key Length Constraints: Minimum length of 1. Maximum length of 127.
Key Pattern: ^[-a-zA-Z0-9._]*$
Valid Range: Minimum value of 0. Maximum value of 100000.
Required: No startTime
The date and time that this step of the launch starts.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ScheduledSplitConfig
ScheduledSplitConfig
This structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.
Contents
groupWeights
The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.
Type: String to long map
Map Entries: Minimum number of 0 items. Maximum number of 5 items.
Key Length Constraints: Minimum length of 1. Maximum length of 127.
Key Pattern: ^[-a-zA-Z0-9._]*$
Valid Range: Minimum value of 0. Maximum value of 100000.
Required: Yes startTime
The date and time that this step of the launch starts.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ScheduledSplitsLaunchConfig
ScheduledSplitsLaunchConfig
An array of structures that define the traffic allocation percentages among the feature variations during each step of a launch. This also defines the start time of each step.
Contents
steps
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.
Type: Array of ScheduledSplitConfig (p. 158) objects
Array Members: Minimum number of 1 item. Maximum number of 6 items.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3