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 |
This operation assigns a feature variation to one given user session.
You pass in an entityID
that represents the user. Evidently then
checks the evaluation rules and assigns the variation.
The first rules that are evaluated are the override rules. If the
user's entityID
matches an override rule, the user is served the
variation specified by that rule.
<p>If there is a current launch with this feature that uses segment overrides, and if the user session's <code>evaluationContext</code> matches a segment rule defined in a segment override, the configuration in the segment overrides is used. For more information about segments, see <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateSegment.html">CreateSegment</a> and <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html">Use segments to focus your audience</a>.</p> <p>If there is a launch with no segment overrides, the user might be assigned to a variation in the launch. The chance of this depends on the percentage of users that are allocated to that launch. If the user is enrolled in the launch, the variation they are served depends on the allocation of the various feature variations used for the launch.</p> <p>If the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might be assigned to a variation in the experiment. The chance of this depends on the percentage of users that are allocated to that experiment.</p> <p>If the experiment uses a segment, then only user sessions with <code>evaluationContext</code> values that match the segment rule are used in the experiment.</p> <p>If the user is enrolled in the experiment, the variation they are served depends on the allocation of the various feature variations used for the experiment. </p> <p>If the user is not assigned to a launch or experiment, they are served the default variation.</p>
Synopsis
- data EvaluateFeature = EvaluateFeature' {}
- newEvaluateFeature :: Text -> Text -> Text -> EvaluateFeature
- evaluateFeature_evaluationContext :: Lens' EvaluateFeature (Maybe Text)
- evaluateFeature_entityId :: Lens' EvaluateFeature Text
- evaluateFeature_feature :: Lens' EvaluateFeature Text
- evaluateFeature_project :: Lens' EvaluateFeature Text
- data EvaluateFeatureResponse = EvaluateFeatureResponse' {}
- newEvaluateFeatureResponse :: Int -> EvaluateFeatureResponse
- evaluateFeatureResponse_details :: Lens' EvaluateFeatureResponse (Maybe Text)
- evaluateFeatureResponse_reason :: Lens' EvaluateFeatureResponse (Maybe Text)
- evaluateFeatureResponse_value :: Lens' EvaluateFeatureResponse (Maybe VariableValue)
- evaluateFeatureResponse_variation :: Lens' EvaluateFeatureResponse (Maybe Text)
- evaluateFeatureResponse_httpStatus :: Lens' EvaluateFeatureResponse Int
Creating a Request
data EvaluateFeature Source #
See: newEvaluateFeature
smart constructor.
EvaluateFeature' | |
|
Instances
Create a value of EvaluateFeature
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:
EvaluateFeature
, evaluateFeature_evaluationContext
- A JSON object of attributes that you can optionally pass in as part of
the evaluation event sent to Evidently from the user session. Evidently
can use this value to match user sessions with defined audience
segments. For more information, see
Use segments to focus your audience.
<p>If you include this parameter, the value must be a JSON object. A JSON array is not supported.</p>
EvaluateFeature
, evaluateFeature_entityId
- An internal ID that represents a unique user of the application. This
entityID
is checked against any override rules assigned for this
feature.
EvaluateFeature
, evaluateFeature_feature
- The name of the feature being evaluated.
EvaluateFeature
, evaluateFeature_project
- The name or ARN of the project that contains this feature.
Request Lenses
evaluateFeature_evaluationContext :: Lens' EvaluateFeature (Maybe Text) Source #
A JSON object of attributes that you can optionally pass in as part of the evaluation event sent to Evidently from the user session. Evidently can use this value to match user sessions with defined audience segments. For more information, see Use segments to focus your audience.
<p>If you include this parameter, the value must be a JSON object. A JSON array is not supported.</p>
evaluateFeature_entityId :: Lens' EvaluateFeature Text Source #
An internal ID that represents a unique user of the application. This
entityID
is checked against any override rules assigned for this
feature.
evaluateFeature_feature :: Lens' EvaluateFeature Text Source #
The name of the feature being evaluated.
evaluateFeature_project :: Lens' EvaluateFeature Text Source #
The name or ARN of the project that contains this feature.
Destructuring the Response
data EvaluateFeatureResponse Source #
See: newEvaluateFeatureResponse
smart constructor.
EvaluateFeatureResponse' | |
|
Instances
newEvaluateFeatureResponse Source #
Create a value of EvaluateFeatureResponse
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:
EvaluateFeatureResponse
, evaluateFeatureResponse_details
- If this user was assigned to a launch or experiment, this field lists
the launch or experiment name.
EvaluateFeatureResponse
, evaluateFeatureResponse_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; EXPERIMENT_RULE_MATCH
, if the user session was enrolled
in an experiment; or ENTITY_OVERRIDES_MATCH
, if the user's entityId
matches an override rule.
EvaluateFeatureResponse
, evaluateFeatureResponse_value
- The value assigned to this variation to differentiate it from the other
variations of this feature.
EvaluateFeatureResponse
, evaluateFeatureResponse_variation
- The name of the variation that was served to the user session.
$sel:httpStatus:EvaluateFeatureResponse'
, evaluateFeatureResponse_httpStatus
- The response's http status code.
Response Lenses
evaluateFeatureResponse_details :: Lens' EvaluateFeatureResponse (Maybe Text) Source #
If this user was assigned to a launch or experiment, this field lists the launch or experiment name.
evaluateFeatureResponse_reason :: Lens' EvaluateFeatureResponse (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; EXPERIMENT_RULE_MATCH
, if the user session was enrolled
in an experiment; or ENTITY_OVERRIDES_MATCH
, if the user's entityId
matches an override rule.
evaluateFeatureResponse_value :: Lens' EvaluateFeatureResponse (Maybe VariableValue) Source #
The value assigned to this variation to differentiate it from the other variations of this feature.
evaluateFeatureResponse_variation :: Lens' EvaluateFeatureResponse (Maybe Text) Source #
The name of the variation that was served to the user session.
evaluateFeatureResponse_httpStatus :: Lens' EvaluateFeatureResponse Int Source #
The response's http status code.