Documentation

This structure contains information about one Evidently feature in your account.

See: newFeature smart constructor.

Create a value of Feature 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:defaultVariation:Feature', feature_defaultVariation - The name of the variation that is used as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

This variation must also be listed in the variations structure.

If you omit defaultVariation, the first variation listed in the variations structure is used as the default variation.

$sel:description:Feature', feature_description - The description of the feature.

$sel:entityOverrides:Feature', feature_entityOverrides - A set of key-value pairs that specify users who should always be served a specific variation of a feature. Each key specifies a user using their user ID, account ID, or some other identifier. The value specifies the name of the variation that the user is to be served.

For the override to be successful, the value of the key must match the entityId used in the EvaluateFeature operation.

$sel:evaluationRules:Feature', feature_evaluationRules - An array of structures that define the evaluation rules for the feature.

$sel:project:Feature', feature_project - The name or ARN of the project that contains the feature.

$sel:tags:Feature', feature_tags - The list of tag keys and values associated with this feature.

$sel:arn:Feature', feature_arn - The ARN of the feature.

$sel:createdTime:Feature', feature_createdTime - The date and time that the feature is created.

$sel:evaluationStrategy:Feature', feature_evaluationStrategy - If this value is ALL_RULES, the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION, the default variation is being served to all users.

$sel:lastUpdatedTime:Feature', feature_lastUpdatedTime - The date and time that the feature was most recently updated.

Feature, feature_name - The name of the feature.

$sel:status:Feature', feature_status - The current state of the feature.

$sel:valueType:Feature', feature_valueType - Defines the type of value used to define the different feature variations. For more information, see Variation types

$sel:variations:Feature', feature_variations - An array of structures that contain the configuration of the feature's different variations.

The name of the variation that is used as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

This variation must also be listed in the variations structure.

If you omit defaultVariation, the first variation listed in the variations structure is used as the default variation.

The description of the feature.

A set of key-value pairs that specify users who should always be served a specific variation of a feature. Each key specifies a user using their user ID, account ID, or some other identifier. The value specifies the name of the variation that the user is to be served.

For the override to be successful, the value of the key must match the entityId used in the EvaluateFeature operation.

An array of structures that define the evaluation rules for the feature.

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

The list of tag keys and values associated with this feature.

The ARN of the feature.

The date and time that the feature is created.

If this value is ALL_RULES, the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION, the default variation is being served to all users.

The date and time that the feature was most recently updated.

The name of the feature.

The current state of the feature.

Defines the type of value used to define the different feature variations. For more information, see Variation types

An array of structures that contain the configuration of the feature's different variations.