MetricDefinition
This structure defines a metric that is being used 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
.*
Required: No
- 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
Required: No
- name
-
The name of the metric.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[\S]+$
Required: No
- unitLabel
-
The 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: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: