| 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.BatchEvaluateFeature
Description
This operation assigns feature variation to user sessions. For each 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.
Next, if there is a launch of the feature, 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.
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. 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.
If the user is not assigned to a launch or experiment, they are served the default variation.
Synopsis
- data BatchEvaluateFeature = BatchEvaluateFeature' {}
- newBatchEvaluateFeature :: Text -> NonEmpty EvaluationRequest -> BatchEvaluateFeature
- batchEvaluateFeature_project :: Lens' BatchEvaluateFeature Text
- batchEvaluateFeature_requests :: Lens' BatchEvaluateFeature (NonEmpty EvaluationRequest)
- data BatchEvaluateFeatureResponse = BatchEvaluateFeatureResponse' {
- results :: Maybe [EvaluationResult]
- httpStatus :: Int
- newBatchEvaluateFeatureResponse :: Int -> BatchEvaluateFeatureResponse
- batchEvaluateFeatureResponse_results :: Lens' BatchEvaluateFeatureResponse (Maybe [EvaluationResult])
- batchEvaluateFeatureResponse_httpStatus :: Lens' BatchEvaluateFeatureResponse Int
Creating a Request
data BatchEvaluateFeature Source #
See: newBatchEvaluateFeature smart constructor.
Constructors
| BatchEvaluateFeature' | |
Fields
| |
Instances
newBatchEvaluateFeature Source #
Arguments
| :: Text | |
| -> NonEmpty EvaluationRequest | |
| -> BatchEvaluateFeature |
Create a value of BatchEvaluateFeature 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:
BatchEvaluateFeature, batchEvaluateFeature_project - The name or ARN of the project that contains the feature being
evaluated.
$sel:requests:BatchEvaluateFeature', batchEvaluateFeature_requests - An array of structures, where each structure assigns a feature variation
to one user session.
Request Lenses
batchEvaluateFeature_project :: Lens' BatchEvaluateFeature Text Source #
The name or ARN of the project that contains the feature being evaluated.
batchEvaluateFeature_requests :: Lens' BatchEvaluateFeature (NonEmpty EvaluationRequest) Source #
An array of structures, where each structure assigns a feature variation to one user session.
Destructuring the Response
data BatchEvaluateFeatureResponse Source #
See: newBatchEvaluateFeatureResponse smart constructor.
Constructors
| BatchEvaluateFeatureResponse' | |
Fields
| |
Instances
newBatchEvaluateFeatureResponse Source #
Create a value of BatchEvaluateFeatureResponse 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:results:BatchEvaluateFeatureResponse', batchEvaluateFeatureResponse_results - An array of structures, where each structure displays the results of one
feature evaluation assignment to one user session.
$sel:httpStatus:BatchEvaluateFeatureResponse', batchEvaluateFeatureResponse_httpStatus - The response's http status code.
Response Lenses
batchEvaluateFeatureResponse_results :: Lens' BatchEvaluateFeatureResponse (Maybe [EvaluationResult]) Source #
An array of structures, where each structure displays the results of one feature evaluation assignment to one user session.
batchEvaluateFeatureResponse_httpStatus :: Lens' BatchEvaluateFeatureResponse Int Source #
The response's http status code.