You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Evidently

Inherits:
AWS.Service show all
Identifier:
evidently
API Version:
2021-02-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

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.

Sending a Request Using Evidently

var evidently = new AWS.Evidently();
evidently.batchEvaluateFeature(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Evidently object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var evidently = new AWS.Evidently({apiVersion: '2021-02-01'});

You can also set the API version globally in AWS.config.apiVersions using the evidently service identifier:

AWS.config.apiVersions = {
  evidently: '2021-02-01',
  // other service API versions
};

var evidently = new AWS.Evidently();

Version:

  • 2021-02-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Evidently(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Evidently object

var evidently = new AWS.Evidently({apiVersion: '2021-02-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Evidently.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Evidently.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Evidently.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

batchEvaluateFeature(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the batchEvaluateFeature operation

var params = {
  project: 'STRING_VALUE', /* required */
  requests: [ /* required */
    {
      entityId: 'STRING_VALUE', /* required */
      feature: 'STRING_VALUE', /* required */
      evaluationContext: any /* This value will be JSON encoded on your behalf with JSON.stringify() */
    },
    /* more items */
  ]
};
evidently.batchEvaluateFeature(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • project — (String)

      The name or ARN of the project that contains the feature being evaluated.

    • requests — (Array<map>)

      An array of structures, where each structure assigns a feature variation to one user session.

      • entityIdrequired — (String)

        An internal ID that represents a unique user session of the application. This entityID is checked against any override rules assigned for this feature.

      • evaluationContext — (String)

        A JSON block of attributes that you can optionally pass in. This JSON block is included in the evaluation events sent to Evidently from the user session.

      • featurerequired — (String)

        The name of the feature being evaluated.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • results — (Array<map>)

        An array of structures, where each structure displays the results of one feature evaluation assignment to one user session.

        • details — (String)

          If this user was assigned to a launch or experiment, this field lists the launch or experiment name.

        • entityIdrequired — (String)

          An internal ID that represents a unique user session of the application.

        • featurerequired — (String)

          The name of the feature being evaluated.

        • project — (String)

          The name or ARN of the project that contains the feature being evaluated.

        • reason — (String)

          Specifies the reason that the user session was assigned this variation. Possible values include DEFAULT, meaning the user was served the default variation; LAUNCH_RULE_MATCH, if the user session was enrolled in a launch; or EXPERIMENT_RULE_MATCH, if the user session was enrolled in an experiment.

        • value — (map)

          The value assigned to this variation to differentiate it from the other variations of this feature.

          • boolValue — (Boolean)

            If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.

          • doubleValue — (Float)

            If this feature uses the double integer variation type, this field contains the double integer value of this variation.

          • longValue — (Integer)

            If this feature uses the long variation type, this field contains the long value of this variation.

          • stringValue — (String)

            If this feature uses the string variation type, this field contains the string value of this variation.

        • variation — (String)

          The name of the variation that was served to the user session.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createExperiment(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createExperiment operation

var params = {
  metricGoals: [ /* required */
    {
      metricDefinition: { /* required */
        entityIdKey: 'STRING_VALUE', /* required */
        name: 'STRING_VALUE', /* required */
        valueKey: 'STRING_VALUE', /* required */
        eventPattern: any /* This value will be JSON encoded on your behalf with JSON.stringify() */,
        unitLabel: 'STRING_VALUE'
      },
      desiredChange: INCREASE | DECREASE
    },
    /* more items */
  ],
  name: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE', /* required */
  treatments: [ /* required */
    {
      feature: 'STRING_VALUE', /* required */
      name: 'STRING_VALUE', /* required */
      variation: 'STRING_VALUE', /* required */
      description: 'STRING_VALUE'
    },
    /* more items */
  ],
  description: 'STRING_VALUE',
  onlineAbConfig: {
    controlTreatmentName: 'STRING_VALUE',
    treatmentWeights: {
      '<TreatmentName>': 'NUMBER_VALUE',
      /* '<TreatmentName>': ... */
    }
  },
  randomizationSalt: 'STRING_VALUE',
  samplingRate: 'NUMBER_VALUE',
  segment: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
evidently.createExperiment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • description — (String)

      An optional description of the experiment.

    • metricGoals — (Array<map>)

      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.

      • desiredChange — (String)

        INCREASE means that a variation with a higher number for this metric is performing better.

        DECREASE means that a variation with a lower number for this metric is performing better.

        Possible values include:
        • "INCREASE"
        • "DECREASE"
      • metricDefinitionrequired — (map)

        A structure that contains details about the metric.

        • entityIdKeyrequired — (String)

          The entity, such as a user or session, that does an action that causes a metric value to be recorded. An example is userDetails.userID.

        • eventPattern — (String)

          The EventBridge event pattern that defines how the metric is recorded.

          For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

        • namerequired — (String)

          A name for the metric.

        • unitLabel — (String)

          A label for the units that the metric is measuring.

        • valueKeyrequired — (String)

          The value that is tracked to produce the metric.

    • name — (String)

      A name for the new experiment.

    • onlineAbConfig — (map)

      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.

      • controlTreatmentName — (String)

        The name of the variation that is to be the default variation that the other variations are compared to.

      • treatmentWeights — (map<Integer>)

        A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

    • project — (String)

      The name or ARN of the project that you want to create the new experiment in.

    • randomizationSalt — (String)

      When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the experiment name as the randomizationSalt.

    • samplingRate — (Integer)

      The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

      This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.

    • segment — (String)

      Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.

    • tags — (map<String>)

      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.

       <p>You can associate as many as 50 tags with an experiment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws&#95;tagging.html&quot;&gt;Tagging Amazon Web Services resources</a>.</p> 
    • treatments — (Array<map>)

      An array of structures that describe the configuration of each feature variation used in the experiment.

      • description — (String)

        A description for this treatment.

      • featurerequired — (String)

        The feature that this experiment is testing.

      • namerequired — (String)

        A name for this treatment.

      • variationrequired — (String)

        The name of the variation to use as this treatment in the experiment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • experiment — (map)

        A structure containing the configuration details of the experiment that you created.

        • arnrequired — (String)

          The ARN of the experiment.

        • createdTimerequired — (Date)

          The date and time that the experiment is first created.

        • description — (String)

          A description of the experiment.

        • execution — (map)

          A structure that contains the date and time that the experiment started and ended.

          • endedTime — (Date)

            The date and time that the experiment ended.

          • startedTime — (Date)

            The date and time that the experiment started.

        • lastUpdatedTimerequired — (Date)

          The date and time that the experiment was most recently updated.

        • metricGoals — (Array<map>)

          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.

          • desiredChange — (String)

            INCREASE means that a variation with a higher number for this metric is performing better.

            DECREASE means that a variation with a lower number for this metric is performing better.

            Possible values include:
            • "INCREASE"
            • "DECREASE"
          • metricDefinitionrequired — (map)

            A structure that contains details about the metric.

            • entityIdKey — (String)

              The entity, such as a user or session, that does an action that causes a metric value to be recorded.

            • eventPattern — (String)

              The EventBridge event pattern that defines how the metric is recorded.

              For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

            • name — (String)

              The name of the metric.

            • unitLabel — (String)

              The label for the units that the metric is measuring.

            • valueKey — (String)

              The value that is tracked to produce the metric.

        • namerequired — (String)

          The name of the experiment.

        • onlineAbDefinition — (map)

          A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

          • controlTreatmentName — (String)

            The name of the variation that is the default variation that the other variations are compared to.

          • treatmentWeights — (map<Integer>)

            A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. The traffic portion is specified in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

        • project — (String)

          The name or ARN of the project that contains this experiment.

        • randomizationSalt — (String)

          This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.

        • samplingRate — (Integer)

          In thousandths of a percent, the amount of the available audience that is allocated to this experiment. 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, so a value of 10,000 is 10% of the available audience.

        • schedule — (map)

          A structure that contains the time and date that Evidently completed the analysis of the experiment.

          • analysisCompleteTime — (Date)

            The time and date that Evidently completed the analysis of the experiment.

        • segment — (String)

          The audience segment being used for the experiment, if a segment is being used.

        • statusrequired — (String)

          The current state of the experiment.

          Possible values include:
          • "CREATED"
          • "UPDATING"
          • "RUNNING"
          • "COMPLETED"
          • "CANCELLED"
        • statusReason — (String)

          If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.

        • tags — (map<String>)

          The list of tag keys and values associated with this experiment.

        • treatments — (Array<map>)

          An array of structures that describe the configuration of each feature variation used in the experiment.

          • description — (String)

            The description of the treatment.

          • featureVariations — (map<String>)

            The feature variation used for this treatment. This is a key-value pair. The key is the feature name, and the value is the variation name.

          • namerequired — (String)

            The name of this treatment.

        • typerequired — (String)

          The type of this experiment. Currently, this value must be aws.experiment.onlineab.

          Possible values include:
          • "aws.evidently.onlineab"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createFeature(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createFeature operation

var params = {
  name: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE', /* required */
  variations: [ /* required */
    {
      name: 'STRING_VALUE', /* required */
      value: { /* required */
        boolValue: true || false,
        doubleValue: 'NUMBER_VALUE',
        longValue: 'NUMBER_VALUE',
        stringValue: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  defaultVariation: 'STRING_VALUE',
  description: 'STRING_VALUE',
  entityOverrides: {
    '<EntityId>': 'STRING_VALUE',
    /* '<EntityId>': ... */
  },
  evaluationStrategy: ALL_RULES | DEFAULT_VARIATION,
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
evidently.createFeature(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • defaultVariation — (String)

      The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

      This variation must also be listed in the variations structure.

      If you omit defaultVariation, the first variation listed in the variations structure is used as the default variation.

    • description — (String)

      An optional description of the feature.

    • entityOverrides — (map<String>)

      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.

    • evaluationStrategy — (String)

      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.

      Possible values include:
      • "ALL_RULES"
      • "DEFAULT_VARIATION"
    • name — (String)

      The name for the new feature.

    • project — (String)

      The name or ARN of the project that is to contain the new feature.

    • tags — (map<String>)

      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.

       <p>You can associate as many as 50 tags with a feature.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws&#95;tagging.html&quot;&gt;Tagging Amazon Web Services resources</a>.</p> 
    • variations — (Array<map>)

      An array of structures that contain the configuration of the feature's different variations.

      • namerequired — (String)

        The name of the variation.

      • valuerequired — (map)

        The value assigned to this variation.

        • boolValue — (Boolean)

          If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.

        • doubleValue — (Float)

          If this feature uses the double integer variation type, this field contains the double integer value of this variation.

        • longValue — (Integer)

          If this feature uses the long variation type, this field contains the long value of this variation.

        • stringValue — (String)

          If this feature uses the string variation type, this field contains the string value of this variation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • feature — (map)

        A structure that contains information about the new feature.

        • arnrequired — (String)

          The ARN of the feature.

        • createdTimerequired — (Date)

          The date and time that the feature is created.

        • defaultVariation — (String)

          The name of the variation that is used as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

          This variation must also be listed in the variations structure.

          If you omit defaultVariation, the first variation listed in the variations structure is used as the default variation.

        • description — (String)

          The description of the feature.

        • entityOverrides — (map<String>)

          A set of key-value pairs that specify users who should always be served a specific variation of a feature. Each key specifies a user using their user ID, account ID, or some other identifier. The value specifies the name of the variation that the user is to be served.

          For the override to be successful, the value of the key must match the entityId used in the EvaluateFeature operation.

        • evaluationRules — (Array<map>)

          An array of structures that define the evaluation rules for the feature.

          • name — (String)

            The name of the experiment or launch.

          • typerequired — (String)

            This value is aws.evidently.splits if this is an evaluation rule for a launch, and it is aws.evidently.onlineab if this is an evaluation rule for an experiment.

        • evaluationStrategyrequired — (String)

          If this value is ALL_RULES, the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION, the default variation is being served to all users.

          Possible values include:
          • "ALL_RULES"
          • "DEFAULT_VARIATION"
        • lastUpdatedTimerequired — (Date)

          The date and time that the feature was most recently updated.

        • namerequired — (String)

          The name of the feature.

        • project — (String)

          The name or ARN of the project that contains the feature.

        • statusrequired — (String)

          The current state of the feature.

          Possible values include:
          • "AVAILABLE"
          • "UPDATING"
        • tags — (map<String>)

          The list of tag keys and values associated with this feature.

        • valueTyperequired — (String)

          Defines the type of value used to define the different feature variations. For more information, see Variation types

          Possible values include:
          • "STRING"
          • "LONG"
          • "DOUBLE"
          • "BOOLEAN"
        • variationsrequired — (Array<map>)

          An array of structures that contain the configuration of the feature's different variations.

          • name — (String)

            The name of the variation.

          • value — (map)

            The value assigned to this variation.

            • boolValue — (Boolean)

              If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.

            • doubleValue — (Float)

              If this feature uses the double integer variation type, this field contains the double integer value of this variation.

            • longValue — (Integer)

              If this feature uses the long variation type, this field contains the long value of this variation.

            • stringValue — (String)

              If this feature uses the string variation type, this field contains the string value of this variation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createLaunch(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createLaunch operation

var params = {
  groups: [ /* required */
    {
      feature: 'STRING_VALUE', /* required */
      name: 'STRING_VALUE', /* required */
      variation: 'STRING_VALUE', /* required */
      description: 'STRING_VALUE'
    },
    /* more items */
  ],
  name: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  metricMonitors: [
    {
      metricDefinition: { /* required */
        entityIdKey: 'STRING_VALUE', /* required */
        name: 'STRING_VALUE', /* required */
        valueKey: 'STRING_VALUE', /* required */
        eventPattern: any /* This value will be JSON encoded on your behalf with JSON.stringify() */,
        unitLabel: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  randomizationSalt: 'STRING_VALUE',
  scheduledSplitsConfig: {
    steps: [ /* required */
      {
        groupWeights: { /* required */
          '<GroupName>': 'NUMBER_VALUE',
          /* '<GroupName>': ... */
        },
        startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
        segmentOverrides: [
          {
            evaluationOrder: 'NUMBER_VALUE', /* required */
            segment: 'STRING_VALUE', /* required */
            weights: { /* required */
              '<GroupName>': 'NUMBER_VALUE',
              /* '<GroupName>': ... */
            }
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
evidently.createLaunch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • description — (String)

      An optional description for the launch.

    • groups — (Array<map>)

      An array of structures that contains the feature and variations that are to be used for the launch.

      • description — (String)

        A description of the launch group.

      • featurerequired — (String)

        The feature that this launch is using.

      • namerequired — (String)

        A name for this launch group.

      • variationrequired — (String)

        The feature variation to use for this launch group.

    • metricMonitors — (Array<map>)

      An array of structures that define the metrics that will be used to monitor the launch performance.

      • metricDefinitionrequired — (map)

        A structure that defines the metric.

        • entityIdKeyrequired — (String)

          The entity, such as a user or session, that does an action that causes a metric value to be recorded. An example is userDetails.userID.

        • eventPattern — (String)

          The EventBridge event pattern that defines how the metric is recorded.

          For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

        • namerequired — (String)

          A name for the metric.

        • unitLabel — (String)

          A label for the units that the metric is measuring.

        • valueKeyrequired — (String)

          The value that is tracked to produce the metric.

    • name — (String)

      The name for the new launch.

    • project — (String)

      The name or ARN of the project that you want to create the launch in.

    • randomizationSalt — (String)

      When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the launch name as the randomizationSalt.

    • scheduledSplitsConfig — (map)

      An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

      • stepsrequired — (Array<map>)

        An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

        • groupWeightsrequired — (map<Integer>)

          The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

           <p>The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.</p> <p>If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.</p> 
        • segmentOverrides — (Array<map>)

          Use this parameter to specify different traffic splits for one or more audience segments. 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.

          This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.

          • evaluationOrderrequired — (Integer)

            A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.

          • segmentrequired — (String)

            The ARN of the segment to use.

          • weightsrequired — (map<Integer>)

            The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.

        • startTimerequired — (Date)

          The date and time that this step of the launch starts.

    • tags — (map<String>)

      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.

       <p>You can associate as many as 50 tags with a launch.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws&#95;tagging.html&quot;&gt;Tagging Amazon Web Services resources</a>.</p> 

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • launch — (map)

        A structure that contains the configuration of the launch that was created.

        • arnrequired — (String)

          The ARN of the launch.

        • createdTimerequired — (Date)

          The date and time that the launch is created.

        • description — (String)

          The description of the launch.

        • execution — (map)

          A structure that contains information about the start and end times of the launch.

          • endedTime — (Date)

            The date and time that the launch ended.

          • startedTime — (Date)

            The date and time that the launch started.

        • groups — (Array<map>)

          An array of structures that define the feature variations that are being used in the launch.

          • description — (String)

            A description of the launch group.

          • featureVariationsrequired — (map<String>)

            The feature variation for this launch group. This is a key-value pair.

          • namerequired — (String)

            The name of the launch group.

        • lastUpdatedTimerequired — (Date)

          The date and time that the launch was most recently updated.

        • metricMonitors — (Array<map>)

          An array of structures that define the metrics that are being used to monitor the launch performance.

          • metricDefinitionrequired — (map)

            A structure that defines the metric.

            • entityIdKey — (String)

              The entity, such as a user or session, that does an action that causes a metric value to be recorded.

            • eventPattern — (String)

              The EventBridge event pattern that defines how the metric is recorded.

              For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

            • name — (String)

              The name of the metric.

            • unitLabel — (String)

              The label for the units that the metric is measuring.

            • valueKey — (String)

              The value that is tracked to produce the metric.

        • namerequired — (String)

          The name of the launch.

        • project — (String)

          The name or ARN of the project that contains the launch.

        • randomizationSalt — (String)

          This value is used when Evidently assigns a particular user session to the launch, to help create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.

        • scheduledSplitsDefinition — (map)

          An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

          • steps — (Array<map>)

            An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

            • groupWeights — (map<Integer>)

              The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

              The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.

              If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.

            • segmentOverrides — (Array<map>)

              Use this parameter to specify different traffic splits for one or more audience segments. 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.

              This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.

              • evaluationOrderrequired — (Integer)

                A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.

              • segmentrequired — (String)

                The ARN of the segment to use.

              • weightsrequired — (map<Integer>)

                The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.

            • startTimerequired — (Date)

              The date and time that this step of the launch starts.

        • statusrequired — (String)

          The current state of the launch.

          Possible values include:
          • "CREATED"
          • "UPDATING"
          • "RUNNING"
          • "COMPLETED"
          • "CANCELLED"
        • statusReason — (String)

          If the launch was stopped, this is the string that was entered by the person who stopped the launch, to explain why it was stopped.

        • tags — (map<String>)

          The list of tag keys and values associated with this launch.

        • typerequired — (String)

          The type of launch.

          Possible values include:
          • "aws.evidently.splits"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createProject(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createProject operation

var params = {
  name: 'STRING_VALUE', /* required */
  appConfigResource: {
    applicationId: 'STRING_VALUE',
    environmentId: 'STRING_VALUE'
  },
  dataDelivery: {
    cloudWatchLogs: {
      logGroup: 'STRING_VALUE'
    },
    s3Destination: {
      bucket: 'STRING_VALUE',
      prefix: 'STRING_VALUE'
    }
  },
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
evidently.createProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appConfigResource — (map)

      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.

      • applicationId — (String)

        The ID of the AppConfig application to use for client-side evaluation.

      • environmentId — (String)

        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 applicationId.

    • dataDelivery — (map)

      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.

      • cloudWatchLogs — (map)

        If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.

        • logGroup — (String)

          The name of the log group where the project stores evaluation events.

      • s3Destination — (map)

        If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

        • bucket — (String)

          The name of the bucket in which Evidently stores evaluation events.

        • prefix — (String)

          The bucket prefix in which Evidently stores evaluation events.

    • description — (String)

      An optional description of the project.

    • name — (String)

      The name for the project.

    • tags — (map<String>)

      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.

       <p>You can associate as many as 50 tags with a project.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws&#95;tagging.html&quot;&gt;Tagging Amazon Web Services resources</a>.</p> 

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • project — (map)

        A structure that contains information about the created project.

        • activeExperimentCount — (Integer)

          The number of ongoing experiments currently in the project.

        • activeLaunchCount — (Integer)

          The number of ongoing launches currently in the project.

        • appConfigResource — (map)

          This structure defines the configuration of how your application integrates with AppConfig to run client-side evaluation.

          • applicationIdrequired — (String)

            The ID of the AppConfig application to use for client-side evaluation.

          • configurationProfileIdrequired — (String)

            The ID of the AppConfig profile to use for client-side evaluation.

          • environmentIdrequired — (String)

            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 applicationId.

        • arnrequired — (String)

          The name or ARN of the project.

        • createdTimerequired — (Date)

          The date and time that the project is created.

        • dataDelivery — (map)

          A structure that contains information about where Evidently is to store evaluation events for longer term storage.

          • cloudWatchLogs — (map)

            If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.

            • logGroup — (String)

              The name of the log group where the project stores evaluation events.

          • s3Destination — (map)

            If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

            • bucket — (String)

              The name of the bucket in which Evidently stores evaluation events.

            • prefix — (String)

              The bucket prefix in which Evidently stores evaluation events.

        • description — (String)

          The user-entered description of the project.

        • experimentCount — (Integer)

          The number of experiments currently in the project. This includes all experiments that have been created and not deleted, whether they are ongoing or not.

        • featureCount — (Integer)

          The number of features currently in the project.

        • lastUpdatedTimerequired — (Date)

          The date and time that the project was most recently updated.

        • launchCount — (Integer)

          The number of launches currently in the project. This includes all launches that have been created and not deleted, whether they are ongoing or not.

        • namerequired — (String)

          The name of the project.

        • statusrequired — (String)

          The current state of the project.

          Possible values include:
          • "AVAILABLE"
          • "UPDATING"
        • tags — (map<String>)

          The list of tag keys and values associated with this project.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createSegment(params = {}, callback) ⇒ AWS.Request

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.

 <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&quot;&gt; 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&#95;EvaluateFeature.html&quot;&gt;EvaluateFeature&lt;/a&gt; operation, when Evidently assigns a feature variation to a user.</p> 

Service Reference:

Examples:

Calling the createSegment operation

var params = {
  name: 'STRING_VALUE', /* required */
  pattern: any /* This value will be JSON encoded on your behalf with JSON.stringify() */, /* required */
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
evidently.createSegment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • description — (String)

      An optional description for this segment.

    • name — (String)

      A name for the segment.

    • pattern — (String)

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

    • tags — (map<String>)

      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.

       <p>You can associate as many as 50 tags with a segment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws&#95;tagging.html&quot;&gt;Tagging Amazon Web Services resources</a>.</p> 

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • segment — (map)

        A structure that contains the complete information about the segment that was just created.

        • arnrequired — (String)

          The ARN of the segment.

        • createdTimerequired — (Date)

          The date and time that this segment was created.

        • description — (String)

          The customer-created description for this segment.

        • experimentCount — (Integer)

          The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.

        • lastUpdatedTimerequired — (Date)

          The date and time that this segment was most recently updated.

        • launchCount — (Integer)

          The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.

        • namerequired — (String)

          The name of the segment.

        • patternrequired — (String)

          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 Segment rule pattern syntax.

        • tags — (map<String>)

          The list of tag keys and values associated with this launch.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteExperiment(params = {}, callback) ⇒ AWS.Request

Deletes an Evidently experiment. The feature used for the experiment is not deleted.

To stop an experiment without deleting it, use StopExperiment.

Service Reference:

Examples:

Calling the deleteExperiment operation

var params = {
  experiment: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE' /* required */
};
evidently.deleteExperiment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • experiment — (String)

      The name of the experiment to delete.

    • project — (String)

      The name or ARN of the project that contains the experiment to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteFeature(params = {}, callback) ⇒ AWS.Request

Deletes an Evidently feature.

Service Reference:

Examples:

Calling the deleteFeature operation

var params = {
  feature: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE' /* required */
};
evidently.deleteFeature(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • feature — (String)

      The name of the feature to delete.

    • project — (String)

      The name or ARN of the project that contains the feature to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteLaunch(params = {}, callback) ⇒ AWS.Request

Deletes an Evidently launch. The feature used for the launch is not deleted.

To stop a launch without deleting it, use StopLaunch.

Service Reference:

Examples:

Calling the deleteLaunch operation

var params = {
  launch: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE' /* required */
};
evidently.deleteLaunch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • launch — (String)

      The name of the launch to delete.

    • project — (String)

      The name or ARN of the project that contains the launch to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteProject(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteProject operation

var params = {
  project: 'STRING_VALUE' /* required */
};
evidently.deleteProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • project — (String)

      The name or ARN of the project to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteSegment(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteSegment operation

var params = {
  segment: 'STRING_VALUE' /* required */
};
evidently.deleteSegment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • segment — (String)

      Specifies the segment to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

evaluateFeature(params = {}, callback) ⇒ AWS.Request

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.

 <p>If there is a current launch with this feature that uses segment overrides, and if the user session's <code>evaluationContext</code> matches a segment rule defined in a segment override, the configuration in the segment overrides is used. For more information about segments, see <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API&#95;CreateSegment.html&quot;&gt;CreateSegment&lt;/a&gt; and <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html&quot;&gt;Use segments to focus your audience</a>.</p> <p>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.</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.</p> <p>If the experiment uses a segment, then only user sessions with <code>evaluationContext</code> values that match the segment rule are used in the experiment.</p> <p>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> 

Service Reference:

Examples:

Calling the evaluateFeature operation

var params = {
  entityId: 'STRING_VALUE', /* required */
  feature: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE', /* required */
  evaluationContext: any /* This value will be JSON encoded on your behalf with JSON.stringify() */
};
evidently.evaluateFeature(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • entityId — (String)

      An internal ID that represents a unique user of the application. This entityID is checked against any override rules assigned for this feature.

    • evaluationContext — (String)

      A JSON object of attributes that you can optionally pass in as part of the evaluation event sent to Evidently from the user session. Evidently can use this value to match user sessions with defined audience segments. For more information, see Use segments to focus your audience.

       <p>If you include this parameter, the value must be a JSON object. A JSON array is not supported.</p> 
    • feature — (String)

      The name of the feature being evaluated.

    • project — (String)

      The name or ARN of the project that contains this feature.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • details — (String)

        If this user was assigned to a launch or experiment, this field lists the launch or experiment name.

      • reason — (String)

        Specifies the reason that the user session was assigned this variation. Possible values include DEFAULT, meaning the user was served the default variation; LAUNCH_RULE_MATCH, if the user session was enrolled in a launch; EXPERIMENT_RULE_MATCH, if the user session was enrolled in an experiment; or ENTITY_OVERRIDES_MATCH, if the user's entityId matches an override rule.

      • value — (map)

        The value assigned to this variation to differentiate it from the other variations of this feature.

        • boolValue — (Boolean)

          If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.

        • doubleValue — (Float)

          If this feature uses the double integer variation type, this field contains the double integer value of this variation.

        • longValue — (Integer)

          If this feature uses the long variation type, this field contains the long value of this variation.

        • stringValue — (String)

          If this feature uses the string variation type, this field contains the string value of this variation.

      • variation — (String)

        The name of the variation that was served to the user session.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getExperiment(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getExperiment operation

var params = {
  experiment: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE' /* required */
};
evidently.getExperiment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • experiment — (String)

      The name of the experiment that you want to see the details of.

    • project — (String)

      The name or ARN of the project that contains the experiment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • experiment — (map)

        A structure containing the configuration details of the experiment.

        • arnrequired — (String)

          The ARN of the experiment.

        • createdTimerequired — (Date)

          The date and time that the experiment is first created.

        • description — (String)

          A description of the experiment.

        • execution — (map)

          A structure that contains the date and time that the experiment started and ended.

          • endedTime — (Date)

            The date and time that the experiment ended.

          • startedTime — (Date)

            The date and time that the experiment started.

        • lastUpdatedTimerequired — (Date)

          The date and time that the experiment was most recently updated.

        • metricGoals — (Array<map>)

          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.

          • desiredChange — (String)

            INCREASE means that a variation with a higher number for this metric is performing better.

            DECREASE means that a variation with a lower number for this metric is performing better.

            Possible values include:
            • "INCREASE"
            • "DECREASE"
          • metricDefinitionrequired — (map)

            A structure that contains details about the metric.

            • entityIdKey — (String)

              The entity, such as a user or session, that does an action that causes a metric value to be recorded.

            • eventPattern — (String)

              The EventBridge event pattern that defines how the metric is recorded.

              For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

            • name — (String)

              The name of the metric.

            • unitLabel — (String)

              The label for the units that the metric is measuring.

            • valueKey — (String)

              The value that is tracked to produce the metric.

        • namerequired — (String)

          The name of the experiment.

        • onlineAbDefinition — (map)

          A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

          • controlTreatmentName — (String)

            The name of the variation that is the default variation that the other variations are compared to.

          • treatmentWeights — (map<Integer>)

            A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. The traffic portion is specified in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

        • project — (String)

          The name or ARN of the project that contains this experiment.

        • randomizationSalt — (String)

          This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.

        • samplingRate — (Integer)

          In thousandths of a percent, the amount of the available audience that is allocated to this experiment. 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, so a value of 10,000 is 10% of the available audience.

        • schedule — (map)

          A structure that contains the time and date that Evidently completed the analysis of the experiment.

          • analysisCompleteTime — (Date)

            The time and date that Evidently completed the analysis of the experiment.

        • segment — (String)

          The audience segment being used for the experiment, if a segment is being used.

        • statusrequired — (String)

          The current state of the experiment.

          Possible values include:
          • "CREATED"
          • "UPDATING"
          • "RUNNING"
          • "COMPLETED"
          • "CANCELLED"
        • statusReason — (String)

          If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.

        • tags — (map<String>)

          The list of tag keys and values associated with this experiment.

        • treatments — (Array<map>)

          An array of structures that describe the configuration of each feature variation used in the experiment.

          • description — (String)

            The description of the treatment.

          • featureVariations — (map<String>)

            The feature variation used for this treatment. This is a key-value pair. The key is the feature name, and the value is the variation name.

          • namerequired — (String)

            The name of this treatment.

        • typerequired — (String)

          The type of this experiment. Currently, this value must be aws.experiment.onlineab.

          Possible values include:
          • "aws.evidently.onlineab"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getExperimentResults(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getExperimentResults operation

var params = {
  experiment: 'STRING_VALUE', /* required */
  metricNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  project: 'STRING_VALUE', /* required */
  treatmentNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  baseStat: Mean,
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  period: 'NUMBER_VALUE',
  reportNames: [
    BayesianInference,
    /* more items */
  ],
  resultStats: [
    BaseStat | TreatmentEffect | ConfidenceInterval | PValue,
    /* more items */
  ],
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
evidently.getExperimentResults(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • baseStat — (String)

      The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.

      Possible values include:
      • "Mean"
    • endTime — (Date)

      The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.

    • experiment — (String)

      The name of the experiment to retrieve the results of.

    • metricNames — (Array<String>)

      The names of the experiment metrics that you want to see the results of.

    • period — (Integer)

      In seconds, the amount of time to aggregate results together.

    • project — (String)

      The name or ARN of the project that contains the experiment that you want to see the results of.

    • reportNames — (Array<String>)

      The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

    • resultStats — (Array<String>)

      The statistics that you want to see in the returned results.

      • PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

      • ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

      • TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

      • BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

    • startTime — (Date)

      The date and time that the experiment started.

    • treatmentNames — (Array<String>)

      The names of the experiment treatments that you want to see the results for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • details — (String)

        If the experiment doesn't yet have enough events to provide valid results, this field is returned with the message Not enough events to generate results. If there are enough events to provide valid results, this field is not returned.

      • reports — (Array<map>)

        An array of structures that include the reports that you requested.

        • content — (String)

          The content of the report.

        • metricName — (String)

          The name of the metric that is analyzed in this experiment report.

        • reportName — (String)

          The type of analysis used for this report.

          Possible values include:
          • "BayesianInference"
        • treatmentName — (String)

          The name of the variation that this report pertains to.

      • resultsData — (Array<map>)

        An array of structures that include experiment results including metric names and values.

        • metricName — (String)

          The name of the metric.

        • resultStat — (String)

          The experiment statistic that these results pertain to.

          Possible values include:
          • "Mean"
          • "TreatmentEffect"
          • "ConfidenceIntervalUpperBound"
          • "ConfidenceIntervalLowerBound"
          • "PValue"
        • treatmentName — (String)

          The treatment, or variation, that returned the values in this structure.

        • values — (Array<Float>)

          The values for the metricName that were recorded in the experiment.

      • timestamps — (Array<Date>)

        The timestamps of each result returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getFeature(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getFeature operation

var params = {
  feature: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE' /* required */
};
evidently.getFeature(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • feature — (String)

      The name of the feature that you want to retrieve information for.

    • project — (String)

      The name or ARN of the project that contains the feature.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • feature — (map)

        A structure containing the configuration details of the feature.

        • arnrequired — (String)

          The ARN of the feature.

        • createdTimerequired — (Date)

          The date and time that the feature is created.

        • defaultVariation — (String)

          The name of the variation that is used as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

          This variation must also be listed in the variations structure.

          If you omit defaultVariation, the first variation listed in the variations structure is used as the default variation.

        • description — (String)

          The description of the feature.

        • entityOverrides — (map<String>)

          A set of key-value pairs that specify users who should always be served a specific variation of a feature. Each key specifies a user using their user ID, account ID, or some other identifier. The value specifies the name of the variation that the user is to be served.

          For the override to be successful, the value of the key must match the entityId used in the EvaluateFeature operation.

        • evaluationRules — (Array<map>)

          An array of structures that define the evaluation rules for the feature.

          • name — (String)

            The name of the experiment or launch.

          • typerequired — (String)

            This value is aws.evidently.splits if this is an evaluation rule for a launch, and it is aws.evidently.onlineab if this is an evaluation rule for an experiment.

        • evaluationStrategyrequired — (String)

          If this value is ALL_RULES, the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION, the default variation is being served to all users.

          Possible values include:
          • "ALL_RULES"
          • "DEFAULT_VARIATION"
        • lastUpdatedTimerequired — (Date)

          The date and time that the feature was most recently updated.

        • namerequired — (String)

          The name of the feature.

        • project — (String)

          The name or ARN of the project that contains the feature.

        • statusrequired — (String)

          The current state of the feature.

          Possible values include:
          • "AVAILABLE"
          • "UPDATING"
        • tags — (map<String>)

          The list of tag keys and values associated with this feature.

        • valueTyperequired — (String)

          Defines the type of value used to define the different feature variations. For more information, see Variation types

          Possible values include:
          • "STRING"
          • "LONG"
          • "DOUBLE"
          • "BOOLEAN"
        • variationsrequired — (Array<map>)

          An array of structures that contain the configuration of the feature's different variations.

          • name — (String)

            The name of the variation.

          • value — (map)

            The value assigned to this variation.

            • boolValue — (Boolean)

              If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.

            • doubleValue — (Float)

              If this feature uses the double integer variation type, this field contains the double integer value of this variation.

            • longValue — (Integer)

              If this feature uses the long variation type, this field contains the long value of this variation.

            • stringValue — (String)

              If this feature uses the string variation type, this field contains the string value of this variation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getLaunch(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getLaunch operation

var params = {
  launch: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE' /* required */
};
evidently.getLaunch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • launch — (String)

      The name of the launch that you want to see the details of.

    • project — (String)

      The name or ARN of the project that contains the launch.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • launch — (map)

        A structure containing the configuration details of the launch.

        • arnrequired — (String)

          The ARN of the launch.

        • createdTimerequired — (Date)

          The date and time that the launch is created.

        • description — (String)

          The description of the launch.

        • execution — (map)

          A structure that contains information about the start and end times of the launch.

          • endedTime — (Date)

            The date and time that the launch ended.

          • startedTime — (Date)

            The date and time that the launch started.

        • groups — (Array<map>)

          An array of structures that define the feature variations that are being used in the launch.

          • description — (String)

            A description of the launch group.

          • featureVariationsrequired — (map<String>)

            The feature variation for this launch group. This is a key-value pair.

          • namerequired — (String)

            The name of the launch group.

        • lastUpdatedTimerequired — (Date)

          The date and time that the launch was most recently updated.

        • metricMonitors — (Array<map>)

          An array of structures that define the metrics that are being used to monitor the launch performance.

          • metricDefinitionrequired — (map)

            A structure that defines the metric.

            • entityIdKey — (String)

              The entity, such as a user or session, that does an action that causes a metric value to be recorded.

            • eventPattern — (String)

              The EventBridge event pattern that defines how the metric is recorded.

              For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

            • name — (String)

              The name of the metric.

            • unitLabel — (String)

              The label for the units that the metric is measuring.

            • valueKey — (String)

              The value that is tracked to produce the metric.

        • namerequired — (String)

          The name of the launch.

        • project — (String)

          The name or ARN of the project that contains the launch.

        • randomizationSalt — (String)

          This value is used when Evidently assigns a particular user session to the launch, to help create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.

        • scheduledSplitsDefinition — (map)

          An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

          • steps — (Array<map>)

            An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

            • groupWeights — (map<Integer>)

              The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

              The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.

              If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.

            • segmentOverrides — (Array<map>)

              Use this parameter to specify different traffic splits for one or more audience segments. 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.

              This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.

              • evaluationOrderrequired — (Integer)

                A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.

              • segmentrequired — (String)

                The ARN of the segment to use.

              • weightsrequired — (map<Integer>)

                The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.

            • startTimerequired — (Date)

              The date and time that this step of the launch starts.

        • statusrequired — (String)

          The current state of the launch.

          Possible values include:
          • "CREATED"
          • "UPDATING"
          • "RUNNING"
          • "COMPLETED"
          • "CANCELLED"
        • statusReason — (String)

          If the launch was stopped, this is the string that was entered by the person who stopped the launch, to explain why it was stopped.

        • tags — (map<String>)

          The list of tag keys and values associated with this launch.

        • typerequired — (String)

          The type of launch.

          Possible values include:
          • "aws.evidently.splits"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getProject(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getProject operation

var params = {
  project: 'STRING_VALUE' /* required */
};
evidently.getProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • project — (String)

      The name or ARN of the project that you want to see the details of.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • project — (map)

        A structure containing the configuration details of the project.

        • activeExperimentCount — (Integer)

          The number of ongoing experiments currently in the project.

        • activeLaunchCount — (Integer)

          The number of ongoing launches currently in the project.

        • appConfigResource — (map)

          This structure defines the configuration of how your application integrates with AppConfig to run client-side evaluation.

          • applicationIdrequired — (String)

            The ID of the AppConfig application to use for client-side evaluation.

          • configurationProfileIdrequired — (String)

            The ID of the AppConfig profile to use for client-side evaluation.

          • environmentIdrequired — (String)

            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 applicationId.

        • arnrequired — (String)

          The name or ARN of the project.

        • createdTimerequired — (Date)

          The date and time that the project is created.

        • dataDelivery — (map)

          A structure that contains information about where Evidently is to store evaluation events for longer term storage.

          • cloudWatchLogs — (map)

            If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.

            • logGroup — (String)

              The name of the log group where the project stores evaluation events.

          • s3Destination — (map)

            If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

            • bucket — (String)

              The name of the bucket in which Evidently stores evaluation events.

            • prefix — (String)

              The bucket prefix in which Evidently stores evaluation events.

        • description — (String)

          The user-entered description of the project.

        • experimentCount — (Integer)

          The number of experiments currently in the project. This includes all experiments that have been created and not deleted, whether they are ongoing or not.

        • featureCount — (Integer)

          The number of features currently in the project.

        • lastUpdatedTimerequired — (Date)

          The date and time that the project was most recently updated.

        • launchCount — (Integer)

          The number of launches currently in the project. This includes all launches that have been created and not deleted, whether they are ongoing or not.

        • namerequired — (String)

          The name of the project.

        • statusrequired — (String)

          The current state of the project.

          Possible values include:
          • "AVAILABLE"
          • "UPDATING"
        • tags — (map<String>)

          The list of tag keys and values associated with this project.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSegment(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getSegment operation

var params = {
  segment: 'STRING_VALUE' /* required */
};
evidently.getSegment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • segment — (String)

      The ARN of the segment to return information for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • segment — (map)

        A structure that contains the complete information about the segment.

        • arnrequired — (String)

          The ARN of the segment.

        • createdTimerequired — (Date)

          The date and time that this segment was created.

        • description — (String)

          The customer-created description for this segment.

        • experimentCount — (Integer)

          The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.

        • lastUpdatedTimerequired — (Date)

          The date and time that this segment was most recently updated.

        • launchCount — (Integer)

          The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.

        • namerequired — (String)

          The name of the segment.

        • patternrequired — (String)

          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 Segment rule pattern syntax.

        • tags — (map<String>)

          The list of tag keys and values associated with this launch.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listExperiments(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listExperiments operation

var params = {
  project: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  status: CREATED | UPDATING | RUNNING | COMPLETED | CANCELLED
};
evidently.listExperiments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of results to include in the response.

    • nextToken — (String)

      The token to use when requesting the next set of results. You received this token from a previous ListExperiments operation.

    • project — (String)

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

    • status — (String)

      Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.

      Possible values include:
      • "CREATED"
      • "UPDATING"
      • "RUNNING"
      • "COMPLETED"
      • "CANCELLED"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • experiments — (Array<map>)

        An array of structures that contain the configuration details of the experiments in the specified project.

        • arnrequired — (String)

          The ARN of the experiment.

        • createdTimerequired — (Date)

          The date and time that the experiment is first created.

        • description — (String)

          A description of the experiment.

        • execution — (map)

          A structure that contains the date and time that the experiment started and ended.

          • endedTime — (Date)

            The date and time that the experiment ended.

          • startedTime — (Date)

            The date and time that the experiment started.

        • lastUpdatedTimerequired — (Date)

          The date and time that the experiment was most recently updated.

        • metricGoals — (Array<map>)

          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.

          • desiredChange — (String)

            INCREASE means that a variation with a higher number for this metric is performing better.

            DECREASE means that a variation with a lower number for this metric is performing better.

            Possible values include:
            • "INCREASE"
            • "DECREASE"
          • metricDefinitionrequired — (map)

            A structure that contains details about the metric.

            • entityIdKey — (String)

              The entity, such as a user or session, that does an action that causes a metric value to be recorded.

            • eventPattern — (String)

              The EventBridge event pattern that defines how the metric is recorded.

              For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

            • name — (String)

              The name of the metric.

            • unitLabel — (String)

              The label for the units that the metric is measuring.

            • valueKey — (String)

              The value that is tracked to produce the metric.

        • namerequired — (String)

          The name of the experiment.

        • onlineAbDefinition — (map)

          A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

          • controlTreatmentName — (String)

            The name of the variation that is the default variation that the other variations are compared to.

          • treatmentWeights — (map<Integer>)

            A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. The traffic portion is specified in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

        • project — (String)

          The name or ARN of the project that contains this experiment.

        • randomizationSalt — (String)

          This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.

        • samplingRate — (Integer)

          In thousandths of a percent, the amount of the available audience that is allocated to this experiment. 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, so a value of 10,000 is 10% of the available audience.

        • schedule — (map)

          A structure that contains the time and date that Evidently completed the analysis of the experiment.

          • analysisCompleteTime — (Date)

            The time and date that Evidently completed the analysis of the experiment.

        • segment — (String)

          The audience segment being used for the experiment, if a segment is being used.

        • statusrequired — (String)

          The current state of the experiment.

          Possible values include:
          • "CREATED"
          • "UPDATING"
          • "RUNNING"
          • "COMPLETED"
          • "CANCELLED"
        • statusReason — (String)

          If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.

        • tags — (map<String>)

          The list of tag keys and values associated with this experiment.

        • treatments — (Array<map>)

          An array of structures that describe the configuration of each feature variation used in the experiment.

          • description — (String)

            The description of the treatment.

          • featureVariations — (map<String>)

            The feature variation used for this treatment. This is a key-value pair. The key is the feature name, and the value is the variation name.

          • namerequired — (String)

            The name of this treatment.

        • typerequired — (String)

          The type of this experiment. Currently, this value must be aws.experiment.onlineab.

          Possible values include:
          • "aws.evidently.onlineab"
      • nextToken — (String)

        The token to use in a subsequent ListExperiments operation to return the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listFeatures(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listFeatures operation

var params = {
  project: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
evidently.listFeatures(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of results to include in the response.

    • nextToken — (String)

      The token to use when requesting the next set of results. You received this token from a previous ListFeatures operation.

    • project — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • features — (Array<map>)

        An array of structures that contain the configuration details of the features in the specified project.

        • arnrequired — (String)

          The ARN of the feature.

        • createdTimerequired — (Date)

          The date and time that the feature is created.

        • defaultVariation — (String)

          The name of the variation that is used as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

        • evaluationRules — (Array<map>)

          An array of structures that define

          • name — (String)

            The name of the experiment or launch.

          • typerequired — (String)

            This value is aws.evidently.splits if this is an evaluation rule for a launch, and it is aws.evidently.onlineab if this is an evaluation rule for an experiment.

        • evaluationStrategyrequired — (String)

          If this value is ALL_RULES, the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION, the default variation is being served to all users.

          Possible values include:
          • "ALL_RULES"
          • "DEFAULT_VARIATION"
        • lastUpdatedTimerequired — (Date)

          The date and time that the feature was most recently updated.

        • namerequired — (String)

          The name of the feature.

        • project — (String)

          The name or ARN of the project that contains the feature.

        • statusrequired — (String)

          The current state of the feature.

          Possible values include:
          • "AVAILABLE"
          • "UPDATING"
        • tags — (map<String>)

          The list of tag keys and values associated with this feature.

      • nextToken — (String)

        The token to use in a subsequent ListFeatures operation to return the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listLaunches(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listLaunches operation

var params = {
  project: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  status: CREATED | UPDATING | RUNNING | COMPLETED | CANCELLED
};
evidently.listLaunches(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of results to include in the response.

    • nextToken — (String)

      The token to use when requesting the next set of results. You received this token from a previous ListLaunches operation.

    • project — (String)

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

    • status — (String)

      Use this optional parameter to limit the returned results to only the launches with the status that you specify here.

      Possible values include:
      • "CREATED"
      • "UPDATING"
      • "RUNNING"
      • "COMPLETED"
      • "CANCELLED"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • launches — (Array<map>)

        An array of structures that contain the configuration details of the launches in the specified project.

        • arnrequired — (String)

          The ARN of the launch.

        • createdTimerequired — (Date)

          The date and time that the launch is created.

        • description — (String)

          The description of the launch.

        • execution — (map)

          A structure that contains information about the start and end times of the launch.

          • endedTime — (Date)

            The date and time that the launch ended.

          • startedTime — (Date)

            The date and time that the launch started.

        • groups — (Array<map>)

          An array of structures that define the feature variations that are being used in the launch.

          • description — (String)

            A description of the launch group.

          • featureVariationsrequired — (map<String>)

            The feature variation for this launch group. This is a key-value pair.

          • namerequired — (String)

            The name of the launch group.

        • lastUpdatedTimerequired — (Date)

          The date and time that the launch was most recently updated.

        • metricMonitors — (Array<map>)

          An array of structures that define the metrics that are being used to monitor the launch performance.

          • metricDefinitionrequired — (map)

            A structure that defines the metric.

            • entityIdKey — (String)

              The entity, such as a user or session, that does an action that causes a metric value to be recorded.

            • eventPattern — (String)

              The EventBridge event pattern that defines how the metric is recorded.

              For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

            • name — (String)

              The name of the metric.

            • unitLabel — (String)

              The label for the units that the metric is measuring.

            • valueKey — (String)

              The value that is tracked to produce the metric.

        • namerequired — (String)

          The name of the launch.

        • project — (String)

          The name or ARN of the project that contains the launch.

        • randomizationSalt — (String)

          This value is used when Evidently assigns a particular user session to the launch, to help create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.

        • scheduledSplitsDefinition — (map)

          An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

          • steps — (Array<map>)

            An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

            • groupWeights — (map<Integer>)

              The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

              The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.

              If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.

            • segmentOverrides — (Array<map>)

              Use this parameter to specify different traffic splits for one or more audience segments. 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.

              This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.

              • evaluationOrderrequired — (Integer)

                A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.

              • segmentrequired — (String)

                The ARN of the segment to use.

              • weightsrequired — (map<Integer>)

                The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.

            • startTimerequired — (Date)

              The date and time that this step of the launch starts.

        • statusrequired — (String)

          The current state of the launch.

          Possible values include:
          • "CREATED"
          • "UPDATING"
          • "RUNNING"
          • "COMPLETED"
          • "CANCELLED"
        • statusReason — (String)

          If the launch was stopped, this is the string that was entered by the person who stopped the launch, to explain why it was stopped.

        • tags — (map<String>)

          The list of tag keys and values associated with this launch.

        • typerequired — (String)

          The type of launch.

          Possible values include:
          • "aws.evidently.splits"
      • nextToken — (String)

        The token to use in a subsequent ListLaunches operation to return the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listProjects(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listProjects operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
evidently.listProjects(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of results to include in the response.

    • nextToken — (String)

      The token to use when requesting the next set of results. You received this token from a previous ListProjects operation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        The token to use in a subsequent ListProjects operation to return the next set of results.

      • projects — (Array<map>)

        An array of structures that contain the configuration details of the projects in the Region.

        • activeExperimentCount — (Integer)

          The number of experiments currently in the project.

        • activeLaunchCount — (Integer)

          The number of ongoing launches currently in the project.

        • arnrequired — (String)

          The name or ARN of the project.

        • createdTimerequired — (Date)

          The date and time that the project is created.

        • description — (String)

          The description of the project.

        • experimentCount — (Integer)

          The number of experiments currently in the project.

        • featureCount — (Integer)

          The number of features currently in the project.

        • lastUpdatedTimerequired — (Date)

          The date and time that the project was most recently updated.

        • launchCount — (Integer)

          The number of launches currently in the project, including launches that are ongoing, completed, and not started yet.

        • namerequired — (String)

          The name of the project.

        • statusrequired — (String)

          The current state of the project.

          Possible values include:
          • "AVAILABLE"
          • "UPDATING"
        • tags — (map<String>)

          The list of tag keys and values associated with this project.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSegmentReferences(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listSegmentReferences operation

var params = {
  segment: 'STRING_VALUE', /* required */
  type: EXPERIMENT | LAUNCH, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
evidently.listSegmentReferences(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of results to include in the response. If you omit this, the default of 50 is used.

    • nextToken — (String)

      The token to use when requesting the next set of results. You received this token from a previous ListSegmentReferences operation.

    • segment — (String)

      The ARN of the segment that you want to view information for.

    • type — (String)

      Specifies whether to return information about launches or experiments that use this segment.

      Possible values include:
      • "EXPERIMENT"
      • "LAUNCH"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        The token to use in a subsequent ListSegmentReferences operation to return the next set of results.

      • referencedBy — (Array<map>)

        An array of structures, where each structure contains information about one experiment or launch that uses this segment.

        • arn — (String)

          The ARN of the experiment or launch.

        • endTime — (String)

          The day and time that this experiment or launch ended.

        • lastUpdatedOn — (String)

          The day and time that this experiment or launch was most recently updated.

        • namerequired — (String)

          The name of the experiment or launch.

        • startTime — (String)

          The day and time that this experiment or launch started.

        • status — (String)

          The status of the experiment or launch.

        • typerequired — (String)

          Specifies whether the resource that this structure contains information about is an experiment or a launch.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSegments(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listSegments operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
evidently.listSegments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of results to include in the response. If you omit this, the default of 50 is used.

    • nextToken — (String)

      The token to use when requesting the next set of results. You received this token from a previous ListSegments operation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        The token to use in a subsequent ListSegments operation to return the next set of results.

      • segments — (Array<map>)

        An array of structures that contain information about the segments in this Region.

        • arnrequired — (String)

          The ARN of the segment.

        • createdTimerequired — (Date)

          The date and time that this segment was created.

        • description — (String)

          The customer-created description for this segment.

        • experimentCount — (Integer)

          The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.

        • lastUpdatedTimerequired — (Date)

          The date and time that this segment was most recently updated.

        • launchCount — (Integer)

          The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.

        • namerequired — (String)

          The name of the segment.

        • patternrequired — (String)

          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 Segment rule pattern syntax.

        • tags — (map<String>)

          The list of tag keys and values associated with this launch.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Displays the tags associated with an Evidently resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
evidently.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The ARN of the resource that you want to see the tags of.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        The list of tag keys and values associated with the resource you specified.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putProjectEvents(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the putProjectEvents operation

var params = {
  events: [ /* required */
    {
      data: any /* This value will be JSON encoded on your behalf with JSON.stringify() */, /* required */
      timestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
      type: aws.evidently.evaluation | aws.evidently.custom /* required */
    },
    /* more items */
  ],
  project: 'STRING_VALUE' /* required */
};
evidently.putProjectEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • events — (Array<map>)

      An array of event structures that contain the performance data that is being sent to Evidently.

      • datarequired — (String)

        The event data.

      • timestamprequired — (Date)

        The timestamp of the event.

      • typerequired — (String)

        aws.evidently.evaluation specifies an evaluation event, which determines which feature variation that a user sees. aws.evidently.custom specifies a custom event, which generates metrics from user actions such as clicks and checkouts.

        Possible values include:
        • "aws.evidently.evaluation"
        • "aws.evidently.custom"
    • project — (String)

      The name or ARN of the project to write the events to.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • eventResults — (Array<map>)

        A structure that contains Evidently's response to the sent events, including an event ID and error codes, if any.

        • errorCode — (String)

          If the PutProjectEvents operation has an error, the error code is returned here.

        • errorMessage — (String)

          If the PutProjectEvents operation has an error, the error message is returned here.

        • eventId — (String)

          A unique ID assigned to this PutProjectEvents operation.

      • failedEventCount — (Integer)

        The number of events in the operation that could not be used by Evidently.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startExperiment(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the startExperiment operation

var params = {
  analysisCompleteTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  experiment: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE' /* required */
};
evidently.startExperiment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • analysisCompleteTime — (Date)

      The date and time to end the experiment. This must be no more than 30 days after the experiment starts.

    • experiment — (String)

      The name of the experiment to start.

    • project — (String)

      The name or ARN of the project that contains the experiment to start.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • startedTime — (Date)

        A timestamp that indicates when the experiment started.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startLaunch(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the startLaunch operation

var params = {
  launch: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE' /* required */
};
evidently.startLaunch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • launch — (String)

      The name of the launch to start.

    • project — (String)

      The name or ARN of the project that contains the launch to start.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • launch — (map)

        A structure that contains information about the launch that was started.

        • arnrequired — (String)

          The ARN of the launch.

        • createdTimerequired — (Date)

          The date and time that the launch is created.

        • description — (String)

          The description of the launch.

        • execution — (map)

          A structure that contains information about the start and end times of the launch.

          • endedTime — (Date)

            The date and time that the launch ended.

          • startedTime — (Date)

            The date and time that the launch started.

        • groups — (Array<map>)

          An array of structures that define the feature variations that are being used in the launch.

          • description — (String)

            A description of the launch group.

          • featureVariationsrequired — (map<String>)

            The feature variation for this launch group. This is a key-value pair.

          • namerequired — (String)

            The name of the launch group.

        • lastUpdatedTimerequired — (Date)

          The date and time that the launch was most recently updated.

        • metricMonitors — (Array<map>)

          An array of structures that define the metrics that are being used to monitor the launch performance.

          • metricDefinitionrequired — (map)

            A structure that defines the metric.

            • entityIdKey — (String)

              The entity, such as a user or session, that does an action that causes a metric value to be recorded.

            • eventPattern — (String)

              The EventBridge event pattern that defines how the metric is recorded.

              For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

            • name — (String)

              The name of the metric.

            • unitLabel — (String)

              The label for the units that the metric is measuring.

            • valueKey — (String)

              The value that is tracked to produce the metric.

        • namerequired — (String)

          The name of the launch.

        • project — (String)

          The name or ARN of the project that contains the launch.

        • randomizationSalt — (String)

          This value is used when Evidently assigns a particular user session to the launch, to help create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.

        • scheduledSplitsDefinition — (map)

          An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

          • steps — (Array<map>)

            An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

            • groupWeights — (map<Integer>)

              The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

              The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.

              If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.

            • segmentOverrides — (Array<map>)

              Use this parameter to specify different traffic splits for one or more audience segments. 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.

              This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.

              • evaluationOrderrequired — (Integer)

                A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.

              • segmentrequired — (String)

                The ARN of the segment to use.

              • weightsrequired — (map<Integer>)

                The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.

            • startTimerequired — (Date)

              The date and time that this step of the launch starts.

        • statusrequired — (String)

          The current state of the launch.

          Possible values include:
          • "CREATED"
          • "UPDATING"
          • "RUNNING"
          • "COMPLETED"
          • "CANCELLED"
        • statusReason — (String)

          If the launch was stopped, this is the string that was entered by the person who stopped the launch, to explain why it was stopped.

        • tags — (map<String>)

          The list of tag keys and values associated with this launch.

        • typerequired — (String)

          The type of launch.

          Possible values include:
          • "aws.evidently.splits"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopExperiment(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the stopExperiment operation

var params = {
  experiment: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE', /* required */
  desiredState: COMPLETED | CANCELLED,
  reason: 'STRING_VALUE'
};
evidently.stopExperiment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • desiredState — (String)

      Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.

      Possible values include:
      • "COMPLETED"
      • "CANCELLED"
    • experiment — (String)

      The name of the experiment to stop.

    • project — (String)

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

    • reason — (String)

      A string that describes why you are stopping the experiment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • endedTime — (Date)

        The date and time that the experiment stopped.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopLaunch(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the stopLaunch operation

var params = {
  launch: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE', /* required */
  desiredState: COMPLETED | CANCELLED,
  reason: 'STRING_VALUE'
};
evidently.stopLaunch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • desiredState — (String)

      Specify whether to consider the launch as COMPLETED or CANCELLED after it stops.

      Possible values include:
      • "COMPLETED"
      • "CANCELLED"
    • launch — (String)

      The name of the launch to stop.

    • project — (String)

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

    • reason — (String)

      A string that describes why you are stopping the launch.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • endedTime — (Date)

        The date and time that the launch stopped.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
evidently.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The ARN of the CloudWatch Evidently resource that you're adding tags to.

    • tags — (map<String>)

      The list of key-value pairs to associate with the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

testSegmentPattern(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the testSegmentPattern operation

var params = {
  pattern: any /* This value will be JSON encoded on your behalf with JSON.stringify() */, /* required */
  payload: any /* This value will be JSON encoded on your behalf with JSON.stringify() */ /* required */
};
evidently.testSegmentPattern(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • pattern — (String)

      The pattern to test.

    • payload — (String)

      A sample evaluationContext JSON block to test against the specified pattern.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • match — (Boolean)

        Returns true if the pattern matches the payload.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from the specified resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
evidently.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The ARN of the CloudWatch Evidently resource that you're removing tags from.

    • tagKeys — (Array<String>)

      The list of tag keys to remove from the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateExperiment(params = {}, callback) ⇒ AWS.Request

Updates an Evidently experiment.

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

Service Reference:

Examples:

Calling the updateExperiment operation

var params = {
  experiment: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  metricGoals: [
    {
      metricDefinition: { /* required */
        entityIdKey: 'STRING_VALUE', /* required */
        name: 'STRING_VALUE', /* required */
        valueKey: 'STRING_VALUE', /* required */
        eventPattern: any /* This value will be JSON encoded on your behalf with JSON.stringify() */,
        unitLabel: 'STRING_VALUE'
      },
      desiredChange: INCREASE | DECREASE
    },
    /* more items */
  ],
  onlineAbConfig: {
    controlTreatmentName: 'STRING_VALUE',
    treatmentWeights: {
      '<TreatmentName>': 'NUMBER_VALUE',
      /* '<TreatmentName>': ... */
    }
  },
  randomizationSalt: 'STRING_VALUE',
  removeSegment: true || false,
  samplingRate: 'NUMBER_VALUE',
  segment: 'STRING_VALUE',
  treatments: [
    {
      feature: 'STRING_VALUE', /* required */
      name: 'STRING_VALUE', /* required */
      variation: 'STRING_VALUE', /* required */
      description: 'STRING_VALUE'
    },
    /* more items */
  ]
};
evidently.updateExperiment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • description — (String)

      An optional description of the experiment.

    • experiment — (String)

      The name of the experiment to update.

    • metricGoals — (Array<map>)

      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.

      • desiredChange — (String)

        INCREASE means that a variation with a higher number for this metric is performing better.

        DECREASE means that a variation with a lower number for this metric is performing better.

        Possible values include:
        • "INCREASE"
        • "DECREASE"
      • metricDefinitionrequired — (map)

        A structure that contains details about the metric.

        • entityIdKeyrequired — (String)

          The entity, such as a user or session, that does an action that causes a metric value to be recorded. An example is userDetails.userID.

        • eventPattern — (String)

          The EventBridge event pattern that defines how the metric is recorded.

          For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

        • namerequired — (String)

          A name for the metric.

        • unitLabel — (String)

          A label for the units that the metric is measuring.

        • valueKeyrequired — (String)

          The value that is tracked to produce the metric.

    • onlineAbConfig — (map)

      A structure that contains the configuration of which variation o use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

      • controlTreatmentName — (String)

        The name of the variation that is to be the default variation that the other variations are compared to.

      • treatmentWeights — (map<Integer>)

        A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

    • project — (String)

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

    • randomizationSalt — (String)

      When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the experiment name as the randomizationSalt.

    • removeSegment — (Boolean)

      Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.

    • samplingRate — (Integer)

      The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

      This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.

    • segment — (String)

      Adds an audience segment to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.

    • treatments — (Array<map>)

      An array of structures that define the variations being tested in the experiment.

      • description — (String)

        A description for this treatment.

      • featurerequired — (String)

        The feature that this experiment is testing.

      • namerequired — (String)

        A name for this treatment.

      • variationrequired — (String)

        The name of the variation to use as this treatment in the experiment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • experiment — (map)

        A structure containing the configuration details of the experiment that was updated.

        • arnrequired — (String)

          The ARN of the experiment.

        • createdTimerequired — (Date)

          The date and time that the experiment is first created.

        • description — (String)

          A description of the experiment.

        • execution — (map)

          A structure that contains the date and time that the experiment started and ended.

          • endedTime — (Date)

            The date and time that the experiment ended.

          • startedTime — (Date)

            The date and time that the experiment started.

        • lastUpdatedTimerequired — (Date)

          The date and time that the experiment was most recently updated.

        • metricGoals — (Array<map>)

          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.

          • desiredChange — (String)

            INCREASE means that a variation with a higher number for this metric is performing better.

            DECREASE means that a variation with a lower number for this metric is performing better.

            Possible values include:
            • "INCREASE"
            • "DECREASE"
          • metricDefinitionrequired — (map)

            A structure that contains details about the metric.

            • entityIdKey — (String)

              The entity, such as a user or session, that does an action that causes a metric value to be recorded.

            • eventPattern — (String)

              The EventBridge event pattern that defines how the metric is recorded.

              For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

            • name — (String)

              The name of the metric.

            • unitLabel — (String)

              The label for the units that the metric is measuring.

            • valueKey — (String)

              The value that is tracked to produce the metric.

        • namerequired — (String)

          The name of the experiment.

        • onlineAbDefinition — (map)

          A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

          • controlTreatmentName — (String)

            The name of the variation that is the default variation that the other variations are compared to.

          • treatmentWeights — (map<Integer>)

            A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. The traffic portion is specified in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.

        • project — (String)

          The name or ARN of the project that contains this experiment.

        • randomizationSalt — (String)

          This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.

        • samplingRate — (Integer)

          In thousandths of a percent, the amount of the available audience that is allocated to this experiment. 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, so a value of 10,000 is 10% of the available audience.

        • schedule — (map)

          A structure that contains the time and date that Evidently completed the analysis of the experiment.

          • analysisCompleteTime — (Date)

            The time and date that Evidently completed the analysis of the experiment.

        • segment — (String)

          The audience segment being used for the experiment, if a segment is being used.

        • statusrequired — (String)

          The current state of the experiment.

          Possible values include:
          • "CREATED"
          • "UPDATING"
          • "RUNNING"
          • "COMPLETED"
          • "CANCELLED"
        • statusReason — (String)

          If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.

        • tags — (map<String>)

          The list of tag keys and values associated with this experiment.

        • treatments — (Array<map>)

          An array of structures that describe the configuration of each feature variation used in the experiment.

          • description — (String)

            The description of the treatment.

          • featureVariations — (map<String>)

            The feature variation used for this treatment. This is a key-value pair. The key is the feature name, and the value is the variation name.

          • namerequired — (String)

            The name of this treatment.

        • typerequired — (String)

          The type of this experiment. Currently, this value must be aws.experiment.onlineab.

          Possible values include:
          • "aws.evidently.onlineab"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateFeature(params = {}, callback) ⇒ AWS.Request

Updates an existing feature.

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

Service Reference:

Examples:

Calling the updateFeature operation

var params = {
  feature: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE', /* required */
  addOrUpdateVariations: [
    {
      name: 'STRING_VALUE', /* required */
      value: { /* required */
        boolValue: true || false,
        doubleValue: 'NUMBER_VALUE',
        longValue: 'NUMBER_VALUE',
        stringValue: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  defaultVariation: 'STRING_VALUE',
  description: 'STRING_VALUE',
  entityOverrides: {
    '<EntityId>': 'STRING_VALUE',
    /* '<EntityId>': ... */
  },
  evaluationStrategy: ALL_RULES | DEFAULT_VARIATION,
  removeVariations: [
    'STRING_VALUE',
    /* more items */
  ]
};
evidently.updateFeature(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • addOrUpdateVariations — (Array<map>)

      To update variation configurations for this feature, or add new ones, specify this structure. In this array, include any variations that you want to add or update. If the array includes a variation name that already exists for this feature, it is updated. If it includes a new variation name, it is added as a new variation.

      • namerequired — (String)

        The name of the variation.

      • valuerequired — (map)

        The value assigned to this variation.

        • boolValue — (Boolean)

          If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.

        • doubleValue — (Float)

          If this feature uses the double integer variation type, this field contains the double integer value of this variation.

        • longValue — (Integer)

          If this feature uses the long variation type, this field contains the long value of this variation.

        • stringValue — (String)

          If this feature uses the string variation type, this field contains the string value of this variation.

    • defaultVariation — (String)

      The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

    • description — (String)

      An optional description of the feature.

    • entityOverrides — (map<String>)

      Specified users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.

    • evaluationStrategy — (String)

      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.

      Possible values include:
      • "ALL_RULES"
      • "DEFAULT_VARIATION"
    • feature — (String)

      The name of the feature to be updated.

    • project — (String)

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

    • removeVariations — (Array<String>)

      Removes a variation from the feature. If the variation you specify doesn't exist, then this makes no change and does not report an error.

      This operation fails if you try to remove a variation that is part of an ongoing launch or experiment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • feature — (map)

        A structure that contains information about the updated feature.

        • arnrequired — (String)

          The ARN of the feature.

        • createdTimerequired — (Date)

          The date and time that the feature is created.

        • defaultVariation — (String)

          The name of the variation that is used as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

          This variation must also be listed in the variations structure.

          If you omit defaultVariation, the first variation listed in the variations structure is used as the default variation.

        • description — (String)

          The description of the feature.

        • entityOverrides — (map<String>)

          A set of key-value pairs that specify users who should always be served a specific variation of a feature. Each key specifies a user using their user ID, account ID, or some other identifier. The value specifies the name of the variation that the user is to be served.

          For the override to be successful, the value of the key must match the entityId used in the EvaluateFeature operation.

        • evaluationRules — (Array<map>)

          An array of structures that define the evaluation rules for the feature.

          • name — (String)

            The name of the experiment or launch.

          • typerequired — (String)

            This value is aws.evidently.splits if this is an evaluation rule for a launch, and it is aws.evidently.onlineab if this is an evaluation rule for an experiment.

        • evaluationStrategyrequired — (String)

          If this value is ALL_RULES, the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION, the default variation is being served to all users.

          Possible values include:
          • "ALL_RULES"
          • "DEFAULT_VARIATION"
        • lastUpdatedTimerequired — (Date)

          The date and time that the feature was most recently updated.

        • namerequired — (String)

          The name of the feature.

        • project — (String)

          The name or ARN of the project that contains the feature.

        • statusrequired — (String)

          The current state of the feature.

          Possible values include:
          • "AVAILABLE"
          • "UPDATING"
        • tags — (map<String>)

          The list of tag keys and values associated with this feature.

        • valueTyperequired — (String)

          Defines the type of value used to define the different feature variations. For more information, see Variation types

          Possible values include:
          • "STRING"
          • "LONG"
          • "DOUBLE"
          • "BOOLEAN"
        • variationsrequired — (Array<map>)

          An array of structures that contain the configuration of the feature's different variations.

          • name — (String)

            The name of the variation.

          • value — (map)

            The value assigned to this variation.

            • boolValue — (Boolean)

              If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.

            • doubleValue — (Float)

              If this feature uses the double integer variation type, this field contains the double integer value of this variation.

            • longValue — (Integer)

              If this feature uses the long variation type, this field contains the long value of this variation.

            • stringValue — (String)

              If this feature uses the string variation type, this field contains the string value of this variation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateLaunch(params = {}, callback) ⇒ AWS.Request

Updates a launch of a given feature.

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

Service Reference:

Examples:

Calling the updateLaunch operation

var params = {
  launch: 'STRING_VALUE', /* required */
  project: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  groups: [
    {
      feature: 'STRING_VALUE', /* required */
      name: 'STRING_VALUE', /* required */
      variation: 'STRING_VALUE', /* required */
      description: 'STRING_VALUE'
    },
    /* more items */
  ],
  metricMonitors: [
    {
      metricDefinition: { /* required */
        entityIdKey: 'STRING_VALUE', /* required */
        name: 'STRING_VALUE', /* required */
        valueKey: 'STRING_VALUE', /* required */
        eventPattern: any /* This value will be JSON encoded on your behalf with JSON.stringify() */,
        unitLabel: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  randomizationSalt: 'STRING_VALUE',
  scheduledSplitsConfig: {
    steps: [ /* required */
      {
        groupWeights: { /* required */
          '<GroupName>': 'NUMBER_VALUE',
          /* '<GroupName>': ... */
        },
        startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
        segmentOverrides: [
          {
            evaluationOrder: 'NUMBER_VALUE', /* required */
            segment: 'STRING_VALUE', /* required */
            weights: { /* required */
              '<GroupName>': 'NUMBER_VALUE',
              /* '<GroupName>': ... */
            }
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  }
};
evidently.updateLaunch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • description — (String)

      An optional description for the launch.

    • groups — (Array<map>)

      An array of structures that contains the feature and variations that are to be used for the launch.

      • description — (String)

        A description of the launch group.

      • featurerequired — (String)

        The feature that this launch is using.

      • namerequired — (String)

        A name for this launch group.

      • variationrequired — (String)

        The feature variation to use for this launch group.

    • launch — (String)

      The name of the launch that is to be updated.

    • metricMonitors — (Array<map>)

      An array of structures that define the metrics that will be used to monitor the launch performance.

      • metricDefinitionrequired — (map)

        A structure that defines the metric.

        • entityIdKeyrequired — (String)

          The entity, such as a user or session, that does an action that causes a metric value to be recorded. An example is userDetails.userID.

        • eventPattern — (String)

          The EventBridge event pattern that defines how the metric is recorded.

          For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

        • namerequired — (String)

          A name for the metric.

        • unitLabel — (String)

          A label for the units that the metric is measuring.

        • valueKeyrequired — (String)

          The value that is tracked to produce the metric.

    • project — (String)

      The name or ARN of the project that contains the launch that you want to update.

    • randomizationSalt — (String)

      When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the launch name as the randomizationSalt.

    • scheduledSplitsConfig — (map)

      An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

      • stepsrequired — (Array<map>)

        An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

        • groupWeightsrequired — (map<Integer>)

          The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

           <p>The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.</p> <p>If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.</p> 
        • segmentOverrides — (Array<map>)

          Use this parameter to specify different traffic splits for one or more audience segments. 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.

          This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.

          • evaluationOrderrequired — (Integer)

            A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.

          • segmentrequired — (String)

            The ARN of the segment to use.

          • weightsrequired — (map<Integer>)

            The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.

        • startTimerequired — (Date)

          The date and time that this step of the launch starts.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • launch — (map)

        A structure that contains the new configuration of the launch that was updated.

        • arnrequired — (String)

          The ARN of the launch.

        • createdTimerequired — (Date)

          The date and time that the launch is created.

        • description — (String)

          The description of the launch.

        • execution — (map)

          A structure that contains information about the start and end times of the launch.

          • endedTime — (Date)

            The date and time that the launch ended.

          • startedTime — (Date)

            The date and time that the launch started.

        • groups — (Array<map>)

          An array of structures that define the feature variations that are being used in the launch.

          • description — (String)

            A description of the launch group.

          • featureVariationsrequired — (map<String>)

            The feature variation for this launch group. This is a key-value pair.

          • namerequired — (String)

            The name of the launch group.

        • lastUpdatedTimerequired — (Date)

          The date and time that the launch was most recently updated.

        • metricMonitors — (Array<map>)

          An array of structures that define the metrics that are being used to monitor the launch performance.

          • metricDefinitionrequired — (map)

            A structure that defines the metric.

            • entityIdKey — (String)

              The entity, such as a user or session, that does an action that causes a metric value to be recorded.

            • eventPattern — (String)

              The EventBridge event pattern that defines how the metric is recorded.

              For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

            • name — (String)

              The name of the metric.

            • unitLabel — (String)

              The label for the units that the metric is measuring.

            • valueKey — (String)

              The value that is tracked to produce the metric.

        • namerequired — (String)

          The name of the launch.

        • project — (String)

          The name or ARN of the project that contains the launch.

        • randomizationSalt — (String)

          This value is used when Evidently assigns a particular user session to the launch, to help create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.

        • scheduledSplitsDefinition — (map)

          An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

          • steps — (Array<map>)

            An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.

            • groupWeights — (map<Integer>)

              The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.

              The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.

              If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.

            • segmentOverrides — (Array<map>)

              Use this parameter to specify different traffic splits for one or more audience segments. 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.

              This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.

              • evaluationOrderrequired — (Integer)

                A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.

              • segmentrequired — (String)

                The ARN of the segment to use.

              • weightsrequired — (map<Integer>)

                The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.

            • startTimerequired — (Date)

              The date and time that this step of the launch starts.

        • statusrequired — (String)

          The current state of the launch.

          Possible values include:
          • "CREATED"
          • "UPDATING"
          • "RUNNING"
          • "COMPLETED"
          • "CANCELLED"
        • statusReason — (String)

          If the launch was stopped, this is the string that was entered by the person who stopped the launch, to explain why it was stopped.

        • tags — (map<String>)

          The list of tag keys and values associated with this launch.

        • typerequired — (String)

          The type of launch.

          Possible values include:
          • "aws.evidently.splits"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateProject(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateProject operation

var params = {
  project: 'STRING_VALUE', /* required */
  appConfigResource: {
    applicationId: 'STRING_VALUE',
    environmentId: 'STRING_VALUE'
  },
  description: 'STRING_VALUE'
};
evidently.updateProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • appConfigResource — (map)

      Use this parameter if the project will use client-side evaluation powered by AppConfig. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation. This mitigates the latency and availability risks that come with an API call. allows you to

      This parameter is a structure that contains information about the AppConfig application that will be used for client-side evaluation.

      • applicationId — (String)

        The ID of the AppConfig application to use for client-side evaluation.

      • environmentId — (String)

        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 applicationId.

    • description — (String)

      An optional description of the project.

    • project — (String)

      The name or ARN of the project to update.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • project — (map)

        A structure containing information about the updated project.

        • activeExperimentCount — (Integer)

          The number of ongoing experiments currently in the project.

        • activeLaunchCount — (Integer)

          The number of ongoing launches currently in the project.

        • appConfigResource — (map)

          This structure defines the configuration of how your application integrates with AppConfig to run client-side evaluation.

          • applicationIdrequired — (String)

            The ID of the AppConfig application to use for client-side evaluation.

          • configurationProfileIdrequired — (String)

            The ID of the AppConfig profile to use for client-side evaluation.

          • environmentIdrequired — (String)

            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 applicationId.

        • arnrequired — (String)

          The name or ARN of the project.

        • createdTimerequired — (Date)

          The date and time that the project is created.

        • dataDelivery — (map)

          A structure that contains information about where Evidently is to store evaluation events for longer term storage.

          • cloudWatchLogs — (map)

            If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.

            • logGroup — (String)

              The name of the log group where the project stores evaluation events.

          • s3Destination — (map)

            If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

            • bucket — (String)

              The name of the bucket in which Evidently stores evaluation events.

            • prefix — (String)

              The bucket prefix in which Evidently stores evaluation events.

        • description — (String)

          The user-entered description of the project.

        • experimentCount — (Integer)

          The number of experiments currently in the project. This includes all experiments that have been created and not deleted, whether they are ongoing or not.

        • featureCount — (Integer)

          The number of features currently in the project.

        • lastUpdatedTimerequired — (Date)

          The date and time that the project was most recently updated.

        • launchCount — (Integer)

          The number of launches currently in the project. This includes all launches that have been created and not deleted, whether they are ongoing or not.

        • namerequired — (String)

          The name of the project.

        • statusrequired — (String)

          The current state of the project.

          Possible values include:
          • "AVAILABLE"
          • "UPDATING"
        • tags — (map<String>)

          The list of tag keys and values associated with this project.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateProjectDataDelivery(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateProjectDataDelivery operation

var params = {
  project: 'STRING_VALUE', /* required */
  cloudWatchLogs: {
    logGroup: 'STRING_VALUE'
  },
  s3Destination: {
    bucket: 'STRING_VALUE',
    prefix: 'STRING_VALUE'
  }
};
evidently.updateProjectDataDelivery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • cloudWatchLogs — (map)

      A structure containing the CloudWatch Logs log group where you want to store evaluation events.

      • logGroup — (String)

        The name of the log group where the project stores evaluation events.

    • project — (String)

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

    • s3Destination — (map)

      A structure containing the S3 bucket name and bucket prefix where you want to store evaluation events.

      • bucket — (String)

        The name of the bucket in which Evidently stores evaluation events.

      • prefix — (String)

        The bucket prefix in which Evidently stores evaluation events.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • project — (map)

        A structure containing details about the project that you updated.

        • activeExperimentCount — (Integer)

          The number of ongoing experiments currently in the project.

        • activeLaunchCount — (Integer)

          The number of ongoing launches currently in the project.

        • appConfigResource — (map)

          This structure defines the configuration of how your application integrates with AppConfig to run client-side evaluation.

          • applicationIdrequired — (String)

            The ID of the AppConfig application to use for client-side evaluation.

          • configurationProfileIdrequired — (String)

            The ID of the AppConfig profile to use for client-side evaluation.

          • environmentIdrequired — (String)

            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 applicationId.

        • arnrequired — (String)

          The name or ARN of the project.

        • createdTimerequired — (Date)

          The date and time that the project is created.

        • dataDelivery — (map)

          A structure that contains information about where Evidently is to store evaluation events for longer term storage.

          • cloudWatchLogs — (map)

            If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.

            • logGroup — (String)

              The name of the log group where the project stores evaluation events.

          • s3Destination — (map)

            If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

            • bucket — (String)

              The name of the bucket in which Evidently stores evaluation events.

            • prefix — (String)

              The bucket prefix in which Evidently stores evaluation events.

        • description — (String)

          The user-entered description of the project.

        • experimentCount — (Integer)

          The number of experiments currently in the project. This includes all experiments that have been created and not deleted, whether they are ongoing or not.

        • featureCount — (Integer)

          The number of features currently in the project.

        • lastUpdatedTimerequired — (Date)

          The date and time that the project was most recently updated.

        • launchCount — (Integer)

          The number of launches currently in the project. This includes all launches that have been created and not deleted, whether they are ongoing or not.

        • namerequired — (String)

          The name of the project.

        • statusrequired — (String)

          The current state of the project.

          Possible values include:
          • "AVAILABLE"
          • "UPDATING"
        • tags — (map<String>)

          The list of tag keys and values associated with this project.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.