MetricDefinitionConfig - CloudWatch Evidently

MetricDefinitionConfig

This structure defines a metric that you want to use to evaluate the variations during a launch or experiment.

Contents

entityIdKey

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: .*

Required: Yes

eventPattern

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

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

name

A name for the metric.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[\S]+$

Required: Yes

unitLabel

A label for the units that the metric is measuring.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: .*

Required: No

valueKey

The value that is tracked to produce the metric.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: .*

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: