Amazon CloudWatch Evidently Update: This release adds support for the client-side evaluation - powered by AWS AppConfig feature.

Author: AWS

.changes/next-release/feature-AmazonCloudWatchEvidently-841cb41.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "Amazon CloudWatch Evidently",
+    "contributor": "",
+    "description": "This release adds support for the client-side evaluation - powered by AWS AppConfig feature."
+}

services/evidently/src/main/resources/codegen-resources/service-2.json

@@ -117,7 +117,7 @@
         {"shape":"ServiceQuotaExceededException"},
         {"shape":"AccessDeniedException"}
       ],
-      "documentation":"<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 allow you to define different traffic splits for the different audience segments.</p> <pre><code> &lt;p&gt;For more information about segment pattern syntax, see &lt;a href=&quot;https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments-syntax.html&quot;&gt; Segment rule pattern syntax&lt;/a&gt;.&lt;/p&gt; &lt;p&gt;The pattern that you define for a segment is matched against the value of &lt;code&gt;evaluationContext&lt;/code&gt;, which is passed into Evidently in the &lt;a href=&quot;https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html&quot;&gt;EvaluateFeature&lt;/a&gt; operation, when Evidently assigns a feature variation to a user.&lt;/p&gt; </code></pre>"
+      "documentation":"<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> <pre><code> &lt;p&gt;For more information about segment pattern syntax, see &lt;a href=&quot;https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax.html&quot;&gt; Segment rule pattern syntax&lt;/a&gt;.&lt;/p&gt; &lt;p&gt;The pattern that you define for a segment is matched against the value of &lt;code&gt;evaluationContext&lt;/code&gt;, which is passed into Evidently in the &lt;a href=&quot;https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html&quot;&gt;EvaluateFeature&lt;/a&gt; operation, when Evidently assigns a feature variation to a user.&lt;/p&gt; </code></pre>"
     },
     "DeleteExperiment":{
       "name":"DeleteExperiment",
@@ -266,7 +266,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"AccessDeniedException"}
       ],
-      "documentation":"<p>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.</p> <p>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.</p>"
+      "documentation":"<p>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.</p> <p>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.</p>"
     },
     "GetFeature":{
       "name":"GetFeature",
@@ -694,6 +694,10 @@
       },
       "exception":true
     },
+    "AppConfigResourceId":{
+      "type":"string",
+      "pattern":"[a-z0-9]{4,7}"
+    },
     "Arn":{
       "type":"string",
       "max":2048,
@@ -954,6 +958,10 @@
       "type":"structure",
       "required":["name"],
       "members":{
+        "appConfigResource":{
+          "shape":"ProjectAppConfigResourceConfig",
+          "documentation":"<p>Use this parameter if the project will use <i>client-side evaluation powered by AppConfig</i>. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the <a href=\"https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html\">EvaluateFeature</a> operation. This mitigates the latency and availability risks that come with an API call. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-client-side-evaluation.html\"> Client-side evaluation - powered by AppConfig.</a> </p> <p>This parameter is a structure that contains information about the AppConfig application and environment that will be used as for client-side evaluation.</p> <p>To create a project that uses client-side evaluation, you must have the <code>evidently:ExportProjectAsConfiguration</code> permission.</p>"
+        },
         "dataDelivery":{
           "shape":"ProjectDataDeliveryConfig",
           "documentation":"<p>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.</p>"
@@ -999,7 +1007,7 @@
         },
         "pattern":{
           "shape":"SegmentPattern",
-          "documentation":"<p>The pattern to use for the segment. For more information about pattern syntax, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments-syntax.html\"> Segment rule pattern syntax</a>.</p>",
+          "documentation":"<p>The pattern to use for the segment. For more information about 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>",
           "jsonvalue":true
         },
         "tags":{
@@ -2692,6 +2700,10 @@
           "shape":"Long",
           "documentation":"<p>The number of ongoing launches currently in the project.</p>"
         },
+        "appConfigResource":{
+          "shape":"ProjectAppConfigResource",
+          "documentation":"<p>This structure defines the configuration of how your application integrates with AppConfig to run client-side evaluation.</p>"
+        },
         "arn":{
           "shape":"ProjectArn",
           "documentation":"<p>The name or ARN of the project.</p>"
@@ -2739,6 +2751,43 @@
       },
       "documentation":"<p>This structure defines a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together.</p>"
     },
+    "ProjectAppConfigResource":{
+      "type":"structure",
+      "required":[
+        "applicationId",
+        "configurationProfileId",
+        "environmentId"
+      ],
+      "members":{
+        "applicationId":{
+          "shape":"AppConfigResourceId",
+          "documentation":"<p>The ID of the AppConfig application to use for client-side evaluation. </p>"
+        },
+        "configurationProfileId":{
+          "shape":"AppConfigResourceId",
+          "documentation":"<p>The ID of the AppConfig profile to use for client-side evaluation. </p>"
+        },
+        "environmentId":{
+          "shape":"AppConfigResourceId",
+          "documentation":"<p>The ID of the AppConfig environment to use for client-side evaluation. This must be an environment that is within the application that you specify for <code>applicationId</code>.</p>"
+        }
+      },
+      "documentation":"<p>This is a structure that defines the configuration of how your application integrates with AppConfig to run client-side evaluation.</p>"
+    },
+    "ProjectAppConfigResourceConfig":{
+      "type":"structure",
+      "members":{
+        "applicationId":{
+          "shape":"AppConfigResourceId",
+          "documentation":"<p>The ID of the AppConfig application to use for client-side evaluation. </p>"
+        },
+        "environmentId":{
+          "shape":"AppConfigResourceId",
+          "documentation":"<p>The ID of the AppConfig environment to use for client-side evaluation. This must be an environment that is within the application that you specify for <code>applicationId</code>.</p>"
+        }
+      },
+      "documentation":"<p>Use this parameter to configure client-side evaluation for your project. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the <a href=\"https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html\">EvaluateFeature</a> operation to assign the variations. This mitigates the latency and availability risks that come with an API call.</p> <p> <code>ProjectAppConfigResource</code> is a structure that defines the configuration of how your application integrates with AppConfig to run client-side evaluation.</p>"
+    },
     "ProjectArn":{
       "type":"string",
       "max":2048,
@@ -3148,7 +3197,7 @@
         },
         "pattern":{
           "shape":"SegmentPattern",
-          "documentation":"<p/>",
+          "documentation":"<p>The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html\">Segment rule pattern syntax</a>.</p>",
           "jsonvalue":true
         },
         "tags":{
@@ -3814,6 +3863,10 @@
       "type":"structure",
       "required":["project"],
       "members":{
+        "appConfigResource":{
+          "shape":"ProjectAppConfigResourceConfig",
+          "documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html\">EvaluateFeature</a> operation. This mitigates the latency and availability risks that come with an API call. allows you to</p> <p>This parameter is a structure that contains information about the AppConfig application that will be used for client-side evaluation.</p>"
+        },
         "description":{
           "shape":"Description",
           "documentation":"<p>An optional description of the project.</p>"