String logGroup
The name of the log group where the project stores evaluation events.
String logGroup
The name of the log group where the project stores evaluation events.
String description
An optional description of the experiment.
List<E> 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.
String name
A name for the new experiment.
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.
String project
The name or ARN of the project that you want to create the new experiment in.
String randomizationSalt
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.
Long samplingRate
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.
String segment
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.
Map<K,V> tags
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.
<p>You can associate as many as 50 tags with an experiment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
List<E> treatments
An array of structures that describe the configuration of each feature variation used in the experiment.
Experiment experiment
A structure containing the configuration details of the experiment that you created.
String defaultVariation
The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.
This variation must also be listed in the variations structure.
If you omit defaultVariation, the first variation listed in the variations structure is
used as the default variation.
String description
An optional description of the feature.
Map<K,V> entityOverrides
Specify users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.
String evaluationStrategy
Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or
experiments. Specify DEFAULT_VARIATION to serve the default variation to all users instead.
String name
The name for the new feature.
String project
The name or ARN of the project that is to contain the new feature.
Map<K,V> tags
Assigns one or more tags (key-value pairs) to the feature.
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.
<p>You can associate as many as 50 tags with a feature.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
List<E> variations
An array of structures that contain the configuration of the feature's different variations.
Feature feature
A structure that contains information about the new feature.
String description
An optional description for the launch.
List<E> groups
An array of structures that contains the feature and variations that are to be used for the launch.
List<E> metricMonitors
An array of structures that define the metrics that will be used to monitor the launch performance.
String name
The name for the new launch.
String project
The name or ARN of the project that you want to create the launch in.
String randomizationSalt
When Evidently assigns a particular user session to a launch, 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 launch name as the
randomizationSalt.
ScheduledSplitsLaunchConfig scheduledSplitsConfig
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
Map<K,V> tags
Assigns one or more tags (key-value pairs) to the launch.
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.
<p>You can associate as many as 50 tags with a launch.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
Launch launch
A structure that contains the configuration of the launch that was created.
ProjectAppConfigResourceConfig appConfigResource
Use this parameter if the project will use client-side evaluation powered by AppConfig. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation. This mitigates the latency and availability risks that come with an API call. For more information, see Client-side evaluation - powered by AppConfig.
This parameter is a structure that contains information about the AppConfig application and environment that will be used as for client-side evaluation.
To create a project that uses client-side evaluation, you must have the
evidently:ExportProjectAsConfiguration permission.
ProjectDataDeliveryConfig dataDelivery
A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so. If you choose not to store these events, Evidently deletes them after using them to produce metrics and other experiment results that you can view.
String description
An optional description of the project.
String name
The name for the project.
Map<K,V> tags
Assigns one or more tags (key-value pairs) to the project.
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.
<p>You can associate as many as 50 tags with a project.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
Project project
A structure that contains information about the created project.
String description
An optional description for this segment.
String name
A name for the segment.
String pattern
The pattern to use for the segment. For more information about pattern syntax, see Segment rule pattern syntax.
Map<K,V> tags
Assigns one or more tags (key-value pairs) to the segment.
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.
<p>You can associate as many as 50 tags with a segment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
Segment segment
A structure that contains the complete information about the segment that was just created.
String project
The name or ARN of the project to delete.
String segment
Specifies the segment to delete.
String entityId
An internal ID that represents a unique user of the application. This entityID is checked against
any override rules assigned for this feature.
String evaluationContext
A JSON object of attributes that you can optionally pass in as part of the evaluation event sent to Evidently from the user session. Evidently can use this value to match user sessions with defined audience segments. For more information, see Use segments to focus your audience.
<p>If you include this parameter, the value must be a JSON object. A JSON array is not supported.</p>
String feature
The name of the feature being evaluated.
String project
The name or ARN of the project that contains this feature.
String details
If this user was assigned to a launch or experiment, this field lists the launch or experiment name.
String reason
Specifies the reason that the user session was assigned this variation. Possible values include
DEFAULT, meaning the user was served the default variation; LAUNCH_RULE_MATCH, if the
user session was enrolled in a launch; EXPERIMENT_RULE_MATCH, if the user session was enrolled in an
experiment; or ENTITY_OVERRIDES_MATCH, if the user's entityId matches an override rule.
VariableValue value
The value assigned to this variation to differentiate it from the other variations of this feature.
String variation
The name of the variation that was served to the user session.
String entityId
An internal ID that represents a unique user session of the application. This entityID is checked
against any override rules assigned for this feature.
String evaluationContext
A JSON block of attributes that you can optionally pass in. This JSON block is included in the evaluation events sent to Evidently from the user session.
String feature
The name of the feature being evaluated.
String details
If this user was assigned to a launch or experiment, this field lists the launch or experiment name.
String entityId
An internal ID that represents a unique user session of the application.
String feature
The name of the feature being evaluated.
String project
The name or ARN of the project that contains the feature being evaluated.
String reason
Specifies the reason that the user session was assigned this variation. Possible values include
DEFAULT, meaning the user was served the default variation; LAUNCH_RULE_MATCH, if the
user session was enrolled in a launch; or EXPERIMENT_RULE_MATCH, if the user session was enrolled in
an experiment.
VariableValue value
The value assigned to this variation to differentiate it from the other variations of this feature.
String variation
The name of the variation that was served to the user session.
String data
The event data.
Date timestamp
The timestamp of the event.
String type
aws.evidently.evaluation specifies an evaluation event, which determines which feature variation
that a user sees. aws.evidently.custom specifies a custom event, which generates metrics from user
actions such as clicks and checkouts.
String arn
The ARN of the experiment.
Date createdTime
The date and time that the experiment is first created.
String description
A description of the experiment.
ExperimentExecution execution
A structure that contains the date and time that the experiment started and ended.
Date lastUpdatedTime
The date and time that the experiment was most recently updated.
List<E> 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.
String name
The name of the experiment.
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.
String project
The name or ARN of the project that contains this experiment.
String 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.
Long 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.
ExperimentSchedule schedule
A structure that contains the time and date that Evidently completed the analysis of the experiment.
String segment
The audience segment being used for the experiment, if a segment is being used.
String status
The current state of the experiment.
String 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.
Map<K,V> tags
The list of tag keys and values associated with this experiment.
List<E> treatments
An array of structures that describe the configuration of each feature variation used in the experiment.
String type
The type of this experiment. Currently, this value must be aws.experiment.onlineab.
String content
The content of the report.
String metricName
The name of the metric that is analyzed in this experiment report.
String reportName
The type of analysis used for this report.
String treatmentName
The name of the variation that this report pertains to.
String metricName
The name of the metric.
String resultStat
The experiment statistic that these results pertain to.
String treatmentName
The treatment, or variation, that returned the values in this structure.
List<E> values
The values for the metricName that were recorded in the experiment.
Date analysisCompleteTime
The time and date that Evidently completed the analysis of the experiment.
String arn
The ARN of the feature.
Date createdTime
The date and time that the feature is created.
String defaultVariation
The name of the variation that is used as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.
This variation must also be listed in the variations structure.
If you omit defaultVariation, the first variation listed in the variations structure is
used as the default variation.
String description
The description of the feature.
Map<K,V> entityOverrides
A set of key-value pairs that specify users who should always be served a specific variation of a feature. Each key specifies a user using their user ID, account ID, or some other identifier. The value specifies the name of the variation that the user is to be served.
For the override to be successful, the value of the key must match the entityId used in the EvaluateFeature operation.
List<E> evaluationRules
An array of structures that define the evaluation rules for the feature.
String evaluationStrategy
If this value is ALL_RULES, the traffic allocation specified by any ongoing launches or experiments
is being used. If this is DEFAULT_VARIATION, the default variation is being served to all users.
Date lastUpdatedTime
The date and time that the feature was most recently updated.
String name
The name of the feature.
String project
The name or ARN of the project that contains the feature.
String status
The current state of the feature.
Map<K,V> tags
The list of tag keys and values associated with this feature.
String valueType
Defines the type of value used to define the different feature variations. For more information, see Variation types
List<E> variations
An array of structures that contain the configuration of the feature's different variations.
String arn
The ARN of the feature.
Date createdTime
The date and time that the feature is created.
String defaultVariation
The name of the variation that is used as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.
List<E> evaluationRules
An array of structures that define
String evaluationStrategy
If this value is ALL_RULES, the traffic allocation specified by any ongoing launches or experiments
is being used. If this is DEFAULT_VARIATION, the default variation is being served to all users.
Date lastUpdatedTime
The date and time that the feature was most recently updated.
String name
The name of the feature.
String project
The name or ARN of the project that contains the feature.
String status
The current state of the feature.
Map<K,V> tags
The list of tag keys and values associated with this feature.
Experiment experiment
A structure containing the configuration details of the experiment.
String baseStat
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.
Date endTime
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.
String experiment
The name of the experiment to retrieve the results of.
List<E> metricNames
The names of the experiment metrics that you want to see the results of.
Long period
In seconds, the amount of time to aggregate results together.
String project
The name or ARN of the project that contains the experiment that you want to see the results of.
List<E> reportNames
The names of the report types that you want to see. Currently, BayesianInference is the only valid
value.
List<E> resultStats
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.
Date startTime
The date and time that the experiment started.
List<E> treatmentNames
The names of the experiment treatments that you want to see the results for.
String details
If the experiment doesn't yet have enough events to provide valid results, this field is returned with the
message Not enough events to generate results. If there are enough events to provide valid results,
this field is not returned.
List<E> reports
An array of structures that include the reports that you requested.
List<E> resultsData
An array of structures that include experiment results including metric names and values.
List<E> timestamps
The timestamps of each result returned.
Feature feature
A structure containing the configuration details of the feature.
Launch launch
A structure containing the configuration details of the launch.
String project
The name or ARN of the project that you want to see the details of.
Project project
A structure containing the configuration details of the project.
String segment
The ARN of the segment to return information for.
Segment segment
A structure that contains the complete information about the segment.
String arn
The ARN of the launch.
Date createdTime
The date and time that the launch is created.
String description
The description of the launch.
LaunchExecution execution
A structure that contains information about the start and end times of the launch.
List<E> groups
An array of structures that define the feature variations that are being used in the launch.
Date lastUpdatedTime
The date and time that the launch was most recently updated.
List<E> metricMonitors
An array of structures that define the metrics that are being used to monitor the launch performance.
String name
The name of the launch.
String project
The name or ARN of the project that contains the launch.
String randomizationSalt
This value is used when Evidently assigns a particular user session to the launch, to help 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.
ScheduledSplitsLaunchDefinition scheduledSplitsDefinition
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
String status
The current state of the launch.
String statusReason
If the launch was stopped, this is the string that was entered by the person who stopped the launch, to explain why it was stopped.
Map<K,V> tags
The list of tag keys and values associated with this launch.
String type
The type of launch.
Integer maxResults
The maximum number of results to include in the response.
String nextToken
The token to use when requesting the next set of results. You received this token from a previous
ListExperiments operation.
String project
The name or ARN of the project to return the experiment list from.
String status
Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.
Integer maxResults
The maximum number of results to include in the response.
String nextToken
The token to use when requesting the next set of results. You received this token from a previous
ListFeatures operation.
String project
The name or ARN of the project to return the feature list from.
Integer maxResults
The maximum number of results to include in the response.
String nextToken
The token to use when requesting the next set of results. You received this token from a previous
ListLaunches operation.
String project
The name or ARN of the project to return the launch list from.
String status
Use this optional parameter to limit the returned results to only the launches with the status that you specify here.
Integer maxResults
The maximum number of results to include in the response. If you omit this, the default of 50 is used.
String nextToken
The token to use when requesting the next set of results. You received this token from a previous
ListSegmentReferences operation.
String segment
The ARN of the segment that you want to view information for.
String type
Specifies whether to return information about launches or experiments that use this segment.
String resourceArn
The ARN of the resource that you want to see the tags of.
String entityIdKey
The entity, such as a user or session, that does an action that causes a metric value to be recorded.
String eventPattern
The EventBridge event pattern that defines how the metric is recorded.
For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
String name
The name of the metric.
String unitLabel
The label for the units that the metric is measuring.
String valueKey
The value that is tracked to produce the metric.
String 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.
String eventPattern
The EventBridge event pattern that defines how the metric is recorded.
For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
String name
A name for the metric.
String unitLabel
A label for the units that the metric is measuring.
String valueKey
The value that is tracked to produce the metric.
String 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.
MetricDefinition metricDefinition
A structure that contains details about the metric.
String 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.
MetricDefinitionConfig metricDefinition
A structure that contains details about the metric.
MetricDefinition metricDefinition
A structure that defines the metric.
MetricDefinitionConfig metricDefinition
A structure that defines the metric.
String controlTreatmentName
The name of the variation that is to be the default variation that the other variations are compared to.
Map<K,V> 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.
String controlTreatmentName
The name of the variation that is the default variation that the other variations are compared to.
Map<K,V> 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.
Long activeExperimentCount
The number of ongoing experiments currently in the project.
Long activeLaunchCount
The number of ongoing launches currently in the project.
ProjectAppConfigResource appConfigResource
This structure defines the configuration of how your application integrates with AppConfig to run client-side evaluation.
String arn
The name or ARN of the project.
Date createdTime
The date and time that the project is created.
ProjectDataDelivery dataDelivery
A structure that contains information about where Evidently is to store evaluation events for longer term storage.
String description
The user-entered description of the project.
Long 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.
Long featureCount
The number of features currently in the project.
Date lastUpdatedTime
The date and time that the project was most recently updated.
Long 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.
String name
The name of the project.
String status
The current state of the project.
Map<K,V> tags
The list of tag keys and values associated with this project.
String applicationId
The ID of the AppConfig application to use for client-side evaluation.
String configurationProfileId
The ID of the AppConfig profile to use for client-side evaluation.
String environmentId
The ID of the AppConfig environment to use for client-side evaluation. This must be an environment that is within
the application that you specify for applicationId.
String applicationId
The ID of the AppConfig application to use for client-side evaluation.
String environmentId
The ID of the AppConfig environment to use for client-side evaluation. This must be an environment that is within
the application that you specify for applicationId.
CloudWatchLogsDestination cloudWatchLogs
If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.
S3Destination s3Destination
If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
CloudWatchLogsDestinationConfig cloudWatchLogs
If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.
S3DestinationConfig s3Destination
If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
Long activeExperimentCount
The number of experiments currently in the project.
Long activeLaunchCount
The number of ongoing launches currently in the project.
String arn
The name or ARN of the project.
Date createdTime
The date and time that the project is created.
String description
The description of the project.
Long experimentCount
The number of experiments currently in the project.
Long featureCount
The number of features currently in the project.
Date lastUpdatedTime
The date and time that the project was most recently updated.
Long launchCount
The number of launches currently in the project, including launches that are ongoing, completed, and not started yet.
String name
The name of the project.
String status
The current state of the project.
Map<K,V> tags
The list of tag keys and values associated with this project.
String errorCode
If the PutProjectEvents operation has an error, the error code is returned here.
String errorMessage
If the PutProjectEvents operation has an error, the error message is returned here.
String eventId
A unique ID assigned to this PutProjectEvents operation.
String arn
The ARN of the experiment or launch.
String endTime
The day and time that this experiment or launch ended.
String lastUpdatedOn
The day and time that this experiment or launch was most recently updated.
String name
The name of the experiment or launch.
String startTime
The day and time that this experiment or launch started.
String status
The status of the experiment or launch.
String type
Specifies whether the resource that this structure contains information about is an experiment or a launch.
Map<K,V> 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.
The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.
If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.
List<E> segmentOverrides
Use this parameter to specify different traffic splits for one or more audience segments. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.
This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.
Date startTime
The date and time that this step of the launch starts.
Map<K,V> 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.
<p>The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.</p> <p>If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.</p>
List<E> segmentOverrides
Use this parameter to specify different traffic splits for one or more audience segments. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.
This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.
Date startTime
The date and time that this step of the launch starts.
String arn
The ARN of the segment.
Date createdTime
The date and time that this segment was created.
String description
The customer-created description for this segment.
Long experimentCount
The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.
Date lastUpdatedTime
The date and time that this segment was most recently updated.
Long launchCount
The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.
String name
The name of the segment.
String pattern
The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see Segment rule pattern syntax.
Map<K,V> tags
The list of tag keys and values associated with this launch.
Long evaluationOrder
A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.
String segment
The ARN of the segment to use.
Map<K,V> weights
The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.
String quotaCode
The ID of the service quota that was exceeded.
String resourceId
The ID of the resource that caused the exception.
String resourceType
The type of the resource that is associated with the error.
String serviceCode
The ID of the service that is associated with the error.
Date analysisCompleteTime
The date and time to end the experiment. This must be no more than 30 days after the experiment starts.
String experiment
The name of the experiment to start.
String project
The name or ARN of the project that contains the experiment to start.
Date startedTime
A timestamp that indicates when the experiment started.
Launch launch
A structure that contains information about the launch that was started.
String desiredState
Specify whether the experiment is to be considered COMPLETED or CANCELLED after it
stops.
String experiment
The name of the experiment to stop.
String project
The name or ARN of the project that contains the experiment to stop.
String reason
A string that describes why you are stopping the experiment.
Date endedTime
The date and time that the experiment stopped.
String desiredState
Specify whether to consider the launch as COMPLETED or CANCELLED after it stops.
String launch
The name of the launch to stop.
String project
The name or ARN of the project that contains the launch that you want to stop.
String reason
A string that describes why you are stopping the launch.
Date endedTime
The date and time that the launch stopped.
Boolean match
Returns true if the pattern matches the payload.
String description
An optional description of the experiment.
String experiment
The name of the experiment to update.
List<E> 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.
OnlineAbConfig onlineAbConfig
A structure that contains the configuration of which variation o 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.
String project
The name or ARN of the project that contains the experiment that you want to update.
String randomizationSalt
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.
Boolean removeSegment
Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.
Long samplingRate
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 20,000 to allocate 20% of the available audience.
String segment
Adds an audience segment to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.
List<E> treatments
An array of structures that define the variations being tested in the experiment.
Experiment experiment
A structure containing the configuration details of the experiment that was updated.
List<E> addOrUpdateVariations
To update variation configurations for this feature, or add new ones, specify this structure. In this array, include any variations that you want to add or update. If the array includes a variation name that already exists for this feature, it is updated. If it includes a new variation name, it is added as a new variation.
String defaultVariation
The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.
String description
An optional description of the feature.
Map<K,V> entityOverrides
Specified users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.
String evaluationStrategy
Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or
experiments. Specify DEFAULT_VARIATION to serve the default variation to all users instead.
String feature
The name of the feature to be updated.
String project
The name or ARN of the project that contains the feature to be updated.
List<E> removeVariations
Removes a variation from the feature. If the variation you specify doesn't exist, then this makes no change and does not report an error.
This operation fails if you try to remove a variation that is part of an ongoing launch or experiment.
Feature feature
A structure that contains information about the updated feature.
String description
An optional description for the launch.
List<E> groups
An array of structures that contains the feature and variations that are to be used for the launch.
String launch
The name of the launch that is to be updated.
List<E> metricMonitors
An array of structures that define the metrics that will be used to monitor the launch performance.
String project
The name or ARN of the project that contains the launch that you want to update.
String randomizationSalt
When Evidently assigns a particular user session to a launch, 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 launch name as the
randomizationSalt.
ScheduledSplitsLaunchConfig scheduledSplitsConfig
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
Launch launch
A structure that contains the new configuration of the launch that was updated.
CloudWatchLogsDestinationConfig cloudWatchLogs
A structure containing the CloudWatch Logs log group where you want to store evaluation events.
String project
The name or ARN of the project that you want to modify the data storage options for.
S3DestinationConfig s3Destination
A structure containing the S3 bucket name and bucket prefix where you want to store evaluation events.
Project project
A structure containing details about the project that you updated.
ProjectAppConfigResourceConfig appConfigResource
Use this parameter if the project will use client-side evaluation powered by AppConfig. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation. This mitigates the latency and availability risks that come with an API call. allows you to
This parameter is a structure that contains information about the AppConfig application that will be used for client-side evaluation.
String description
An optional description of the project.
String project
The name or ARN of the project to update.
Project project
A structure containing information about the updated project.
Boolean boolValue
If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.
Double doubleValue
If this feature uses the double integer variation type, this field contains the double integer value of this variation.
Long longValue
If this feature uses the long variation type, this field contains the long value of this variation.
String stringValue
If this feature uses the string variation type, this field contains the string value of this variation.
String name
The name of the variation.
VariableValue value
The value assigned to this variation.
String name
The name of the variation.
VariableValue value
The value assigned to this variation.
Copyright © 2022. All rights reserved.