1.204.0

interface MetricGoalObjectProperty

LanguageType name
.NETAmazon.CDK.AWS.Evidently.CfnExperiment.MetricGoalObjectProperty
Javasoftware.amazon.awscdk.services.evidently.CfnExperiment.MetricGoalObjectProperty
Pythonaws_cdk.aws_evidently.CfnExperiment.MetricGoalObjectProperty
TypeScript @aws-cdk/aws-evidently » CfnExperiment » MetricGoalObjectProperty

Use this structure to tell Evidently whether higher or lower values are desired for a metric that is used in an experiment.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as evidently from '@aws-cdk/aws-evidently';
const metricGoalObjectProperty: evidently.CfnExperiment.MetricGoalObjectProperty = {
  desiredChange: 'desiredChange',
  entityIdKey: 'entityIdKey',
  metricName: 'metricName',
  valueKey: 'valueKey',

  // the properties below are optional
  eventPattern: 'eventPattern',
  unitLabel: 'unitLabel',
};

Properties

NameTypeDescription
desiredChangestringINCREASE means that a variation with a higher number for this metric is performing better.
entityIdKeystringThe entity, such as a user or session, that does an action that causes a metric value to be recorded.
metricNamestringA name for the metric.
valueKeystringThe JSON path to reference the numerical metric value in the event.
eventPattern?stringThe EventBridge event pattern that defines how the metric is recorded.
unitLabel?stringA label for the units that the metric is measuring.

desiredChange

Type: 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.

entityIdKey

Type: 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 .

metricName

Type: string

A name for the metric.

It can include up to 255 characters.

valueKey

Type: string

The JSON path to reference the numerical metric value in the event.

eventPattern?

Type: string (optional)

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

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

unitLabel?

Type: string (optional)

A label for the units that the metric is measuring.

← PreviousNext →