Feature
This structure contains information about one Evidently feature in your account.
Contents
- arn
-
The ARN of the feature.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*/feature/[-a-zA-Z0-9._]*
Required: Yes
- createdTime
-
The date and time that the feature is created.
Type: Timestamp
Required: Yes
- evaluationStrategy
-
If this value is
ALL_RULES
, the traffic allocation specified by any ongoing launches or experiments is being used. If this isDEFAULT_VARIATION
, the default variation is being served to all users.Type: String
Valid Values:
ALL_RULES | DEFAULT_VARIATION
Required: Yes
- lastUpdatedTime
-
The date and time that the feature was most recently updated.
Type: Timestamp
Required: Yes
- name
-
The name of the feature.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern:
^[-a-zA-Z0-9._]*$
Required: Yes
- status
-
The current state of the feature.
Type: String
Valid Values:
AVAILABLE | UPDATING
Required: Yes
- valueType
-
Defines the type of value used to define the different feature variations. For more information, see Variation types
Type: String
Valid Values:
STRING | LONG | DOUBLE | BOOLEAN
Required: Yes
- variations
-
An array of structures that contain the configuration of the feature's different variations.
Type: Array of Variation objects
Required: Yes
- 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 thevariations
structure is used as the default variation.Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern:
^[-a-zA-Z0-9._]*$
Required: No
- description
-
The description of the feature.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 160.
Pattern:
.*
Required: No
- 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.Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 2500 items.
Key Length Constraints: Minimum length of 1. Maximum length of 512.
Key Pattern:
.*
Value Length Constraints: Minimum length of 1. Maximum length of 127.
Value Pattern:
^[-a-zA-Z0-9._]*$
Required: No
- evaluationRules
-
An array of structures that define the evaluation rules for the feature.
Type: Array of EvaluationRule objects
Required: No
- project
-
The name or ARN of the project that contains the feature.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*
Required: No
-
The list of tag keys and values associated with this feature.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: