Evidently

This page documents function available when using the Evidently module, created with @service Evidently.

Index

Documentation

Main.Evidently.batch_evaluate_featureMethod
batch_evaluate_feature(project, requests)
batch_evaluate_feature(project, requests, params::Dict{String,<:Any})

This operation assigns feature variation to user sessions. For each user session, you pass in an entityID that represents the user. Evidently then checks the evaluation rules and assigns the variation. The first rules that are evaluated are the override rules. If the user's entityID matches an override rule, the user is served the variation specified by that rule. Next, if there is a launch of the feature, the user might be assigned to a variation in the launch. The chance of this depends on the percentage of users that are allocated to that launch. If the user is enrolled in the launch, the variation they are served depends on the allocation of the various feature variations used for the launch. If the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might be assigned to a variation in the experiment. The chance of this depends on the percentage of users that are allocated to that experiment. If the user is enrolled in the experiment, the variation they are served depends on the allocation of the various feature variations used for the experiment. If the user is not assigned to a launch or experiment, they are served the default variation.

Arguments

  • project: The name or ARN of the project that contains the feature being evaluated.
  • requests: An array of structures, where each structure assigns a feature variation to one user session.
source
Main.Evidently.create_experimentMethod
create_experiment(metric_goals, name, project, treatments)
create_experiment(metric_goals, name, project, treatments, params::Dict{String,<:Any})

Creates an Evidently experiment. Before you create an experiment, you must create the feature to use for the experiment. An experiment helps you make feature design decisions based on evidence and data. An experiment can test as many as five variations at once. Evidently collects experiment data and analyzes it by statistical methods, and provides clear recommendations about which variations perform better. You can optionally specify a segment to have the experiment consider only certain audience types in the experiment, such as using only user sessions from a certain location or who use a certain internet browser. Don't use this operation to update an existing experiment. Instead, use UpdateExperiment.

Arguments

  • metric_goals: 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: A name for the new experiment.
  • project: The name or ARN of the project that you want to create the new experiment in.
  • treatments: An array of structures that describe the configuration of each feature variation used in the experiment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": An optional description of the experiment.
  • "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.
  • "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.
  • "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.
  • "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.
  • "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. You can associate as many as 50 tags with an experiment. For more information, see Tagging Amazon Web Services resources.
source
Main.Evidently.create_featureMethod
create_feature(name, project, variations)
create_feature(name, project, variations, params::Dict{String,<:Any})

Creates an Evidently feature that you want to launch or test. You can define up to five variations of a feature, and use these variations in your launches and experiments. A feature must be created in a project. For information about creating a project, see CreateProject. Don't use this operation to update an existing feature. Instead, use UpdateFeature.

Arguments

  • name: The name for the new feature.
  • project: The name or ARN of the project that is to contain the new feature.
  • variations: An array of structures that contain the configuration of the feature's different variations.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "description": An optional description of the feature.
  • "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. This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override.
  • "evaluationStrategy": Specify ALLRULES to activate the traffic allocation specified by any ongoing launches or experiments. Specify DEFAULTVARIATION to serve the default variation to all users instead.
  • "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. You can associate as many as 50 tags with a feature. For more information, see Tagging Amazon Web Services resources.
source
Main.Evidently.create_launchMethod
create_launch(groups, name, project)
create_launch(groups, name, project, params::Dict{String,<:Any})

Creates a launch of a given feature. Before you create a launch, you must create the feature to use for the launch. You can use a launch to safely validate new features by serving them to a specified percentage of your users while you roll out the feature. You can monitor the performance of the new feature to help you decide when to ramp up traffic to more users. This helps you reduce risk and identify unintended consequences before you fully launch the feature. Don't use this operation to update an existing launch. Instead, use UpdateLaunch.

Arguments

  • groups: An array of structures that contains the feature and variations that are to be used for the launch.
  • name: The name for the new launch.
  • project: The name or ARN of the project that you want to create the launch in.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": An optional description for the launch.
  • "metricMonitors": An array of structures that define the metrics that will be used to monitor the launch performance.
  • "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.
  • "scheduledSplitsConfig": An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
  • "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. You can associate as many as 50 tags with a launch. For more information, see Tagging Amazon Web Services resources.
