Class: AWS.Evidently

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"
    • metricDefinition — required — (map)

      A structure that contains details about the metric.

      • entityIdKey — required — (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.

      • name — required — (String)

        A name for the metric.

      • unitLabel — (String)

        A label for the units that the metric is measuring.

      • valueKey — required — (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.

    You can associate as many as 50 tags with an experiment.

    For more information, see Tagging Amazon Web Services resources.

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

    • feature — required — (String)

      The feature that this experiment is testing.

    • name — required — (String)

      A name for this treatment.

    • variation — required — (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.

      • arn — required — (String)

        The ARN of the experiment.

      • createdTime — required — (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.

      • lastUpdatedTime — required — (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"
        • metricDefinition — required — (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.

      • name — required — (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.

      • status — required — (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.

        • name — required — (String)

          The name of this treatment.

      • type — required — (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.

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.

    This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override.

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

    You can associate as many as 50 tags with a feature.

    For more information, see Tagging Amazon Web Services resources.

  • variations — (Array<map>)

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

    • name — required — (String)

      The name of the variation.

    • value — required — (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.

      • arn — required — (String)

        The ARN of the feature.

      • createdTime — required — (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.

        • type — required — (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.

      • evaluationStrategy — required — (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"
      • lastUpdatedTime — required — (Date)

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

      • name — required — (String)

        The name of the feature.

      • project — (String)

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

      • status — required — (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.

      • valueType — required — (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"
      • variations — required — (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.

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.

    • feature — required — (String)

      The feature that this launch is using.

    • name — required — (String)

      A name for this launch group.

    • variation — required — (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.

    • metricDefinition — required — (map)

      A structure that defines the metric.

      • entityIdKey — required — (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.

      • name — required — (String)

        A name for the metric.

      • unitLabel — (String)

        A label for the units that the metric is measuring.

      • valueKey — required — (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.

    • steps — required — (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 — required — (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.

        • evaluationOrder — required — (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.

        • segment — required — (String)

          The ARN of the segment to use.

        • weights — required — (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.

      • startTime — required — (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.

    You can associate as many as 50 tags with a launch.

    For more information, see Tagging Amazon Web Services resources.

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.

      • arn — required — (String)

        The ARN of the launch.

      • createdTime — required — (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.

        • featureVariations — required — (map<String>)

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

        • name — required — (String)

          The name of the launch group.

      • lastUpdatedTime — required — (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.

        • metricDefinition — required — (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.

      • name — required — (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.

            • evaluationOrder — required — (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.

            • segment — required — (String)

              The ARN of the segment to use.

            • weights — required — (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.

          • startTime — required — (Date)

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

      • status — required — (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.

      • type — required — (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.

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.

    You can associate as many as 50 tags with a project.

    For more information, see Tagging Amazon Web Services resources.

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.

        • applicationId — required — (String)

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

        • configurationProfileId — required — (String)

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

        • environmentId — required — (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.

      • arn — required — (String)

        The name or ARN of the project.

      • createdTime — required — (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.

      • lastUpdatedTime — required — (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.

      • name — required — (String)

        The name of the project.

      • status — required — (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.

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.

    You can associate as many as 50 tags with a segment.

    For more information, see Tagging Amazon Web Services resources.

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.

      • arn — required — (String)

        The ARN of the segment.

      • createdTime — required — (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.

      • lastUpdatedTime — required — (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.

      • name — required — (String)

        The name of the segment.

      • pattern — required — (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.

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.

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.

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.

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.

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.

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.

    If you include this parameter, the value must be a JSON object. A JSON array is not supported.

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

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.

      • arn — required — (String)

        The ARN of the experiment.

      • createdTime — required — (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.

      • lastUpdatedTime — required — (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"
        • metricDefinition — required — (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.

      • name — required — (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.

      • status — required — (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.

        • name — required — (String)

          The name of this treatment.

      • type — required — (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.

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.

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.

      • arn — required — (String)

        The ARN of the feature.

      • createdTime — required — (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.

        • type — required — (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.

      • evaluationStrategy — required — (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"
      • lastUpdatedTime — required — (Date)

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

      • name — required — (String)

        The name of the feature.

      • project — (String)

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

      • status — required — (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.

      • valueType — required — (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"
      • variations — required — (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.

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.

      • arn — required — (String)

        The ARN of the launch.

      • createdTime — required — (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.

        • featureVariations — required — (map<String>)

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

        • name — required — (String)

          The name of the launch group.

      • lastUpdatedTime — required — (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.

        • metricDefinition — required — (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.

      • name — required — (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.

            • evaluationOrder — required — (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.

            • segment — required — (String)

              The ARN of the segment to use.

            • weights — required — (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.

          • startTime — required — (Date)

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

      • status — required — (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.

      • type — required — (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.

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.

        • applicationId — required — (String)

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

        • configurationProfileId — required — (String)

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

        • environmentId — required — (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.

      • arn — required — (String)

        The name or ARN of the project.

      • createdTime — required — (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.

      • lastUpdatedTime — required — (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.

      • name — required — (String)

        The name of the project.

      • status — required — (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.

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.

      • arn — required — (String)

        The ARN of the segment.

      • createdTime — required — (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.

      • lastUpdatedTime — required — (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.

      • name — required — (String)

        The name of the segment.

      • pattern — required — (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.

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.

      • arn — required — (String)

        The ARN of the experiment.

      • createdTime — required — (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.

      • lastUpdatedTime — required — (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"
        • metricDefinition — required — (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.

      • name — required — (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.

      • status — required — (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.

        • name — required — (String)

          The name of this treatment.

      • type — required — (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.

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.

      • arn — required — (String)

        The ARN of the feature.

      • createdTime — required — (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.

        • type — required — (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.

      • evaluationStrategy — required — (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"
      • lastUpdatedTime — required — (Date)

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

      • name — required — (String)

        The name of the feature.

      • project — (String)

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

      • status — required — (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.

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.

      • arn — required — (String)

        The ARN of the launch.

      • createdTime — required — (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.

        • featureVariations — required — (map<String>)

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

        • name — required — (String)

          The name of the launch group.

      • lastUpdatedTime — required — (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.

        • metricDefinition — required — (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.

      • name — required — (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.

            • evaluationOrder — required — (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.

            • segment — required — (String)

              The ARN of the segment to use.

            • weights — required — (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.

          • startTime — required — (Date)

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

      • status — required — (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.

      • type — required — (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.

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.

      • arn — required — (String)

        The name or ARN of the project.

      • createdTime — required — (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.

      • lastUpdatedTime — required — (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.

      • name — required — (String)

        The name of the project.

      • status — required — (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.

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.

      • name — required — (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.

      • type — required — (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.

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.

      • arn — required — (String)

        The ARN of the segment.

      • createdTime — required — (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.

      • lastUpdatedTime — required — (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.

      • name — required — (String)

        The name of the segment.

      • pattern — required — (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.

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.

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.

    • data — required — (String)

      The event data.

    • timestamp — required — (Date)

      The timestamp of the event.

    • type — required — (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.

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.

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.

      • arn — required — (String)

        The ARN of the launch.

      • createdTime — required — (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.

        • featureVariations — required — (map<String>)

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

        • name — required — (String)

          The name of the launch group.

      • lastUpdatedTime — required — (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.

        • metricDefinition — required — (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.

      • name — required — (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.

            • evaluationOrder — required — (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.

            • segment — required — (String)

              The ARN of the segment to use.

            • weights — required — (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.

          • startTime — required — (Date)

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

      • status — required — (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.

      • type — required — (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.

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.

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.

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.

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.

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.

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"
    • metricDefinition — required — (map)

      A structure that contains details about the metric.

      • entityIdKey — required — (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.

      • name — required — (String)

        A name for the metric.

      • unitLabel — (String)

        A label for the units that the metric is measuring.

      • valueKey — required — (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.

    • feature — required — (String)

      The feature that this experiment is testing.

    • name — required — (String)

      A name for this treatment.

    • variation — required — (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.

      • arn — required — (String)

        The ARN of the experiment.

      • createdTime — required — (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.

      • lastUpdatedTime — required — (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"
        • metricDefinition — required — (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.

      • name — required — (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.

      • status — required — (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.

        • name — required — (String)

          The name of this treatment.

      • type — required — (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.

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.

    • name — required — (String)

      The name of the variation.

    • value — required — (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.

    This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override.

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

      • arn — required — (String)

        The ARN of the feature.

      • createdTime — required — (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.

        • type — required — (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.

      • evaluationStrategy — required — (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"
      • lastUpdatedTime — required — (Date)

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

      • name — required — (String)

        The name of the feature.

      • project — (String)

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

      • status — required — (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.

      • valueType — required — (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"
      • variations — required — (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.

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.

    • feature — required — (String)

      The feature that this launch is using.

    • name — required — (String)

      A name for this launch group.

    • variation — required — (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.

    • metricDefinition — required — (map)

      A structure that defines the metric.

      • entityIdKey — required — (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.

      • name — required — (String)

        A name for the metric.

      • unitLabel — (String)

        A label for the units that the metric is measuring.

      • valueKey — required — (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.

    • steps — required — (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 — required — (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.

        • evaluationOrder — required — (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.

        • segment — required — (String)

          The ARN of the segment to use.

        • weights — required — (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.

      • startTime — required — (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.

      • arn — required — (String)

        The ARN of the launch.

      • createdTime — required — (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.

        • featureVariations — required — (map<String>)

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

        • name — required — (String)

          The name of the launch group.

      • lastUpdatedTime — required — (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.

        • metricDefinition — required — (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.

      • name — required — (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.

            • evaluationOrder — required — (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.

            • segment — required — (String)

              The ARN of the segment to use.

            • weights — required — (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.

          • startTime — required — (Date)

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

      • status — required — (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.

      • type — required — (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.