Skip to content

Commit 37a7bdb

Browse files
author
awstools
committed
feat(client-evidently): Deprecate all Evidently API for AWS CloudWatch Evidently deprecation
1 parent c3a351c commit 37a7bdb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+605
-883
lines changed

clients/client-evidently/README.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,7 @@
66

77
AWS SDK for JavaScript Evidently Client for Node.js, Browser and React Native.
88

9-
<p>You can use Amazon CloudWatch Evidently to safely validate new features by serving
10-
them to a specified percentage
11-
of your users while you roll out the feature. You can monitor the performance of the new feature
12-
to help you decide when to ramp up traffic to your users. This helps you
13-
reduce risk and identify unintended consequences before you fully launch the feature.</p>
14-
<p>You can also conduct A/B experiments to make feature design decisions based on evidence
15-
and data. An experiment can test as many as five variations at once. Evidently collects
16-
experiment data and analyzes it using statistical methods. It also provides clear
17-
recommendations about which variations perform better. You can test both user-facing features
18-
and backend features.</p>
9+
<p>You can use Amazon CloudWatch Evidently 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 your users. This helps you reduce risk and identify unintended consequences before you fully launch the feature.</p> <p>You can also conduct A/B experiments to 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 using statistical methods. It also provides clear recommendations about which variations perform better. You can test both user-facing features and backend features.</p>
1910

2011
## Installing
2112
To install this package, simply type add or install @aws-sdk/client-evidently

clients/client-evidently/src/Evidently.ts

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -858,16 +858,7 @@ export interface Evidently {
858858
}
859859

860860
/**
861-
* <p>You can use Amazon CloudWatch Evidently to safely validate new features by serving
862-
* them to a specified percentage
863-
* of your users while you roll out the feature. You can monitor the performance of the new feature
864-
* to help you decide when to ramp up traffic to your users. This helps you
865-
* reduce risk and identify unintended consequences before you fully launch the feature.</p>
866-
* <p>You can also conduct A/B experiments to make feature design decisions based on evidence
867-
* and data. An experiment can test as many as five variations at once. Evidently collects
868-
* experiment data and analyzes it using statistical methods. It also provides clear
869-
* recommendations about which variations perform better. You can test both user-facing features
870-
* and backend features.</p>
861+
* <p>You can use Amazon CloudWatch Evidently 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 your users. This helps you reduce risk and identify unintended consequences before you fully launch the feature.</p> <p>You can also conduct A/B experiments to 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 using statistical methods. It also provides clear recommendations about which variations perform better. You can test both user-facing features and backend features.</p>
871862
* @public
872863
*/
873864
export class Evidently extends EvidentlyClient implements Evidently {}

clients/client-evidently/src/EvidentlyClient.ts

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -404,16 +404,7 @@ export type EvidentlyClientResolvedConfigType = __SmithyResolvedConfiguration<__
404404
export interface EvidentlyClientResolvedConfig extends EvidentlyClientResolvedConfigType {}
405405

406406
/**
407-
* <p>You can use Amazon CloudWatch Evidently to safely validate new features by serving
408-
* them to a specified percentage
409-
* of your users while you roll out the feature. You can monitor the performance of the new feature
410-
* to help you decide when to ramp up traffic to your users. This helps you
411-
* reduce risk and identify unintended consequences before you fully launch the feature.</p>
412-
* <p>You can also conduct A/B experiments to make feature design decisions based on evidence
413-
* and data. An experiment can test as many as five variations at once. Evidently collects
414-
* experiment data and analyzes it using statistical methods. It also provides clear
415-
* recommendations about which variations perform better. You can test both user-facing features
416-
* and backend features.</p>
407+
* <p>You can use Amazon CloudWatch Evidently 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 your users. This helps you reduce risk and identify unintended consequences before you fully launch the feature.</p> <p>You can also conduct A/B experiments to 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 using statistical methods. It also provides clear recommendations about which variations perform better. You can test both user-facing features and backend features.</p>
417408
* @public
418409
*/
419410
export class EvidentlyClient extends __Client<