source
Main.Evidently.create_projectMethod
create_project(name)
create_project(name, params::Dict{String,<:Any})

Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together. To update an existing project, use UpdateProject.

Arguments

  • name: The name for the project.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "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.
  • "description": An optional description of the project.
  • "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. You can associate as many as 50 tags with a project. For more information, see Tagging Amazon Web Services resources.
source
Main.Evidently.create_segmentMethod
create_segment(name, pattern)
create_segment(name, pattern, params::Dict{String,<:Any})

Use this operation to define a segment of your audience. 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. Using a segment in an experiment limits that experiment to evaluate only the users who match the segment criteria. Using one or more segments in a launch allows you to define different traffic splits for the different audience segments. For more information about segment pattern syntax, see Segment rule pattern syntax. The pattern that you define for a segment is matched against the value of evaluationContext, which is passed into Evidently in the EvaluateFeature operation, when Evidently assigns a feature variation to a user.

Arguments

  • name: A name for the segment.
  • pattern: The pattern to use for the segment. For more information about pattern syntax, see Segment rule pattern syntax.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": An optional description for this segment.
  • "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. You can associate as many as 50 tags with a segment. For more information, see Tagging Amazon Web Services resources.
source
Main.Evidently.delete_experimentMethod
delete_experiment(experiment, project)
delete_experiment(experiment, project, params::Dict{String,<:Any})

Deletes an Evidently experiment. The feature used for the experiment is not deleted. To stop an experiment without deleting it, use StopExperiment.

Arguments

  • experiment: The name of the experiment to delete.
  • project: The name or ARN of the project that contains the experiment to delete.
source
Main.Evidently.delete_featureMethod
delete_feature(feature, project)
delete_feature(feature, project, params::Dict{String,<:Any})

Deletes an Evidently feature.

Arguments

  • feature: The name of the feature to delete.
  • project: The name or ARN of the project that contains the feature to delete.
source
Main.Evidently.delete_launchMethod
delete_launch(launch, project)
delete_launch(launch, project, params::Dict{String,<:Any})

Deletes an Evidently launch. The feature used for the launch is not deleted. To stop a launch without deleting it, use StopLaunch.

Arguments

  • launch: The name of the launch to delete.
  • project: The name or ARN of the project that contains the launch to delete.
source
Main.Evidently.delete_projectMethod
delete_project(project)
delete_project(project, params::Dict{String,<:Any})

Deletes an Evidently project. Before you can delete a project, you must delete all the features that the project contains. To delete a feature, use DeleteFeature.

Arguments

  • project: The name or ARN of the project to delete.
source
Main.Evidently.delete_segmentMethod
delete_segment(segment)
delete_segment(segment, params::Dict{String,<:Any})

Deletes a segment. You can't delete a segment that is being used in a launch or experiment, even if that launch or experiment is not currently running.

Arguments

  • segment: Specifies the segment to delete.
source
Main.Evidently.evaluate_featureMethod
evaluate_feature(entity_id, feature, project)
evaluate_feature(entity_id, feature, project, params::Dict{String,<:Any})

This operation assigns a feature variation to one given user session. You pass in an entityID that represents the user. Evidently then checks the evaluation rules and assigns the variation. The first rules that are evaluated are the override rules. If the user's entityID matches an override rule, the user is served the variation specified by that rule. If there is a current launch with this feature that uses segment overrides, and if the user session's evaluationContext matches a segment rule defined in a segment override, the configuration in the segment overrides is used. For more information about segments, see CreateSegment and Use segments to focus your audience. If there is a launch with no segment overrides, the user might be assigned to a variation in the launch. The chance of this depends on the percentage of users that are allocated to that launch. If the user is enrolled in the launch, the variation they are served depends on the allocation of the various feature variations used for the launch. If the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might be assigned to a variation in the experiment. The chance of this depends on the percentage of users that are allocated to that experiment. If the experiment uses a segment, then only user sessions with evaluationContext values that match the segment rule are used in the experiment. If the user is enrolled in the experiment, the variation they are served depends on the allocation of the various feature variations used for the experiment. If the user is not assigned to a launch or experiment, they are served the default variation.

Arguments

  • entity_id: An internal ID that represents a unique user of the application. This entityID is checked against any override rules assigned for this feature.
  • feature: The name of the feature being evaluated.
  • project: The name or ARN of the project that contains this feature.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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. If you include this parameter, the value must be a JSON object. A JSON array is not supported.
source
Main.Evidently.get_experimentMethod
get_experiment(experiment, project)
get_experiment(experiment, project, params::Dict{String,<:Any})

Returns the details about one experiment. You must already know the experiment name. To retrieve a list of experiments in your account, use ListExperiments.

Arguments

  • experiment: The name of the experiment that you want to see the details of.
  • project: The name or ARN of the project that contains the experiment.
source
Main.Evidently.get_experiment_resultsMethod
get_experiment_results(experiment, metric_names, project, treatment_names)
get_experiment_results(experiment, metric_names, project, treatment_names, params::Dict{String,<:Any})

Retrieves the results of a running or completed experiment. No results are available until there have been 100 events for each variation and at least 10 minutes have passed since the start of the experiment. To increase the statistical power, Evidently performs an additional offline p-value analysis at the end of the experiment. Offline p-value analysis can detect statistical significance in some cases where the anytime p-values used during the experiment do not find statistical significance. Experiment results are available up to 63 days after the start of the experiment. They are not available after that because of CloudWatch data retention policies.

Arguments

  • experiment: The name of the experiment to retrieve the results of.
  • metric_names: The names of the experiment metrics that you want to see the results of.
  • project: The name or ARN of the project that contains the experiment that you want to see the results of.
  • treatment_names: The names of the experiment treatments that you want to see the results for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "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.
  • "period": In seconds, the amount of time to aggregate results together.
  • "reportNames": The names of the report types that you want to see. Currently, BayesianInference is the only valid value.
  • "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.
  • "startTime": The date and time that the experiment started.
source
Main.Evidently.get_featureMethod
get_feature(feature, project)
get_feature(feature, project, params::Dict{String,<:Any})

Returns the details about one feature. You must already know the feature name. To retrieve a list of features in your account, use ListFeatures.

Arguments

  • feature: The name of the feature that you want to retrieve information for.
  • project: The name or ARN of the project that contains the feature.
source
Main.Evidently.get_launchMethod
get_launch(launch, project)
get_launch(launch, project, params::Dict{String,<:Any})

Returns the details about one launch. You must already know the launch name. To retrieve a list of launches in your account, use ListLaunches.

Arguments

  • launch: The name of the launch that you want to see the details of.
  • project: The name or ARN of the project that contains the launch.
source
Main.Evidently.get_projectMethod
get_project(project)
get_project(project, params::Dict{String,<:Any})

Returns the details about one launch. You must already know the project name. To retrieve a list of projects in your account, use ListProjects.

Arguments

  • project: The name or ARN of the project that you want to see the details of.
source
Main.Evidently.get_segmentMethod
get_segment(segment)
get_segment(segment, params::Dict{String,<:Any})

Returns information about the specified segment. Specify the segment you want to view by specifying its ARN.

Arguments

  • segment: The ARN of the segment to return information for.
source
Main.Evidently.list_experimentsMethod
list_experiments(project)
list_experiments(project, params::Dict{String,<:Any})

Returns configuration details about all the experiments in the specified project.

Arguments

  • project: The name or ARN of the project to return the experiment list from.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to include in the response.
  • "nextToken": The token to use when requesting the next set of results. You received this token from a previous ListExperiments operation.
  • "status": Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.
source
Main.Evidently.list_featuresMethod
list_features(project)
list_features(project, params::Dict{String,<:Any})

Returns configuration details about all the features in the specified project.

