feat(client-evidently): This release adds support for the client-side evaluation - powered by AWS AppConfig feature.

Author: awstools

clients/client-evidently/src/Evidently.ts

@@ -377,11 +377,11 @@ export class Evidently extends EvidentlyClient {
    *       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
+   *       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-syntax.html">
+   *       <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
@@ -670,7 +670,10 @@ export class Evidently extends EvidentlyClient {
 
   /**
    * <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>
+   *        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>

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

@@ -33,11 +33,11 @@ export interface CreateSegmentCommandOutput extends CreateSegmentResponse, __Met
  *       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
+ *       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-syntax.html">
+ *       <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

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

@@ -29,7 +29,10 @@ export interface GetExperimentResultsCommandOutput extends GetExperimentResultsR
 
 /**
  * <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>
+ *        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>

clients/client-evidently/src/models/models_0.ts

@@ -1412,6 +1412,28 @@ export interface CreateLaunchResponse {
   launch: Launch | undefined;
 }
 
+/**
+ * <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>
+ */
+export interface ProjectAppConfigResourceConfig {
+  /**
+   * <p>The ID of the AppConfig application to use for client-side evaluation. </p>
+   */
+  applicationId?: string;
+
+  /**
+   * <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>
+   */
+  environmentId?: string;
+}
+
 /**
  * <p>If the project stores evaluation events in an Amazon S3 bucket, this structure
  *        stores the bucket name and bucket prefix.</p>
@@ -1465,6 +1487,21 @@ export interface CreateProjectRequest {
    */
   dataDelivery?: ProjectDataDeliveryConfig;
 
+  /**
+   * <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>
+   */
+  appConfigResource?: ProjectAppConfigResourceConfig;
+
   /**
    * <p>Assigns one or more tags (key-value pairs) to the project.</p>
    *          <p>Tags can help you organize and categorize your resources. You can also use them to scope user
@@ -1478,6 +1515,28 @@ export interface CreateProjectRequest {
   tags?: Record<string, string>;
 }
 
+/**
+ * <p>This is a structure that defines the configuration of how your application
+ *       integrates with AppConfig to run client-side evaluation.</p>
+ */
+export interface ProjectAppConfigResource {
+  /**
+   * <p>The ID of the AppConfig application to use for client-side evaluation. </p>
+   */
+  applicationId: string | undefined;
+
+  /**
+   * <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>
+   */
+  environmentId: string | undefined;
+
+  /**
+   * <p>The ID of the AppConfig profile to use for client-side evaluation. </p>
+   */
+  configurationProfileId: string | undefined;
+}
+
 /**
  * <p>If the project stores evaluation events in an Amazon S3 bucket, this structure
  *        stores the bucket name and bucket prefix.</p>
@@ -1585,6 +1644,12 @@ export interface Project {
    */
   dataDelivery?: ProjectDataDelivery;
 
+  /**
+   * <p>This structure defines the configuration of how your application
+   *       integrates with AppConfig to run client-side evaluation.</p>
+   */
+  appConfigResource?: ProjectAppConfigResource;
+
   /**
    * <p>The list of tag keys and values associated with this project.</p>
    */
@@ -1606,7 +1671,7 @@ export interface CreateSegmentRequest {
 
   /**
    * <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">
+   *       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>
    */
   pattern: __LazyJsonString | string | undefined;
@@ -1646,7 +1711,9 @@ export interface Segment {
   name: string | undefined;
 
   /**
-   * <p/>
+   * <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>
    */
   pattern: __LazyJsonString | string | undefined;
 
@@ -2750,6 +2817,17 @@ export interface UpdateProjectRequest {
    */
   project: string | undefined;
 
+  /**
+   * <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>
+   */
+  appConfigResource?: ProjectAppConfigResourceConfig;
+
   /**
    * <p>An optional description of the project.</p>
    */
@@ -3249,6 +3327,13 @@ export const CreateLaunchResponseFilterSensitiveLog = (obj: CreateLaunchResponse
   ...obj,
 });
 
+/**
+ * @internal
+ */
+export const ProjectAppConfigResourceConfigFilterSensitiveLog = (obj: ProjectAppConfigResourceConfig): any => ({
+  ...obj,
+});
+
 /**
  * @internal
  */
@@ -3270,6 +3355,13 @@ export const CreateProjectRequestFilterSensitiveLog = (obj: CreateProjectRequest
   ...obj,
 });
 
+/**
+ * @internal
+ */
+export const ProjectAppConfigResourceFilterSensitiveLog = (obj: ProjectAppConfigResource): any => ({
+  ...obj,
+});
+
 /**
  * @internal
  */

clients/client-evidently/src/protocols/Aws_restJson1.ts

@@ -115,6 +115,8 @@ import {
   OnlineAbConfig,
   OnlineAbDefinition,
   Project,
+  ProjectAppConfigResource,
+  ProjectAppConfigResourceConfig,
   ProjectDataDelivery,
   ProjectDataDeliveryConfig,
   ProjectSummary,
@@ -297,6 +299,9 @@ export const serializeAws_restJson1CreateProjectCommand = async (
   const resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/projects";
   let body: any;
   body = JSON.stringify({
+    ...(input.appConfigResource != null && {
+      appConfigResource: serializeAws_restJson1ProjectAppConfigResourceConfig(input.appConfigResource, context),
+    }),
     ...(input.dataDelivery != null && {
       dataDelivery: serializeAws_restJson1ProjectDataDeliveryConfig(input.dataDelivery, context),
     }),
@@ -1151,6 +1156,9 @@ export const serializeAws_restJson1UpdateProjectCommand = async (
   resolvedPath = __resolvedPath(resolvedPath, input, "project", () => input.project!, "{project}", false);
   let body: any;
   body = JSON.stringify({
+    ...(input.appConfigResource != null && {
+      appConfigResource: serializeAws_restJson1ProjectAppConfigResourceConfig(input.appConfigResource, context),
+    }),
     ...(input.description != null && { description: input.description }),
   });
   return new __HttpRequest({
@@ -3475,6 +3483,16 @@ const serializeAws_restJson1OnlineAbConfig = (input: OnlineAbConfig, context: __
   };
 };
 
+const serializeAws_restJson1ProjectAppConfigResourceConfig = (
+  input: ProjectAppConfigResourceConfig,
+  context: __SerdeContext
+): any => {
+  return {
+    ...(input.applicationId != null && { applicationId: input.applicationId }),
+    ...(input.environmentId != null && { environmentId: input.environmentId }),
+  };
+};
+
 const serializeAws_restJson1ProjectDataDeliveryConfig = (
   input: ProjectDataDeliveryConfig,
   context: __SerdeContext
@@ -4057,6 +4075,10 @@ const deserializeAws_restJson1Project = (output: any, context: __SerdeContext):
   return {
     activeExperimentCount: __expectLong(output.activeExperimentCount),
     activeLaunchCount: __expectLong(output.activeLaunchCount),
+    appConfigResource:
+      output.appConfigResource != null
+        ? deserializeAws_restJson1ProjectAppConfigResource(output.appConfigResource, context)
+        : undefined,
     arn: __expectString(output.arn),
     createdTime:
       output.createdTime != null
@@ -4080,6 +4102,17 @@ const deserializeAws_restJson1Project = (output: any, context: __SerdeContext):
   } as any;
 };
 
+const deserializeAws_restJson1ProjectAppConfigResource = (
+  output: any,
+  context: __SerdeContext
+): ProjectAppConfigResource => {
+  return {
+    applicationId: __expectString(output.applicationId),
+    configurationProfileId: __expectString(output.configurationProfileId),
+    environmentId: __expectString(output.environmentId),
+  } as any;
+};
+
 const deserializeAws_restJson1ProjectDataDelivery = (output: any, context: __SerdeContext): ProjectDataDelivery => {
   return {
     cloudWatchLogs: