aws-sdk
Version:
AWS SDK for JavaScript
570 lines • 111 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Evidently extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Evidently.Types.ClientConfiguration)
config: Config & Evidently.Types.ClientConfiguration;
/**
* 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.
*/
batchEvaluateFeature(params: Evidently.Types.BatchEvaluateFeatureRequest, callback?: (err: AWSError, data: Evidently.Types.BatchEvaluateFeatureResponse) => void): Request<Evidently.Types.BatchEvaluateFeatureResponse, AWSError>;
/**
* 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.
*/
batchEvaluateFeature(callback?: (err: AWSError, data: Evidently.Types.BatchEvaluateFeatureResponse) => void): Request<Evidently.Types.BatchEvaluateFeatureResponse, AWSError>;
/**
* 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.
*/
createExperiment(params: Evidently.Types.CreateExperimentRequest, callback?: (err: AWSError, data: Evidently.Types.CreateExperimentResponse) => void): Request<Evidently.Types.CreateExperimentResponse, AWSError>;
/**
* 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.
*/
createExperiment(callback?: (err: AWSError, data: Evidently.Types.CreateExperimentResponse) => void): Request<Evidently.Types.CreateExperimentResponse, AWSError>;
/**
* 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.
*/
createFeature(params: Evidently.Types.CreateFeatureRequest, callback?: (err: AWSError, data: Evidently.Types.CreateFeatureResponse) => void): Request<Evidently.Types.CreateFeatureResponse, AWSError>;
/**
* 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.
*/
createFeature(callback?: (err: AWSError, data: Evidently.Types.CreateFeatureResponse) => void): Request<Evidently.Types.CreateFeatureResponse, AWSError>;
/**
* 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.
*/
createLaunch(params: Evidently.Types.CreateLaunchRequest, callback?: (err: AWSError, data: Evidently.Types.CreateLaunchResponse) => void): Request<Evidently.Types.CreateLaunchResponse, AWSError>;
/**
* 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.
*/
createLaunch(callback?: (err: AWSError, data: Evidently.Types.CreateLaunchResponse) => void): Request<Evidently.Types.CreateLaunchResponse, AWSError>;
/**
* 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.
*/
createProject(params: Evidently.Types.CreateProjectRequest, callback?: (err: AWSError, data: Evidently.Types.CreateProjectResponse) => void): Request<Evidently.Types.CreateProjectResponse, AWSError>;
/**
* 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.
*/
createProject(callback?: (err: AWSError, data: Evidently.Types.CreateProjectResponse) => void): Request<Evidently.Types.CreateProjectResponse, AWSError>;
/**
* 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.
*/
createSegment(params: Evidently.Types.CreateSegmentRequest, callback?: (err: AWSError, data: Evidently.Types.CreateSegmentResponse) => void): Request<Evidently.Types.CreateSegmentResponse, AWSError>;
/**
* 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.
*/
createSegment(callback?: (err: AWSError, data: Evidently.Types.CreateSegmentResponse) => void): Request<Evidently.Types.CreateSegmentResponse, AWSError>;
/**
* Deletes an Evidently experiment. The feature used for the experiment is not deleted. To stop an experiment without deleting it, use StopExperiment.
*/
deleteExperiment(params: Evidently.Types.DeleteExperimentRequest, callback?: (err: AWSError, data: Evidently.Types.DeleteExperimentResponse) => void): Request<Evidently.Types.DeleteExperimentResponse, AWSError>;
/**
* Deletes an Evidently experiment. The feature used for the experiment is not deleted. To stop an experiment without deleting it, use StopExperiment.
*/
deleteExperiment(callback?: (err: AWSError, data: Evidently.Types.DeleteExperimentResponse) => void): Request<Evidently.Types.DeleteExperimentResponse, AWSError>;
/**
* Deletes an Evidently feature.
*/
deleteFeature(params: Evidently.Types.DeleteFeatureRequest, callback?: (err: AWSError, data: Evidently.Types.DeleteFeatureResponse) => void): Request<Evidently.Types.DeleteFeatureResponse, AWSError>;
/**
* Deletes an Evidently feature.
*/
deleteFeature(callback?: (err: AWSError, data: Evidently.Types.DeleteFeatureResponse) => void): Request<Evidently.Types.DeleteFeatureResponse, AWSError>;
/**
* Deletes an Evidently launch. The feature used for the launch is not deleted. To stop a launch without deleting it, use StopLaunch.
*/
deleteLaunch(params: Evidently.Types.DeleteLaunchRequest, callback?: (err: AWSError, data: Evidently.Types.DeleteLaunchResponse) => void): Request<Evidently.Types.DeleteLaunchResponse, AWSError>;
/**
* Deletes an Evidently launch. The feature used for the launch is not deleted. To stop a launch without deleting it, use StopLaunch.
*/
deleteLaunch(callback?: (err: AWSError, data: Evidently.Types.DeleteLaunchResponse) => void): Request<Evidently.Types.DeleteLaunchResponse, AWSError>;
/**
* 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.
*/
deleteProject(params: Evidently.Types.DeleteProjectRequest, callback?: (err: AWSError, data: Evidently.Types.DeleteProjectResponse) => void): Request<Evidently.Types.DeleteProjectResponse, AWSError>;
/**
* 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.
*/
deleteProject(callback?: (err: AWSError, data: Evidently.Types.DeleteProjectResponse) => void): Request<Evidently.Types.DeleteProjectResponse, AWSError>;
/**
* 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.
*/
deleteSegment(params: Evidently.Types.DeleteSegmentRequest, callback?: (err: AWSError, data: Evidently.Types.DeleteSegmentResponse) => void): Request<Evidently.Types.DeleteSegmentResponse, AWSError>;
/**
* 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.
*/
deleteSegment(callback?: (err: AWSError, data: Evidently.Types.DeleteSegmentResponse) => void): Request<Evidently.Types.DeleteSegmentResponse, AWSError>;
/**
* 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.
*/
evaluateFeature(params: Evidently.Types.EvaluateFeatureRequest, callback?: (err: AWSError, data: Evidently.Types.EvaluateFeatureResponse) => void): Request<Evidently.Types.EvaluateFeatureResponse, AWSError>;
/**
* 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.
*/
evaluateFeature(callback?: (err: AWSError, data: Evidently.Types.EvaluateFeatureResponse) => void): Request<Evidently.Types.EvaluateFeatureResponse, AWSError>;
/**
* Returns the details about one experiment. You must already know the experiment name. To retrieve a list of experiments in your account, use ListExperiments.
*/
getExperiment(params: Evidently.Types.GetExperimentRequest, callback?: (err: AWSError, data: Evidently.Types.GetExperimentResponse) => void): Request<Evidently.Types.GetExperimentResponse, AWSError>;
/**
* Returns the details about one experiment. You must already know the experiment name. To retrieve a list of experiments in your account, use ListExperiments.
*/
getExperiment(callback?: (err: AWSError, data: Evidently.Types.GetExperimentResponse) => void): Request<Evidently.Types.GetExperimentResponse, AWSError>;
/**
* 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.
*/
getExperimentResults(params: Evidently.Types.GetExperimentResultsRequest, callback?: (err: AWSError, data: Evidently.Types.GetExperimentResultsResponse) => void): Request<Evidently.Types.GetExperimentResultsResponse, AWSError>;
/**
* 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.
*/
getExperimentResults(callback?: (err: AWSError, data: Evidently.Types.GetExperimentResultsResponse) => void): Request<Evidently.Types.GetExperimentResultsResponse, AWSError>;
/**
* Returns the details about one feature. You must already know the feature name. To retrieve a list of features in your account, use ListFeatures.
*/
getFeature(params: Evidently.Types.GetFeatureRequest, callback?: (err: AWSError, data: Evidently.Types.GetFeatureResponse) => void): Request<Evidently.Types.GetFeatureResponse, AWSError>;
/**
* Returns the details about one feature. You must already know the feature name. To retrieve a list of features in your account, use ListFeatures.
*/
getFeature(callback?: (err: AWSError, data: Evidently.Types.GetFeatureResponse) => void): Request<Evidently.Types.GetFeatureResponse, AWSError>;
/**
* Returns the details about one launch. You must already know the launch name. To retrieve a list of launches in your account, use ListLaunches.
*/
getLaunch(params: Evidently.Types.GetLaunchRequest, callback?: (err: AWSError, data: Evidently.Types.GetLaunchResponse) => void): Request<Evidently.Types.GetLaunchResponse, AWSError>;
/**
* Returns the details about one launch. You must already know the launch name. To retrieve a list of launches in your account, use ListLaunches.
*/
getLaunch(callback?: (err: AWSError, data: Evidently.Types.GetLaunchResponse) => void): Request<Evidently.Types.GetLaunchResponse, AWSError>;
/**
* Returns the details about one launch. You must already know the project name. To retrieve a list of projects in your account, use ListProjects.
*/
getProject(params: Evidently.Types.GetProjectRequest, callback?: (err: AWSError, data: Evidently.Types.GetProjectResponse) => void): Request<Evidently.Types.GetProjectResponse, AWSError>;
/**
* Returns the details about one launch. You must already know the project name. To retrieve a list of projects in your account, use ListProjects.
*/
getProject(callback?: (err: AWSError, data: Evidently.Types.GetProjectResponse) => void): Request<Evidently.Types.GetProjectResponse, AWSError>;
/**
* Returns information about the specified segment. Specify the segment you want to view by specifying its ARN.
*/
getSegment(params: Evidently.Types.GetSegmentRequest, callback?: (err: AWSError, data: Evidently.Types.GetSegmentResponse) => void): Request<Evidently.Types.GetSegmentResponse, AWSError>;
/**
* Returns information about the specified segment. Specify the segment you want to view by specifying its ARN.
*/
getSegment(callback?: (err: AWSError, data: Evidently.Types.GetSegmentResponse) => void): Request<Evidently.Types.GetSegmentResponse, AWSError>;
/**
* Returns configuration details about all the experiments in the specified project.
*/
listExperiments(params: Evidently.Types.ListExperimentsRequest, callback?: (err: AWSError, data: Evidently.Types.ListExperimentsResponse) => void): Request<Evidently.Types.ListExperimentsResponse, AWSError>;
/**
* Returns configuration details about all the experiments in the specified project.
*/
listExperiments(callback?: (err: AWSError, data: Evidently.Types.ListExperimentsResponse) => void): Request<Evidently.Types.ListExperimentsResponse, AWSError>;
/**
* Returns configuration details about all the features in the specified project.
*/
listFeatures(params: Evidently.Types.ListFeaturesRequest, callback?: (err: AWSError, data: Evidently.Types.ListFeaturesResponse) => void): Request<Evidently.Types.ListFeaturesResponse, AWSError>;
/**
* Returns configuration details about all the features in the specified project.
*/
listFeatures(callback?: (err: AWSError, data: Evidently.Types.ListFeaturesResponse) => void): Request<Evidently.Types.ListFeaturesResponse, AWSError>;
/**
* Returns configuration details about all the launches in the specified project.
*/
listLaunches(params: Evidently.Types.ListLaunchesRequest, callback?: (err: AWSError, data: Evidently.Types.ListLaunchesResponse) => void): Request<Evidently.Types.ListLaunchesResponse, AWSError>;
/**
* Returns configuration details about all the launches in the specified project.
*/
listLaunches(callback?: (err: AWSError, data: Evidently.Types.ListLaunchesResponse) => void): Request<Evidently.Types.ListLaunchesResponse, AWSError>;
/**
* Returns configuration details about all the projects in the current Region in your account.
*/
listProjects(params: Evidently.Types.ListProjectsRequest, callback?: (err: AWSError, data: Evidently.Types.ListProjectsResponse) => void): Request<Evidently.Types.ListProjectsResponse, AWSError>;
/**
* Returns configuration details about all the projects in the current Region in your account.
*/
listProjects(callback?: (err: AWSError, data: Evidently.Types.ListProjectsResponse) => void): Request<Evidently.Types.ListProjectsResponse, AWSError>;
/**
* Use this operation to find which experiments or launches are using a specified segment.
*/
listSegmentReferences(params: Evidently.Types.ListSegmentReferencesRequest, callback?: (err: AWSError, data: Evidently.Types.ListSegmentReferencesResponse) => void): Request<Evidently.Types.ListSegmentReferencesResponse, AWSError>;
/**
* Use this operation to find which experiments or launches are using a specified segment.
*/
listSegmentReferences(callback?: (err: AWSError, data: Evidently.Types.ListSegmentReferencesResponse) => void): Request<Evidently.Types.ListSegmentReferencesResponse, AWSError>;
/**
* Returns a list of audience segments that you have created in your account in this Region.
*/
listSegments(params: Evidently.Types.ListSegmentsRequest, callback?: (err: AWSError, data: Evidently.Types.ListSegmentsResponse) => void): Request<Evidently.Types.ListSegmentsResponse, AWSError>;
/**
* Returns a list of audience segments that you have created in your account in this Region.
*/
listSegments(callback?: (err: AWSError, data: Evidently.Types.ListSegmentsResponse) => void): Request<Evidently.Types.ListSegmentsResponse, AWSError>;
/**
* Displays the tags associated with an Evidently resource.
*/
listTagsForResource(params: Evidently.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Evidently.Types.ListTagsForResourceResponse) => void): Request<Evidently.Types.ListTagsForResourceResponse, AWSError>;
/**
* Displays the tags associated with an Evidently resource.
*/
listTagsForResource(callback?: (err: AWSError, data: Evidently.Types.ListTagsForResourceResponse) => void): Request<Evidently.Types.ListTagsForResourceResponse, AWSError>;
/**
* Sends performance events to Evidently. These events can be used to evaluate a launch or an experiment.
*/
putProjectEvents(params: Evidently.Types.PutProjectEventsRequest, callback?: (err: AWSError, data: Evidently.Types.PutProjectEventsResponse) => void): Request<Evidently.Types.PutProjectEventsResponse, AWSError>;
/**
* Sends performance events to Evidently. These events can be used to evaluate a launch or an experiment.
*/
putProjectEvents(callback?: (err: AWSError, data: Evidently.Types.PutProjectEventsResponse) => void): Request<Evidently.Types.PutProjectEventsResponse, AWSError>;
/**
* Starts an existing experiment. To create an experiment, use CreateExperiment.
*/
startExperiment(params: Evidently.Types.StartExperimentRequest, callback?: (err: AWSError, data: Evidently.Types.StartExperimentResponse) => void): Request<Evidently.Types.StartExperimentResponse, AWSError>;
/**
* Starts an existing experiment. To create an experiment, use CreateExperiment.
*/
startExperiment(callback?: (err: AWSError, data: Evidently.Types.StartExperimentResponse) => void): Request<Evidently.Types.StartExperimentResponse, AWSError>;
/**
* Starts an existing launch. To create a launch, use CreateLaunch.
*/
startLaunch(params: Evidently.Types.StartLaunchRequest, callback?: (err: AWSError, data: Evidently.Types.StartLaunchResponse) => void): Request<Evidently.Types.StartLaunchResponse, AWSError>;
/**
* Starts an existing launch. To create a launch, use CreateLaunch.
*/
startLaunch(callback?: (err: AWSError, data: Evidently.Types.StartLaunchResponse) => void): Request<Evidently.Types.StartLaunchResponse, AWSError>;
/**
* Stops an experiment that is currently running. If you stop an experiment, you can't resume it or restart it.
*/
stopExperiment(params: Evidently.Types.StopExperimentRequest, callback?: (err: AWSError, data: Evidently.Types.StopExperimentResponse) => void): Request<Evidently.Types.StopExperimentResponse, AWSError>;
/**
* Stops an experiment that is currently running. If you stop an experiment, you can't resume it or restart it.
*/
stopExperiment(callback?: (err: AWSError, data: Evidently.Types.StopExperimentResponse) => void): Request<Evidently.Types.StopExperimentResponse, AWSError>;
/**
* 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.
*/
stopLaunch(params: Evidently.Types.StopLaunchRequest, callback?: (err: AWSError, data: Evidently.Types.StopLaunchResponse) => void): Request<Evidently.Types.StopLaunchResponse, AWSError>;
/**
* 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.
*/
stopLaunch(callback?: (err: AWSError, data: Evidently.Types.StopLaunchResponse) => void): Request<Evidently.Types.StopLaunchResponse, AWSError>;
/**
* 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.
*/
tagResource(params: Evidently.Types.TagResourceRequest, callback?: (err: AWSError, data: Evidently.Types.TagResourceResponse) => void): Request<Evidently.Types.TagResourceResponse, AWSError>;
/**
* 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.
*/
tagResource(callback?: (err: AWSError, data: Evidently.Types.TagResourceResponse) => void): Request<Evidently.Types.TagResourceResponse, AWSError>;
/**
* 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.
*/
testSegmentPattern(params: Evidently.Types.TestSegmentPatternRequest, callback?: (err: AWSError, data: Evidently.Types.TestSegmentPatternResponse) => void): Request<Evidently.Types.TestSegmentPatternResponse, AWSError>;
/**
* 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.
*/
testSegmentPattern(callback?: (err: AWSError, data: Evidently.Types.TestSegmentPatternResponse) => void): Request<Evidently.Types.TestSegmentPatternResponse, AWSError>;
/**
* Removes one or more tags from the specified resource.
*/
untagResource(params: Evidently.Types.UntagResourceRequest, callback?: (err: AWSError, data: Evidently.Types.UntagResourceResponse) => void): Request<Evidently.Types.UntagResourceResponse, AWSError>;
/**
* Removes one or more tags from the specified resource.
*/
untagResource(callback?: (err: AWSError, data: Evidently.Types.UntagResourceResponse) => void): Request<Evidently.Types.UntagResourceResponse, AWSError>;
/**
* Updates an Evidently experiment. Don't use this operation to update an experiment's tag. Instead, use TagResource.
*/
updateExperiment(params: Evidently.Types.UpdateExperimentRequest, callback?: (err: AWSError, data: Evidently.Types.UpdateExperimentResponse) => void): Request<Evidently.Types.UpdateExperimentResponse, AWSError>;
/**
* Updates an Evidently experiment. Don't use this operation to update an experiment's tag. Instead, use TagResource.
*/
updateExperiment(callback?: (err: AWSError, data: Evidently.Types.UpdateExperimentResponse) => void): Request<Evidently.Types.UpdateExperimentResponse, AWSError>;
/**
* Updates an existing feature. You can't use this operation to update the tags of an existing feature. Instead, use TagResource.
*/
updateFeature(params: Evidently.Types.UpdateFeatureRequest, callback?: (err: AWSError, data: Evidently.Types.UpdateFeatureResponse) => void): Request<Evidently.Types.UpdateFeatureResponse, AWSError>;
/**
* Updates an existing feature. You can't use this operation to update the tags of an existing feature. Instead, use TagResource.
*/
updateFeature(callback?: (err: AWSError, data: Evidently.Types.UpdateFeatureResponse) => void): Request<Evidently.Types.UpdateFeatureResponse, AWSError>;
/**
* Updates a launch of a given feature. Don't use this operation to update the tags of an existing launch. Instead, use TagResource.
*/
updateLaunch(params: Evidently.Types.UpdateLaunchRequest, callback?: (err: AWSError, data: Evidently.Types.UpdateLaunchResponse) => void): Request<Evidently.Types.UpdateLaunchResponse, AWSError>;
/**
* Updates a launch of a given feature. Don't use this operation to update the tags of an existing launch. Instead, use TagResource.
*/
updateLaunch(callback?: (err: AWSError, data: Evidently.Types.UpdateLaunchResponse) => void): Request<Evidently.Types.UpdateLaunchResponse, AWSError>;
/**
* 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.
*/
updateProject(params: Evidently.Types.UpdateProjectRequest, callback?: (err: AWSError, data: Evidently.Types.UpdateProjectResponse) => void): Request<Evidently.Types.UpdateProjectResponse, AWSError>;
/**
* 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.
*/
updateProject(callback?: (err: AWSError, data: Evidently.Types.UpdateProjectResponse) => void): Request<Evidently.Types.UpdateProjectResponse, AWSError>;
/**
* 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.
*/
updateProjectDataDelivery(params: Evidently.Types.UpdateProjectDataDeliveryRequest, callback?: (err: AWSError, data: Evidently.Types.UpdateProjectDataDeliveryResponse) => void): Request<Evidently.Types.UpdateProjectDataDeliveryResponse, AWSError>;
/**
* 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.
*/
updateProjectDataDelivery(callback?: (err: AWSError, data: Evidently.Types.UpdateProjectDataDeliveryResponse) => void): Request<Evidently.Types.UpdateProjectDataDeliveryResponse, AWSError>;
}
declare namespace Evidently {
export type AppConfigResourceId = string;
export type Arn = string;
export interface BatchEvaluateFeatureRequest {
/**
* The name or ARN of the project that contains the feature being evaluated.
*/
project: ProjectRef;
/**
* An array of structures, where each structure assigns a feature variation to one user session.
*/
requests: EvaluationRequestsList;
}
export interface BatchEvaluateFeatureResponse {
/**
* An array of structures, where each structure displays the results of one feature evaluation assignment to one user session.
*/
results?: EvaluationResultsList;
}
export type Boolean = boolean;
export type ChangeDirectionEnum = "INCREASE"|"DECREASE"|string;
export interface CloudWatchLogsDestination {
/**
* The name of the log group where the project stores evaluation events.
*/
logGroup?: CwLogGroupSafeName;
}
export interface CloudWatchLogsDestinationConfig {
/**
* The name of the log group where the project stores evaluation events.
*/
logGroup?: CwLogGroupSafeName;
}
export interface CreateExperimentRequest {
/**
* An optional description of the experiment.
*/
description?: Description;
/**
* 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.
*/
metricGoals: MetricGoalConfigList;
/**
* A name for the new experiment.
*/
name: ExperimentName;
/**
* 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.
*/
onlineAbConfig?: OnlineAbConfig;
/**
* The name or ARN of the project that you want to create the new experiment in.
*/
project: ProjectRef;
/**
* 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.
*/
randomizationSalt?: RandomizationSalt;
/**
* 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.
*/
samplingRate?: SplitWeight;
/**
* 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.
*/
segment?: SegmentRef;
/**
* 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.
*/
tags?: TagMap;
/**
* An array of structures that describe the configuration of each feature variation used in the experiment.
*/
treatments: TreatmentConfigList;
}
export interface CreateExperimentResponse {
/**
* A structure containing the configuration details of the experiment that you created.
*/
experiment: Experiment;
}
export interface CreateFeatureRequest {
/**
* 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.
*/
defaultVariation?: VariationName;
/**
* An optional description of the feature.
*/
description?: Description;
/**
* 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.
*/
entityOverrides?: EntityOverrideMap;
/**
* 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.
*/
evaluationStrategy?: FeatureEvaluationStrategy;
/**
* The name for the new feature.
*/
name: FeatureName;
/**
* The name or ARN of the project that is to contain the new feature.
*/
project: ProjectRef;
/**
* 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.
*/
tags?: TagMap;
/**
* An array of structures that contain the configuration of the feature's different variations.
*/
variations: VariationConfigsList;
}
export interface CreateFeatureResponse {
/**
* A structure that contains information about the new feature.
*/
feature?: Feature;
}
export interface CreateLaunchRequest {
/**
* An optional description for the launch.
*/
description?: Description;
/**
* An array of structures that contains the feature and variations that are to be used for the launch.
*/
groups: LaunchGroupConfigList;
/**
* An array of structures that define the metrics that will be used to monitor the launch performance.
*/
metricMonitors?: MetricMonitorConfigList;
/**
* The name for the new launch.
*/
name: LaunchName;
/**
* The name or ARN of the project that you want to create the launch in.
*/
project: ProjectRef;
/**
* 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.
*/
randomizationSalt?: RandomizationSalt;
/**
* An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
*/
scheduledSplitsConfig?: ScheduledSplitsLaunchConfig;
/**
* 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.
*/
tags?: TagMap;
}
export interface CreateLaunchResponse {
/**
* A structure that contains the configuration of the launch that was created.
*/
launch: Launch;
}
export interface CreateProjectRequest {
/**
* 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.
*/
appConfigResource?: ProjectAppConfigResourceConfig;
/**
* 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.
*/
dataDelivery?: ProjectDataDeliveryConfig;
/**
* An optional description of the project.
*/
description?: Description;
/**
* The name for the project.
*/
name: ProjectName;
/**
* 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.
*/
tags?: TagMap;
}
export interface CreateProjectResponse {
/**
* A structure that contains information about the created project.
*/
project: Project;
}
export interface CreateSegmentRequest {
/**
* An optional description for this segment.
*/
description?: Description;
/**
* A name for the segment.
*/
name: SegmentName;
/**
* The pattern to use for the segment. For more information about pattern syntax, see Segment rule pattern syntax.
*/
pattern: SegmentPattern;
/**
* 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.
*/
tags?: TagMap;
}
export interface CreateSegmentResponse {
/**
* A structure that contains the complete information about the segment that was just created.
*/
segment: Segment;
}
export type CwDimensionSafeName = string;
export type CwLogGroupSafeName = string;
export interface DeleteExperimentRequest {
/**
* The name of the experiment to delete.
*/
experiment: ExperimentName;
/**
* The name or ARN of the project that contains the experiment to delete.
*/
project: ProjectRef;
}
export interface DeleteExperimentResponse {
}
export interface DeleteFeatureRequest {
/**
* The name of the feature to delete.
*/
feature: FeatureName;
/**
* The name or ARN of the project that contains the feature to delete.
*/
project: ProjectRef;
}
export interface DeleteFeatureResponse {
}
export interface DeleteLaunchRequest {
/**
* The name of the launch to delete.
*/
launch: LaunchName;
/**
* The name or ARN of the project that contains the launch to delete.
*/
project: ProjectRef;
}
export interface DeleteLaunchResponse {
}
export interface Delete