Arguments

  • project: The name or ARN of the project to return the feature list from.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to include in the response.
  • "nextToken": The token to use when requesting the next set of results. You received this token from a previous ListFeatures operation.
source
Main.Evidently.list_launchesMethod
list_launches(project)
list_launches(project, params::Dict{String,<:Any})

Returns configuration details about all the launches in the specified project.

Arguments

  • project: The name or ARN of the project to return the launch list from.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to include in the response.
  • "nextToken": The token to use when requesting the next set of results. You received this token from a previous ListLaunches operation.
  • "status": Use this optional parameter to limit the returned results to only the launches with the status that you specify here.
source
Main.Evidently.list_projectsMethod
list_projects()
list_projects(params::Dict{String,<:Any})

Returns configuration details about all the projects in the current Region in your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to include in the response.
  • "nextToken": The token to use when requesting the next set of results. You received this token from a previous ListProjects operation.
source
Main.Evidently.list_segment_referencesMethod
list_segment_references(segment, type)
list_segment_references(segment, type, params::Dict{String,<:Any})

Use this operation to find which experiments or launches are using a specified segment.

Arguments

  • segment: The ARN of the segment that you want to view information for.
  • type: Specifies whether to return information about launches or experiments that use this segment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to include in the response. If you omit this, the default of 50 is used.
  • "nextToken": The token to use when requesting the next set of results. You received this token from a previous ListSegmentReferences operation.
source
Main.Evidently.list_segmentsMethod
list_segments()
list_segments(params::Dict{String,<:Any})

Returns a list of audience segments that you have created in your account in this Region.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to include in the response. If you omit this, the default of 50 is used.
  • "nextToken": The token to use when requesting the next set of results. You received this token from a previous ListSegments operation.
source
Main.Evidently.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Displays the tags associated with an Evidently resource.

Arguments

  • resource_arn: The ARN of the resource that you want to see the tags of.
source
Main.Evidently.put_project_eventsMethod
put_project_events(events, project)
put_project_events(events, project, params::Dict{String,<:Any})

Sends performance events to Evidently. These events can be used to evaluate a launch or an experiment.

Arguments

  • events: An array of event structures that contain the performance data that is being sent to Evidently.
  • project: The name or ARN of the project to write the events to.
source
Main.Evidently.start_experimentMethod
start_experiment(analysis_complete_time, experiment, project)
start_experiment(analysis_complete_time, experiment, project, params::Dict{String,<:Any})

Starts an existing experiment. To create an experiment, use CreateExperiment.

Arguments

  • analysis_complete_time: The date and time to end the experiment. This must be no more than 30 days after the experiment starts.
  • experiment: The name of the experiment to start.
  • project: The name or ARN of the project that contains the experiment to start.
source
Main.Evidently.start_launchMethod
start_launch(launch, project)
start_launch(launch, project, params::Dict{String,<:Any})

Starts an existing launch. To create a launch, use CreateLaunch.

Arguments

  • launch: The name of the launch to start.
  • project: The name or ARN of the project that contains the launch to start.
source
Main.Evidently.stop_experimentMethod
stop_experiment(experiment, project)
stop_experiment(experiment, project, params::Dict{String,<:Any})

Stops an experiment that is currently running. If you stop an experiment, you can't resume it or restart it.

Arguments

  • experiment: The name of the experiment to stop.
  • project: The name or ARN of the project that contains the experiment to stop.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "desiredState": Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.
  • "reason": A string that describes why you are stopping the experiment.
source
Main.Evidently.stop_launchMethod
stop_launch(launch, project)
stop_launch(launch, project, params::Dict{String,<:Any})

Stops a launch that is currently running. After you stop a launch, you will not be able to resume it or restart it. Also, it will not be evaluated as a rule for traffic allocation, and the traffic that was allocated to the launch will instead be available to the feature's experiment, if there is one. Otherwise, all traffic will be served the default variation after the launch is stopped.

