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

Description

Documentation

data EvaluationResult Source #

This structure displays the results of one feature evaluation assignment to one user session.

See: newEvaluationResult smart constructor.

Constructors

EvaluationResult'

Fields

details :: Maybe Text
If this user was assigned to a launch or experiment, this field lists the launch or experiment name.
project :: Maybe Text
The name or ARN of the project that contains the feature being evaluated.
reason :: Maybe Text
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; or EXPERIMENT_RULE_MATCH, if the user session was enrolled in an experiment.
value :: Maybe VariableValue
The value assigned to this variation to differentiate it from the other variations of this feature.
variation :: Maybe Text
The name of the variation that was served to the user session.
entityId :: Text
An internal ID that represents a unique user session of the application.
feature :: Text
The name of the feature being evaluated.

Instances

Instances details

FromJSON EvaluationResult Source #
Instance details Defined in Amazonka.Evidently.Types.EvaluationResult Methods parseJSON :: Value -> Parser EvaluationResult # parseJSONList :: Value -> Parser [EvaluationResult] #
Generic EvaluationResult Source #
Instance details Defined in Amazonka.Evidently.Types.EvaluationResult Associated Types type Rep EvaluationResult :: Type -> Type # Methods from :: EvaluationResult -> Rep EvaluationResult x # to :: Rep EvaluationResult x -> EvaluationResult #
Read EvaluationResult Source #
Instance details Defined in Amazonka.Evidently.Types.EvaluationResult Methods readsPrec :: Int -> ReadS EvaluationResult # readList :: ReadS [EvaluationResult] # readPrec :: ReadPrec EvaluationResult # readListPrec :: ReadPrec [EvaluationResult] #
Show EvaluationResult Source #
Instance details Defined in Amazonka.Evidently.Types.EvaluationResult Methods showsPrec :: Int -> EvaluationResult -> ShowS # show :: EvaluationResult -> String # showList :: [EvaluationResult] -> ShowS #
NFData EvaluationResult Source #
Instance details Defined in Amazonka.Evidently.Types.EvaluationResult Methods rnf :: EvaluationResult -> () #
Eq EvaluationResult Source #
Instance details Defined in Amazonka.Evidently.Types.EvaluationResult Methods (==) :: EvaluationResult -> EvaluationResult -> Bool # (/=) :: EvaluationResult -> EvaluationResult -> Bool #
Hashable EvaluationResult Source #
Instance details Defined in Amazonka.Evidently.Types.EvaluationResult Methods hashWithSalt :: Int -> EvaluationResult -> Int # hash :: EvaluationResult -> Int #
type Rep EvaluationResult Source #
Instance details Defined in Amazonka.Evidently.Types.EvaluationResult type Rep EvaluationResult = D1 ('MetaData "EvaluationResult" "Amazonka.Evidently.Types.EvaluationResult" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "EvaluationResult'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "project") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VariableValue)) :: S1 ('MetaSel ('Just "variation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "feature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newEvaluationResult Source #

Arguments

:: Text	`$sel:entityId:EvaluationResult'`
-> Text	`$sel:feature:EvaluationResult'`
-> EvaluationResult

Create a value of EvaluationResult 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:details:EvaluationResult', evaluationResult_details - If this user was assigned to a launch or experiment, this field lists the launch or experiment name.

$sel:project:EvaluationResult', evaluationResult_project - The name or ARN of the project that contains the feature being evaluated.

$sel:reason:EvaluationResult', evaluationResult_reason - 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; or EXPERIMENT_RULE_MATCH, if the user session was enrolled in an experiment.

$sel:value:EvaluationResult', evaluationResult_value - The value assigned to this variation to differentiate it from the other variations of this feature.

$sel:variation:EvaluationResult', evaluationResult_variation - The name of the variation that was served to the user session.

$sel:entityId:EvaluationResult', evaluationResult_entityId - An internal ID that represents a unique user session of the application.

$sel:feature:EvaluationResult', evaluationResult_feature - The name of the feature being evaluated.

evaluationResult_details :: Lens' EvaluationResult (Maybe Text) Source #

If this user was assigned to a launch or experiment, this field lists the launch or experiment name.

evaluationResult_project :: Lens' EvaluationResult (Maybe Text) Source #

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

evaluationResult_reason :: Lens' EvaluationResult (Maybe Text) Source #

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; or EXPERIMENT_RULE_MATCH, if the user session was enrolled in an experiment.

evaluationResult_value :: Lens' EvaluationResult (Maybe VariableValue) Source #

The value assigned to this variation to differentiate it from the other variations of this feature.

evaluationResult_variation :: Lens' EvaluationResult (Maybe Text) Source #

The name of the variation that was served to the user session.

evaluationResult_entityId :: Lens' EvaluationResult Text Source #

An internal ID that represents a unique user session of the application.

evaluationResult_feature :: Lens' EvaluationResult Text Source #

The name of the feature being evaluated.