Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Evidently.Types.MetricDefinitionConfig

Description

Documentation

data MetricDefinitionConfig Source #

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

See: newMetricDefinitionConfig smart constructor.

Constructors

MetricDefinitionConfig'

Fields

eventPattern :: Maybe Text
The EventBridge event pattern that defines how the metric is recorded.
For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
unitLabel :: Maybe Text
A label for the units that the metric is measuring.
entityIdKey :: Text
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.
name :: Text
A name for the metric.
valueKey :: Text
The value that is tracked to produce the metric.

Instances

Instances details

ToJSON MetricDefinitionConfig Source #
Instance details Defined in Amazonka.Evidently.Types.MetricDefinitionConfig Methods toJSON :: MetricDefinitionConfig -> Value # toEncoding :: MetricDefinitionConfig -> Encoding # toJSONList :: [MetricDefinitionConfig] -> Value # toEncodingList :: [MetricDefinitionConfig] -> Encoding #
Generic MetricDefinitionConfig Source #
Instance details Defined in Amazonka.Evidently.Types.MetricDefinitionConfig Associated Types type Rep MetricDefinitionConfig :: Type -> Type # Methods from :: MetricDefinitionConfig -> Rep MetricDefinitionConfig x # to :: Rep MetricDefinitionConfig x -> MetricDefinitionConfig #
Read MetricDefinitionConfig Source #
Instance details Defined in Amazonka.Evidently.Types.MetricDefinitionConfig Methods readsPrec :: Int -> ReadS MetricDefinitionConfig # readList :: ReadS [MetricDefinitionConfig] # readPrec :: ReadPrec MetricDefinitionConfig # readListPrec :: ReadPrec [MetricDefinitionConfig] #
Show MetricDefinitionConfig Source #
Instance details Defined in Amazonka.Evidently.Types.MetricDefinitionConfig Methods showsPrec :: Int -> MetricDefinitionConfig -> ShowS # show :: MetricDefinitionConfig -> String # showList :: [MetricDefinitionConfig] -> ShowS #
NFData MetricDefinitionConfig Source #
Instance details Defined in Amazonka.Evidently.Types.MetricDefinitionConfig Methods rnf :: MetricDefinitionConfig -> () #
Eq MetricDefinitionConfig Source #
Instance details Defined in Amazonka.Evidently.Types.MetricDefinitionConfig Methods (==) :: MetricDefinitionConfig -> MetricDefinitionConfig -> Bool # (/=) :: MetricDefinitionConfig -> MetricDefinitionConfig -> Bool #
Hashable MetricDefinitionConfig Source #
Instance details Defined in Amazonka.Evidently.Types.MetricDefinitionConfig Methods hashWithSalt :: Int -> MetricDefinitionConfig -> Int # hash :: MetricDefinitionConfig -> Int #
type Rep MetricDefinitionConfig Source #
Instance details Defined in Amazonka.Evidently.Types.MetricDefinitionConfig type Rep MetricDefinitionConfig = D1 ('MetaData "MetricDefinitionConfig" "Amazonka.Evidently.Types.MetricDefinitionConfig" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "MetricDefinitionConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eventPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "unitLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "entityIdKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "valueKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newMetricDefinitionConfig Source #

Arguments

:: Text	`$sel:entityIdKey:MetricDefinitionConfig'`
-> Text	`$sel:name:MetricDefinitionConfig'`
-> Text	`$sel:valueKey:MetricDefinitionConfig'`
-> MetricDefinitionConfig

Create a value of MetricDefinitionConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:eventPattern:MetricDefinitionConfig', metricDefinitionConfig_eventPattern - The EventBridge event pattern that defines how the metric is recorded.

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

$sel:unitLabel:MetricDefinitionConfig', metricDefinitionConfig_unitLabel - A label for the units that the metric is measuring.

$sel:entityIdKey:MetricDefinitionConfig', metricDefinitionConfig_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.

$sel:name:MetricDefinitionConfig', metricDefinitionConfig_name - A name for the metric.

$sel:valueKey:MetricDefinitionConfig', metricDefinitionConfig_valueKey - The value that is tracked to produce the metric.

metricDefinitionConfig_eventPattern :: Lens' MetricDefinitionConfig (Maybe Text) Source #

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

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

metricDefinitionConfig_unitLabel :: Lens' MetricDefinitionConfig (Maybe Text) Source #

A label for the units that the metric is measuring.

metricDefinitionConfig_entityIdKey :: Lens' MetricDefinitionConfig Text Source #

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.

metricDefinitionConfig_name :: Lens' MetricDefinitionConfig Text Source #

A name for the metric.

metricDefinitionConfig_valueKey :: Lens' MetricDefinitionConfig Text Source #

The value that is tracked to produce the metric.