Arguments

  • launch: The name of the launch to stop.
  • project: The name or ARN of the project that contains the launch that you want to stop.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "desiredState": Specify whether to consider the launch as COMPLETED or CANCELLED after it stops.
  • "reason": A string that describes why you are stopping the launch.
source
Main.Evidently.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource. Projects, features, launches, and experiments can be tagged. 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 use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. For more information, see Tagging Amazon Web Services resources.

Arguments

  • resource_arn: The ARN of the CloudWatch Evidently resource that you're adding tags to.
  • tags: The list of key-value pairs to associate with the resource.
source
Main.Evidently.test_segment_patternMethod
test_segment_pattern(pattern, payload)
test_segment_pattern(pattern, payload, params::Dict{String,<:Any})

Use this operation to test a rules pattern that you plan to use to create an audience segment. For more information about segments, see CreateSegment.

Arguments

  • pattern: The pattern to test.
  • payload: A sample evaluationContext JSON block to test against the specified pattern.
source
Main.Evidently.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes one or more tags from the specified resource.

Arguments

  • resource_arn: The ARN of the CloudWatch Evidently resource that you're removing tags from.
  • tag_keys: The list of tag keys to remove from the resource.
source
Main.Evidently.update_experimentMethod
update_experiment(experiment, project)
update_experiment(experiment, project, params::Dict{String,<:Any})

Updates an Evidently experiment. Don't use this operation to update an experiment's tag. Instead, use TagResource.

Arguments

  • experiment: The name of the experiment to update.
  • project: The name or ARN of the project that contains the experiment that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": An optional description of the experiment.
  • "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": 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.
  • "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.
  • "removeSegment": Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.
  • "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.
  • "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.
  • "treatments": An array of structures that define the variations being tested in the experiment.
source
Main.Evidently.update_featureMethod
update_feature(feature, project)
update_feature(feature, project, params::Dict{String,<:Any})

Updates an existing feature. You can't use this operation to update the tags of an existing feature. Instead, use TagResource.

Arguments

  • feature: The name of the feature to be updated.
  • project: The name or ARN of the project that contains the feature to be updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "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.
  • "description": An optional description of the feature.
  • "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. This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override.
  • "evaluationStrategy": Specify ALLRULES to activate the traffic allocation specified by any ongoing launches or experiments. Specify DEFAULTVARIATION to serve the default variation to all users instead.
  • "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.
source
Main.Evidently.update_launchMethod
update_launch(launch, project)
update_launch(launch, project, params::Dict{String,<:Any})

Updates a launch of a given feature. Don't use this operation to update the tags of an existing launch. Instead, use TagResource.

Arguments

  • launch: The name of the launch that is to be updated.
  • project: The name or ARN of the project that contains the launch that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": An optional description for the launch.
  • "groups": An array of structures that contains the feature and variations that are to be used for the launch.
  • "metricMonitors": An array of structures that define the metrics that will be used to monitor the launch performance.
  • "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.
  • "scheduledSplitsConfig": An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
source
Main.Evidently.update_projectMethod
update_project(project)
update_project(project, params::Dict{String,<:Any})

Updates the description of an existing project. To create a new project, use CreateProject. Don't use this operation to update the data storage options of a project. Instead, use UpdateProjectDataDelivery. Don't use this operation to update the tags of a project. Instead, use TagResource.

Arguments

  • project: The name or ARN of the project to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "description": An optional description of the project.
source
Main.Evidently.update_project_data_deliveryMethod
update_project_data_delivery(project)
update_project_data_delivery(project, params::Dict{String,<:Any})

Updates the data storage options for this project. If you store evaluation events, you an keep them and analyze them on your own. If you choose not to store evaluation events, Evidently deletes them after using them to produce metrics and other experiment results that you can view. You can't specify both cloudWatchLogs and s3Destination in the same operation.

Arguments

  • project: The name or ARN of the project that you want to modify the data storage options for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "cloudWatchLogs": A structure containing the CloudWatch Logs log group where you want to store evaluation events.
  • "s3Destination": A structure containing the S3 bucket name and bucket prefix where you want to store evaluation events.
source