clients/client-evidently/src/commands/BatchEvaluateFeatureCommand.ts

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,9 @@ export interface BatchEvaluateFeatureCommandInput extends BatchEvaluateFeatureRe
2727
export interface BatchEvaluateFeatureCommandOutput extends BatchEvaluateFeatureResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>This operation assigns feature variation to user sessions. For each user session, you pass
31-
* in an <code>entityID</code> that represents the user. Evidently then checks the evaluation
32-
* rules and assigns the variation.</p>
33-
* <p>The first rules that are evaluated are the override rules. If the user's
34-
* <code>entityID</code> matches an override rule, the user is served the variation specified
35-
* by that rule.</p>
36-
* <p>Next, if there is a launch of the feature, the user might be assigned to a variation in
37-
* the launch. The chance of this depends on the percentage of users that are allocated to that
38-
* launch. If the user is enrolled in the launch, the variation they are served depends on the
39-
* allocation of the various feature variations used for the launch.</p>
40-
* <p>If the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might
41-
* be assigned to a variation in the experiment. The chance of this
42-
* depends on the percentage of users that are allocated to that experiment. If the user is enrolled in the experiment,
43-
* the variation they are served depends on the allocation of the various feature variations used for the experiment. </p>
44-
* <p>If the user is not assigned to a launch or experiment, they are served the default variation.</p>
30+
* <p>This operation assigns feature variation to user sessions. For each user session, you pass in an <code>entityID</code> that represents the user. Evidently then checks the evaluation rules and assigns the variation.</p> <p>The first rules that are evaluated are the override rules. If the user's <code>entityID</code> matches an override rule, the user is served the variation specified by that rule.</p> <p>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.</p> <p>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. </p> <p>If the user is not assigned to a launch or experiment, they are served the default variation.</p>
31+
*
32+
* @deprecated AWS CloudWatch Evidently has been deprecated since 11/17/2025.
4533
* @example
4634
* Use a bare-bones client and the command you need to make an API call.
4735
* ```javascript

clients/client-evidently/src/commands/CreateExperimentCommand.ts

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,9 @@ export interface CreateExperimentCommandInput extends CreateExperimentRequest {}
2727
export interface CreateExperimentCommandOutput extends CreateExperimentResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Creates an Evidently <i>experiment</i>. Before you create an experiment,
31-
* you must create the feature to use for the experiment.</p>
32-
* <p>An experiment helps you make feature design
33-
* decisions based on evidence and data. An experiment can test as
34-
* many as five variations at once. Evidently collects experiment data and analyzes it by statistical methods, and provides
35-
* clear recommendations about which variations perform better.</p>
36-
* <p>You can optionally specify a <code>segment</code> to have the experiment consider only certain audience
37-
* types in the experiment, such as using only user sessions from a certain location or who use a certain internet browser.</p>
38-
* <p>Don't use this operation to update an existing experiment. Instead, use
39-
* <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateExperiment.html">UpdateExperiment</a>. </p>
30+
* <p>Creates an Evidently <i>experiment</i>. Before you create an experiment, you must create the feature to use for the experiment.</p> <p>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.</p> <p>You can optionally specify a <code>segment</code> 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.</p> <p>Don't use this operation to update an existing experiment. Instead, use <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateExperiment.html">UpdateExperiment</a>. </p>
31+
*
32+
* @deprecated AWS CloudWatch Evidently has been deprecated since 11/17/2025.
4033
* @example
4134
* Use a bare-bones client and the command you need to make an API call.
4235
* ```javascript

clients/client-evidently/src/commands/CreateFeatureCommand.ts

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,9 @@ export interface CreateFeatureCommandInput extends CreateFeatureRequest {}
2727
export interface CreateFeatureCommandOutput extends CreateFeatureResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Creates an Evidently <i>feature</i> that you want to launch or test. You can define up to
31-
* five variations of a feature, and use these variations in your launches and experiments. A feature must be created in
32-
* a project. For information about creating a project, see <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateProject.html">CreateProject</a>.</p>
33-
* <p>Don't use this operation to update an existing feature. Instead, use
34-
* <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateFeature.html">UpdateFeature</a>. </p>
30+
* <p>Creates an Evidently <i>feature</i> 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 <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateProject.html">CreateProject</a>.</p> <p>Don't use this operation to update an existing feature. Instead, use <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateFeature.html">UpdateFeature</a>. </p>
31+
*
32+
* @deprecated AWS CloudWatch Evidently has been deprecated since 11/17/2025.
3533
* @example
3634
* Use a bare-bones client and the command you need to make an API call.
3735
* ```javascript

clients/client-evidently/src/commands/CreateLaunchCommand.ts

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,9 @@ export interface CreateLaunchCommandInput extends CreateLaunchRequest {}
2727
export interface CreateLaunchCommandOutput extends CreateLaunchResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Creates a <i>launch</i> of a given feature. Before you create a launch, you
31-
* must create the feature to use for the launch.</p>
32-
* <p>You can use a launch to safely validate new features by serving them to a specified
33-
* percentage of your users while you roll out the feature. You can monitor the performance of
34-
* the new feature to help you decide when to ramp up traffic to more users. This helps you
35-
* reduce risk and identify unintended consequences before you fully launch the feature.</p>
36-
* <p>Don't use this operation to update an existing launch. Instead, use
37-
* <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateLaunch.html">UpdateLaunch</a>. </p>
30+
* <p>Creates a <i>launch</i> of a given feature. Before you create a launch, you must create the feature to use for the launch.</p> <p>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.</p> <p>Don't use this operation to update an existing launch. Instead, use <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateLaunch.html">UpdateLaunch</a>. </p>
31+
*
32+
* @deprecated AWS CloudWatch Evidently has been deprecated since 11/17/2025.
3833
* @example
3934
* Use a bare-bones client and the command you need to make an API call.
4035
* ```javascript

clients/client-evidently/src/commands/CreateProjectCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ export interface CreateProjectCommandInput extends CreateProjectRequest {}
2727
export interface CreateProjectCommandOutput extends CreateProjectResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Creates a project, which is the logical object in Evidently that can contain features, launches, and
31-
* experiments. Use projects to group similar features together.</p>
32-
* <p>To update an existing project, use <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateProject.html">UpdateProject</a>.</p>
30+
* <p>Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together.</p> <p>To update an existing project, use <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateProject.html">UpdateProject</a>.</p>
31+
*
32+
* @deprecated AWS CloudWatch Evidently has been deprecated since 11/17/2025.
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript

clients/client-evidently/src/commands/CreateSegmentCommand.ts

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,9 @@ export interface CreateSegmentCommandInput extends CreateSegmentRequest {}
2727
export interface CreateSegmentCommandOutput extends CreateSegmentResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Use this operation to define a <i>segment</i> of your audience. A segment
31-
* is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users,
32-
* users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects,
33-
* such as age.</p>
34-
* <p>Using a segment in an experiment limits that experiment to evaluate only the users who match the segment
35-
* criteria. Using one or more segments in a launch allows you to define different traffic splits for the different
36-
* audience segments.</p>
37-
* <p>For more information about segment pattern syntax, see
38-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax.html">
39-
* Segment rule pattern syntax</a>.</p>
40-
* <p>The pattern that you define for a segment is matched against the value of <code>evaluationContext</code>, which
41-
* is passed into Evidently in the <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html">EvaluateFeature</a> operation,
42-
* when Evidently assigns a feature variation to a user.</p>
30+
* <p>Use this operation to define a <i>segment</i> 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.</p> <p>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.</p> <p>For more information about segment pattern syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax.html"> Segment rule pattern syntax</a>.</p> <p>The pattern that you define for a segment is matched against the value of <code>evaluationContext</code>, which is passed into Evidently in the <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html">EvaluateFeature</a> operation, when Evidently assigns a feature variation to a user.</p>
31+
*
32+
* @deprecated AWS CloudWatch Evidently has been deprecated since 11/17/2025.
4333
* @example
4434
* Use a bare-bones client and the command you need to make an API call.
4535
* ```javascript

clients/client-evidently/src/commands/DeleteExperimentCommand.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ export interface DeleteExperimentCommandInput extends DeleteExperimentRequest {}
2727
export interface DeleteExperimentCommandOutput extends DeleteExperimentResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Deletes an Evidently experiment. The feature used for the experiment is not deleted.</p>
31-
* <p>To stop an experiment without deleting it, use <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_StopExperiment.html">StopExperiment</a>. </p>
30+
* <p>Deletes an Evidently experiment. The feature used for the experiment is not deleted.</p> <p>To stop an experiment without deleting it, use <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_StopExperiment.html">StopExperiment</a>. </p>
31+
*
32+
* @deprecated AWS CloudWatch Evidently has been deprecated since 11/17/2025.
3233
* @example
3334
* Use a bare-bones client and the command you need to make an API call.
3435
* ```javascript

0 commit comments

Comments
 (0)