This structure assigns a feature variation to one user session.
* @public */ export interface EvaluationRequest { /** *The name of the feature being evaluated.
* @public */ feature: string | undefined; /** *An internal ID that represents a unique user session of the application. This entityID is checked against any override rules assigned for this feature.
A JSON block of attributes that you can optionally pass in. This JSON block is included in the evaluation events sent to Evidently from the user session.
* @public */ evaluationContext?: __AutomaticJsonStringConversion | string | undefined; } /** * @public */ export interface BatchEvaluateFeatureRequest { /** *The name or ARN of the project that contains the feature being evaluated.
* @public */ project: string | undefined; /** *An array of structures, where each structure assigns a feature variation to one user session.
* @public */ requests: EvaluationRequest[] | undefined; } /** *The value assigned to a feature variation. This structure must contain exactly one field. It can be boolValue, doubleValue, longValue, or stringValue.
If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.
* @public */ interface BoolValueMember { boolValue: boolean; stringValue?: never; longValue?: never; doubleValue?: never; $unknown?: never; } /** *If this feature uses the string variation type, this field contains the string value of this variation.
* @public */ interface StringValueMember { boolValue?: never; stringValue: string; longValue?: never; doubleValue?: never; $unknown?: never; } /** *If this feature uses the long variation type, this field contains the long value of this variation.
* @public */ interface LongValueMember { boolValue?: never; stringValue?: never; longValue: number; doubleValue?: never; $unknown?: never; } /** *If this feature uses the double integer variation type, this field contains the double integer value of this variation.
* @public */ interface DoubleValueMember { boolValue?: never; stringValue?: never; longValue?: never; doubleValue: number; $unknown?: never; } /** * @public */ interface $UnknownMember { boolValue?: never; stringValue?: never; longValue?: never; doubleValue?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThis structure displays the results of one feature evaluation assignment to one user session.
* @public */ export interface EvaluationResult { /** *The name or ARN of the project that contains the feature being evaluated.
* @public */ project?: string | undefined; /** *The name of the feature being evaluated.
* @public */ feature: string | undefined; /** *The name of the variation that was served to the user session.
* @public */ variation?: string | undefined; /** *The value assigned to this variation to differentiate it from the other variations of this feature.
* @public */ value?: VariableValue | undefined; /** *An internal ID that represents a unique user session of the application.
* @public */ entityId: string | undefined; /** *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.
If this user was assigned to a launch or experiment, this field lists the launch or experiment name.
* @public */ details?: __AutomaticJsonStringConversion | string | undefined; } /** * @public */ export interface BatchEvaluateFeatureResponse { /** *An array of structures, where each structure displays the results of one feature evaluation assignment to one user session.
* @public */ results?: EvaluationResult[] | undefined; } /** *A structure containing an error name and message.
* @public */ export interface ValidationExceptionField { /** *The error name.
* @public */ name: string | undefined; /** *The error message.
* @public */ message: string | undefined; } /** *A structure containing the CloudWatch Logs log group where the project stores evaluation events.
* @public */ export interface CloudWatchLogsDestination { /** *The name of the log group where the project stores evaluation events.
* @public */ logGroup?: string | undefined; } /** *A structure containing the CloudWatch Logs log group where the project stores evaluation events.
* @public */ export interface CloudWatchLogsDestinationConfig { /** *The name of the log group where the project stores evaluation events.
* @public */ logGroup?: string | undefined; } /** *This structure defines a metric that you want to use to evaluate the variations during a launch or experiment.
* @public */ export interface MetricDefinitionConfig { /** *A name for the metric.
* @public */ name: string | undefined; /** *The entity, such as a user or session, that does an action that causes a metric value to be recorded. An example is userDetails.userID.
The value that is tracked to produce the metric.
* @public */ valueKey: string | undefined; /** *The EventBridge event pattern that defines how the metric is recorded.
For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
* @public */ eventPattern?: __AutomaticJsonStringConversion | string | undefined; /** *A label for the units that the metric is measuring.
* @public */ unitLabel?: string | undefined; } /** *Use this structure to tell Evidently whether higher or lower values are desired for a metric that is used in an experiment.
* @public */ export interface MetricGoalConfig { /** *A structure that contains details about the metric.
* @public */ metricDefinition: MetricDefinitionConfig | undefined; /** * INCREASE means that a variation with a higher number for this metric is performing better.
DECREASE means that a variation with a lower number for this metric is performing better.
A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
* @public */ export interface OnlineAbConfig { /** *The name of the variation that is to be the default variation that the other variations are compared to.
* @public */ controlTreatmentName?: string | undefined; /** *A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.
* @public */ treatmentWeights?: RecordA structure that defines one treatment in an experiment. A treatment is a variation of the feature that you are including in the experiment.
* @public */ export interface TreatmentConfig { /** *A name for this treatment.
* @public */ name: string | undefined; /** *A description for this treatment.
* @public */ description?: string | undefined; /** *The feature that this experiment is testing.
* @public */ feature: string | undefined; /** *The name of the variation to use as this treatment in the experiment.
* @public */ variation: string | undefined; } /** * @public */ export interface CreateExperimentRequest { /** *The name or ARN of the project that you want to create the new experiment in.
* @public */ project: string | undefined; /** *A name for the new experiment.
* @public */ name: string | undefined; /** *An optional description of the experiment.
* @public */ description?: string | undefined; /** *An array of structures that describe the configuration of each feature variation used in the experiment.
* @public */ treatments: TreatmentConfig[] | undefined; /** *An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.
* @public */ metricGoals: MetricGoalConfig[] | undefined; /** *When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the experiment name as the randomizationSalt.
The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.
This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.
* @public */ samplingRate?: number | undefined; /** *A structure that contains the configuration of which variation to use as the "control" version. tThe "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
* @public */ onlineAbConfig?: OnlineAbConfig | undefined; /** *Specifies an audience segment to use in the experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment.
* @public */ segment?: string | undefined; /** *Assigns one or more tags (key-value pairs) to the experiment.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with an experiment.
For more information, see Tagging Amazon Web Services resources.
* @public */ tags?: RecordThis structure contains the date and time that the experiment started and ended.
* @public */ export interface ExperimentExecution { /** *The date and time that the experiment started.
* @public */ startedTime?: Date | undefined; /** *The date and time that the experiment ended.
* @public */ endedTime?: Date | undefined; } /** *This structure defines a metric that is being used to evaluate the variations during a launch or experiment.
* @public */ export interface MetricDefinition { /** *The name of the metric.
* @public */ name?: string | undefined; /** *The entity, such as a user or session, that does an action that causes a metric value to be recorded.
* @public */ entityIdKey?: string | undefined; /** *The value that is tracked to produce the metric.
* @public */ valueKey?: string | undefined; /** *The EventBridge event pattern that defines how the metric is recorded.
For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
* @public */ eventPattern?: __AutomaticJsonStringConversion | string | undefined; /** *The label for the units that the metric is measuring.
* @public */ unitLabel?: string | undefined; } /** *A structure that tells Evidently whether higher or lower values are desired for a metric that is used in an experiment.
* @public */ export interface MetricGoal { /** *A structure that contains details about the metric.
* @public */ metricDefinition: MetricDefinition | undefined; /** * INCREASE means that a variation with a higher number for this metric is performing better.
DECREASE means that a variation with a lower number for this metric is performing better.
A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
* @public */ export interface OnlineAbDefinition { /** *The name of the variation that is the default variation that the other variations are compared to.
* @public */ controlTreatmentName?: string | undefined; /** *A set of key-value pairs. The keys are variation names, and the values are the portion of experiment traffic to be assigned to that variation. The traffic portion is specified in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.
* @public */ treatmentWeights?: RecordThis structure contains the time and date that Evidently completed the analysis of the experiment.
* @public */ export interface ExperimentSchedule { /** *The time and date that Evidently completed the analysis of the experiment.
* @public */ analysisCompleteTime?: Date | undefined; } /** *A structure that defines one treatment in an experiment. A treatment is a variation of the feature that you are including in the experiment.
* @public */ export interface Treatment { /** *The name of this treatment.
* @public */ name: string | undefined; /** *The description of the treatment.
* @public */ description?: string | undefined; /** *The feature variation used for this treatment. This is a key-value pair. The key is the feature name, and the value is the variation name.
* @public */ featureVariations?: RecordA structure containing the configuration details of an experiment.
* @public */ export interface Experiment { /** *The ARN of the experiment.
* @public */ arn: string | undefined; /** *The name of the experiment.
* @public */ name: string | undefined; /** *The name or ARN of the project that contains this experiment.
* @public */ project?: string | undefined; /** *The current state of the experiment.
* @public */ status: ExperimentStatus | undefined; /** *If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.
* @public */ statusReason?: string | undefined; /** *A description of the experiment.
* @public */ description?: string | undefined; /** *The date and time that the experiment is first created.
* @public */ createdTime: Date | undefined; /** *The date and time that the experiment was most recently updated.
* @public */ lastUpdatedTime: Date | undefined; /** *A structure that contains the time and date that Evidently completed the analysis of the experiment.
* @public */ schedule?: ExperimentSchedule | undefined; /** *A structure that contains the date and time that the experiment started and ended.
* @public */ execution?: ExperimentExecution | undefined; /** *An array of structures that describe the configuration of each feature variation used in the experiment.
* @public */ treatments?: Treatment[] | undefined; /** *An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.
* @public */ metricGoals?: MetricGoal[] | undefined; /** *This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.
In thousandths of a percent, the amount of the available audience that is allocated to this experiment. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.
This is represented in thousandths of a percent, so a value of 10,000 is 10% of the available audience.
* @public */ samplingRate?: number | undefined; /** *The audience segment being used for the experiment, if a segment is being used.
* @public */ segment?: string | undefined; /** *The type of this experiment. Currently, this value must be aws.experiment.onlineab.
A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
* @public */ onlineAbDefinition?: OnlineAbDefinition | undefined; /** *The list of tag keys and values associated with this experiment.
* @public */ tags?: RecordA structure containing the configuration details of the experiment that you created.
* @public */ experiment: Experiment | undefined; } /** *This structure contains the name and variation value of one variation of a feature.
* @public */ export interface VariationConfig { /** *The name of the variation.
* @public */ name: string | undefined; /** *The value assigned to this variation.
* @public */ value: VariableValue | undefined; } /** * @public */ export interface CreateFeatureRequest { /** *The name or ARN of the project that is to contain the new feature.
* @public */ project: string | undefined; /** *The name for the new feature.
* @public */ name: string | undefined; /** *Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or experiments. Specify DEFAULT_VARIATION to serve the default variation to all users instead.
An optional description of the feature.
* @public */ description?: string | undefined; /** *An array of structures that contain the configuration of the feature's different variations.
* @public */ variations: VariationConfig[] | undefined; /** *The name of the variation to use 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.
Assigns one or more tags (key-value pairs) to the feature.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with a feature.
For more information, see Tagging Amazon Web Services resources.
* @public */ tags?: RecordSpecify users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.
This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override.
* @public */ entityOverrides?: RecordA structure that contains the information about an evaluation rule for this feature, if it is used in a launch or experiment.
* @public */ export interface EvaluationRule { /** *The name of the experiment or launch.
* @public */ name?: string | undefined; /** *This value is aws.evidently.splits if this is an evaluation rule for a launch, and it is aws.evidently.onlineab if this is an evaluation rule for an experiment.
This structure contains the name and variation value of one variation of a feature.
* @public */ export interface Variation { /** *The name of the variation.
* @public */ name?: string | undefined; /** *The value assigned to this variation.
* @public */ value?: VariableValue | undefined; } /** *This structure contains information about one Evidently feature in your account.
* @public */ export interface Feature { /** *The ARN of the feature.
* @public */ arn: string | undefined; /** *The name of the feature.
* @public */ name: string | undefined; /** *The name or ARN of the project that contains the feature.
* @public */ project?: string | undefined; /** *The current state of the feature.
* @public */ status: FeatureStatus | undefined; /** *The date and time that the feature is created.
* @public */ createdTime: Date | undefined; /** *The date and time that the feature was most recently updated.
* @public */ lastUpdatedTime: Date | undefined; /** *The description of the feature.
* @public */ description?: string | undefined; /** *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.
Defines the type of value used to define the different feature variations. For more information, see Variation types
* @public */ valueType: VariationValueType | undefined; /** *An array of structures that contain the configuration of the feature's different variations.
* @public */ variations: Variation[] | undefined; /** *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.
An array of structures that define the evaluation rules for the feature.
* @public */ evaluationRules?: EvaluationRule[] | undefined; /** *The list of tag keys and values associated with this feature.
* @public */ tags?: RecordA 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.
A structure that contains information about the new feature.
* @public */ feature?: Feature | undefined; } /** *A structure that defines one launch group in a launch. A launch group is a variation of the feature that you are including in the launch.
* @public */ export interface LaunchGroupConfig { /** *A name for this launch group.
* @public */ name: string | undefined; /** *A description of the launch group.
* @public */ description?: string | undefined; /** *The feature that this launch is using.
* @public */ feature: string | undefined; /** *The feature variation to use for this launch group.
* @public */ variation: string | undefined; } /** *A structure that defines a metric to be used to monitor performance of the variations during a launch.
* @public */ export interface MetricMonitorConfig { /** *A structure that defines the metric.
* @public */ metricDefinition: MetricDefinitionConfig | undefined; } /** *This structure specifies a segment that you have already created, and defines the traffic split for that segment to be used in a launch.
* @public */ export interface SegmentOverride { /** *The ARN of the segment to use.
* @public */ segment: string | undefined; /** *A number indicating the order to use to evaluate segment overrides, if there are more than one. Segment overrides with lower numbers are evaluated first.
* @public */ evaluationOrder: number | undefined; /** *The traffic allocation percentages among the feature variations to assign to this segment. This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic.
* @public */ weights: RecordThis structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.
* @public */ export interface ScheduledSplitConfig { /** *The date and time that this step of the launch starts.
* @public */ startTime: Date | undefined; /** *The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.
The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.
If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.
* @public */ groupWeights: RecordUse this parameter to specify different traffic splits for one or more audience segments. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.
This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.
* @public */ segmentOverrides?: SegmentOverride[] | undefined; } /** *An array of structures that define the traffic allocation percentages among the feature variations during each step of a launch. This also defines the start time of each step.
* @public */ export interface ScheduledSplitsLaunchConfig { /** *An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.
* @public */ steps: ScheduledSplitConfig[] | undefined; } /** * @public */ export interface CreateLaunchRequest { /** *The name or ARN of the project that you want to create the launch in.
* @public */ project: string | undefined; /** *The name for the new launch.
* @public */ name: string | undefined; /** *An optional description for the launch.
* @public */ description?: string | undefined; /** *An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
* @public */ scheduledSplitsConfig?: ScheduledSplitsLaunchConfig | undefined; /** *An array of structures that define the metrics that will be used to monitor the launch performance.
* @public */ metricMonitors?: MetricMonitorConfig[] | undefined; /** *An array of structures that contains the feature and variations that are to be used for the launch.
* @public */ groups: LaunchGroupConfig[] | undefined; /** *When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the launch name as the randomizationSalt.
Assigns one or more tags (key-value pairs) to the launch.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with a launch.
For more information, see Tagging Amazon Web Services resources.
* @public */ tags?: RecordThis structure contains information about the start and end times of the launch.
* @public */ export interface LaunchExecution { /** *The date and time that the launch started.
* @public */ startedTime?: Date | undefined; /** *The date and time that the launch ended.
* @public */ endedTime?: Date | undefined; } /** *A structure that defines one launch group in a launch. A launch group is a variation of the feature that you are including in the launch.
* @public */ export interface LaunchGroup { /** *The name of the launch group.
* @public */ name: string | undefined; /** *A description of the launch group.
* @public */ description?: string | undefined; /** *The feature variation for this launch group. This is a key-value pair.
* @public */ featureVariations: RecordA structure that defines a metric to be used to monitor performance of the variations during a launch.
* @public */ export interface MetricMonitor { /** *A structure that defines the metric.
* @public */ metricDefinition: MetricDefinition | undefined; } /** *This structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.
* @public */ export interface ScheduledSplit { /** *The date and time that this step of the launch starts.
* @public */ startTime: Date | undefined; /** *The traffic allocation percentages among the feature variations during one step of a launch. This is a set of key-value pairs. The keys are variation names. The values represent the percentage of traffic to allocate to that variation during this step.
The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.
If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.
* @public */ groupWeights?: RecordUse this parameter to specify different traffic splits for one or more audience segments. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.
This parameter is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.
* @public */ segmentOverrides?: SegmentOverride[] | undefined; } /** *An array of structures that define the traffic allocation percentages among the feature variations during each step of a launch. This also defines the start time of each step.
* @public */ export interface ScheduledSplitsLaunchDefinition { /** *An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. This also defines the start time of each step.
* @public */ steps?: ScheduledSplit[] | undefined; } /** *This structure contains the configuration details of one Evidently launch.
* @public */ export interface Launch { /** *The ARN of the launch.
* @public */ arn: string | undefined; /** *The name of the launch.
* @public */ name: string | undefined; /** *The name or ARN of the project that contains the launch.
* @public */ project?: string | undefined; /** *The current state of the launch.
* @public */ status: LaunchStatus | undefined; /** *If the launch was stopped, this is the string that was entered by the person who stopped the launch, to explain why it was stopped.
* @public */ statusReason?: string | undefined; /** *The description of the launch.
* @public */ description?: string | undefined; /** *The date and time that the launch is created.
* @public */ createdTime: Date | undefined; /** *The date and time that the launch was most recently updated.
* @public */ lastUpdatedTime: Date | undefined; /** *A structure that contains information about the start and end times of the launch.
* @public */ execution?: LaunchExecution | undefined; /** *An array of structures that define the feature variations that are being used in the launch.
* @public */ groups?: LaunchGroup[] | undefined; /** *An array of structures that define the metrics that are being used to monitor the launch performance.
* @public */ metricMonitors?: MetricMonitor[] | undefined; /** *This value is used when Evidently assigns a particular user session to the launch, to help create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.
The type of launch.
* @public */ type: LaunchType | undefined; /** *An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
* @public */ scheduledSplitsDefinition?: ScheduledSplitsLaunchDefinition | undefined; /** *The list of tag keys and values associated with this launch.
* @public */ tags?: RecordA structure that contains the configuration of the launch that was created.
* @public */ launch: Launch | undefined; } /** *Use this parameter to configure client-side evaluation for your project. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation to assign the variations. This mitigates the latency and availability risks that come with an API call.
ProjectAppConfigResource is a structure that defines the configuration of how your application integrates with AppConfig to run client-side evaluation.
The ID of the AppConfig application to use for client-side evaluation.
* @public */ applicationId?: string | undefined; /** *The ID of the AppConfig environment to use for client-side evaluation. This must be an environment that is within the application that you specify for applicationId.
If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
* @public */ export interface S3DestinationConfig { /** *The name of the bucket in which Evidently stores evaluation events.
* @public */ bucket?: string | undefined; /** *The bucket prefix in which Evidently stores evaluation events.
* @public */ prefix?: string | undefined; } /** *A structure that contains information about where Evidently is to store evaluation events for longer term storage.
* @public */ export interface ProjectDataDeliveryConfig { /** *If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
* @public */ s3Destination?: S3DestinationConfig | undefined; /** *If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.
* @public */ cloudWatchLogs?: CloudWatchLogsDestinationConfig | undefined; } /** * @public */ export interface CreateProjectRequest { /** *The name for the project.
* @public */ name: string | undefined; /** *An optional description of the project.
* @public */ description?: string | undefined; /** *A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so. If you choose not to store these events, Evidently deletes them after using them to produce metrics and other experiment results that you can view.
* @public */ dataDelivery?: ProjectDataDeliveryConfig | undefined; /** *Use this parameter if the project will use client-side evaluation powered by AppConfig. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation. This mitigates the latency and availability risks that come with an API call. For more information, see Client-side evaluation - powered by AppConfig.
This parameter is a structure that contains information about the AppConfig application and environment that will be used as for client-side evaluation.
To create a project that uses client-side evaluation, you must have the evidently:ExportProjectAsConfiguration permission.
Assigns one or more tags (key-value pairs) to the project.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with a project.
For more information, see Tagging Amazon Web Services resources.
* @public */ tags?: RecordThis is a structure that defines the configuration of how your application integrates with AppConfig to run client-side evaluation.
* @public */ export interface ProjectAppConfigResource { /** *The ID of the AppConfig application to use for client-side evaluation.
* @public */ applicationId: string | undefined; /** *The ID of the AppConfig environment to use for client-side evaluation. This must be an environment that is within the application that you specify for applicationId.
The ID of the AppConfig profile to use for client-side evaluation.
* @public */ configurationProfileId: string | undefined; } /** *If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
* @public */ export interface S3Destination { /** *The name of the bucket in which Evidently stores evaluation events.
* @public */ bucket?: string | undefined; /** *The bucket prefix in which Evidently stores evaluation events.
* @public */ prefix?: string | undefined; } /** *A structure that contains information about where Evidently is to store evaluation events for longer term storage.
* @public */ export interface ProjectDataDelivery { /** *If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
* @public */ s3Destination?: S3Destination | undefined; /** *If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.
* @public */ cloudWatchLogs?: CloudWatchLogsDestination | undefined; } /** *This structure defines a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together.
* @public */ export interface Project { /** *The name or ARN of the project.
* @public */ arn: string | undefined; /** *The name of the project.
* @public */ name: string | undefined; /** *The current state of the project.
* @public */ status: ProjectStatus | undefined; /** *The user-entered description of the project.
* @public */ description?: string | undefined; /** *The date and time that the project is created.
* @public */ createdTime: Date | undefined; /** *The date and time that the project was most recently updated.
* @public */ lastUpdatedTime: Date | undefined; /** *The number of features currently in the project.
* @public */ featureCount?: number | undefined; /** *The number of launches currently in the project. This includes all launches that have been created and not deleted, whether they are ongoing or not.
* @public */ launchCount?: number | undefined; /** *The number of ongoing launches currently in the project.
* @public */ activeLaunchCount?: number | undefined; /** *The number of experiments currently in the project. This includes all experiments that have been created and not deleted, whether they are ongoing or not.
* @public */ experimentCount?: number | undefined; /** *The number of ongoing experiments currently in the project.
* @public */ activeExperimentCount?: number | undefined; /** *A structure that contains information about where Evidently is to store evaluation events for longer term storage.
* @public */ dataDelivery?: ProjectDataDelivery | undefined; /** *This structure defines the configuration of how your application integrates with AppConfig to run client-side evaluation.
* @public */ appConfigResource?: ProjectAppConfigResource | undefined; /** *The list of tag keys and values associated with this project.
* @public */ tags?: RecordA structure that contains information about the created project.
* @public */ project: Project | undefined; } /** * @public */ export interface CreateSegmentRequest { /** *A name for the segment.
* @public */ name: string | undefined; /** *The pattern to use for the segment. For more information about pattern syntax, see Segment rule pattern syntax.
* @public */ pattern: __AutomaticJsonStringConversion | string | undefined; /** *An optional description for this segment.
* @public */ description?: string | undefined; /** *Assigns one or more tags (key-value pairs) to the segment.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can associate as many as 50 tags with a segment.
For more information, see Tagging Amazon Web Services resources.
* @public */ tags?: RecordThis structure contains information about one audience segment. You can use segments in your experiments and launches to narrow the user sessions used for experiment or launch to only the user sessions that match one or more criteria.
* @public */ export interface Segment { /** *The ARN of the segment.
* @public */ arn: string | undefined; /** *The name of the segment.
* @public */ name: string | undefined; /** *The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see Segment rule pattern syntax.
* @public */ pattern: __AutomaticJsonStringConversion | string | undefined; /** *The date and time that this segment was created.
* @public */ createdTime: Date | undefined; /** *The date and time that this segment was most recently updated.
* @public */ lastUpdatedTime: Date | undefined; /** *The customer-created description for this segment.
* @public */ description?: string | undefined; /** *The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.
* @public */ experimentCount?: number | undefined; /** *The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.
* @public */ launchCount?: number | undefined; /** *The list of tag keys and values associated with this launch.
* @public */ tags?: RecordA structure that contains the complete information about the segment that was just created.
* @public */ segment: Segment | undefined; } /** * @public */ export interface DeleteExperimentRequest { /** *The name or ARN of the project that contains the experiment to delete.
* @public */ project: string | undefined; /** *The name of the experiment to delete.
* @public */ experiment: string | undefined; } /** * @public */ export interface DeleteExperimentResponse { } /** * @public */ export interface DeleteFeatureRequest { /** *The name or ARN of the project that contains the feature to delete.
* @public */ project: string | undefined; /** *The name of the feature to delete.
* @public */ feature: string | undefined; } /** * @public */ export interface DeleteFeatureResponse { } /** * @public */ export interface DeleteLaunchRequest { /** *The name or ARN of the project that contains the launch to delete.
* @public */ project: string | undefined; /** *The name of the launch to delete.
* @public */ launch: string | undefined; } /** * @public */ export interface DeleteLaunchResponse { } /** * @public */ export interface DeleteProjectRequest { /** *The name or ARN of the project to delete.
* @public */ project: string | undefined; } /** * @public */ export interface DeleteProjectResponse { } /** * @public */ export interface DeleteSegmentRequest { /** *Specifies the segment to delete.
* @public */ segment: string | undefined; } /** * @public */ export interface DeleteSegmentResponse { } /** * @public */ export interface EvaluateFeatureRequest { /** *The name or ARN of the project that contains this feature.
* @public */ project: string | undefined; /** *The name of the feature being evaluated.
* @public */ feature: string | undefined; /** *An internal ID that represents a unique user of the application. This entityID is checked against any override rules assigned for this feature.
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.
If you include this parameter, the value must be a JSON object. A JSON array is not supported.
* @public */ evaluationContext?: __AutomaticJsonStringConversion | string | undefined; } /** * @public */ export interface EvaluateFeatureResponse { /** *The name of the variation that was served to the user session.
* @public */ variation?: string | undefined; /** *The value assigned to this variation to differentiate it from the other variations of this feature.
* @public */ value?: VariableValue | undefined; /** *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.
If this user was assigned to a launch or experiment, this field lists the launch or experiment name.
* @public */ details?: __AutomaticJsonStringConversion | string | undefined; } /** *A structure that contains the information about one evaluation event or custom event sent to Evidently. This is a JSON payload. If this event specifies a pre-defined event type, the payload must follow the defined event schema.
* @public */ export interface Event { /** *The timestamp of the event.
* @public */ timestamp: Date | undefined; /** * aws.evidently.evaluation specifies an evaluation event, which determines which feature variation that a user sees. aws.evidently.custom specifies a custom event, which generates metrics from user actions such as clicks and checkouts.
The event data.
* @public */ data: __AutomaticJsonStringConversion | string | undefined; } /** * @public */ export interface ListTagsForResourceRequest { /** *The ARN of the resource that you want to see the tags of.
* @public */ resourceArn: string | undefined; } /** * @public */ export interface ListTagsForResourceResponse { /** *The list of tag keys and values associated with the resource you specified.
* @public */ tags?: RecordThe name or ARN of the project that contains the experiment.
* @public */ project: string | undefined; /** *The name of the experiment that you want to see the details of.
* @public */ experiment: string | undefined; } /** * @public */ export interface GetExperimentResponse { /** *A structure containing the configuration details of the experiment.
* @public */ experiment?: Experiment | undefined; } /** * @public */ export interface GetExperimentResultsRequest { /** *The name or ARN of the project that contains the experiment that you want to see the results of.
* @public */ project: string | undefined; /** *The name of the experiment to retrieve the results of.
* @public */ experiment: string | undefined; /** *The date and time that the experiment started.
* @public */ startTime?: Date | undefined; /** *The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.
* @public */ endTime?: Date | undefined; /** *The names of the experiment metrics that you want to see the results of.
* @public */ metricNames: string[] | undefined; /** *The names of the experiment treatments that you want to see the results for.
* @public */ treatmentNames: string[] | undefined; /** *The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.
The statistics that you want to see in the returned results.
PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.
ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.
TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.
BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.
The names of the report types that you want to see. Currently, BayesianInference is the only valid value.
In seconds, the amount of time to aggregate results together.
* @public */ period?: number | undefined; } /** *A structure that contains results of an experiment.
* @public */ export interface ExperimentReport { /** *The name of the metric that is analyzed in this experiment report.
* @public */ metricName?: string | undefined; /** *The name of the variation that this report pertains to.
* @public */ treatmentName?: string | undefined; /** *The type of analysis used for this report.
* @public */ reportName?: ExperimentReportName | undefined; /** *The content of the report.
* @public */ content?: __AutomaticJsonStringConversion | string | undefined; } /** *A structure that contains experiment results for one metric that is monitored in the experiment.
* @public */ export interface ExperimentResultsData { /** *The name of the metric.
* @public */ metricName?: string | undefined; /** *The treatment, or variation, that returned the values in this structure.
The experiment statistic that these results pertain to.
* @public */ resultStat?: ExperimentResultResponseType | undefined; /** *The values for the metricName that were recorded in the experiment.
An array of structures that include experiment results including metric names and values.
* @public */ resultsData?: ExperimentResultsData[] | undefined; /** *An array of structures that include the reports that you requested.
* @public */ reports?: ExperimentReport[] | undefined; /** *The timestamps of each result returned.
* @public */ timestamps?: Date[] | undefined; /** *If the experiment doesn't yet have enough events to provide valid results, this field is returned with the message Not enough events to generate results. If there are enough events to provide valid results, this field is not returned.
The name or ARN of the project to return the experiment list from.
* @public */ project: string | undefined; /** *The maximum number of results to include in the response.
* @public */ maxResults?: number | undefined; /** *The token to use when requesting the next set of results. You received this token from a previous ListExperiments operation.
Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.
* @public */ status?: ExperimentStatus | undefined; } /** * @public */ export interface ListExperimentsResponse { /** *An array of structures that contain the configuration details of the experiments in the specified project.
* @public */ experiments?: Experiment[] | undefined; /** *The token to use in a subsequent ListExperiments operation to return the next set of results.
The name or ARN of the project that contains the experiment to start.
* @public */ project: string | undefined; /** *The name of the experiment to start.
* @public */ experiment: string | undefined; /** *The date and time to end the experiment. This must be no more than 30 days after the experiment starts.
* @public */ analysisCompleteTime: Date | undefined; } /** * @public */ export interface StartExperimentResponse { /** *A timestamp that indicates when the experiment started.
* @public */ startedTime?: Date | undefined; } /** * @public */ export interface StopExperimentRequest { /** *The name or ARN of the project that contains the experiment to stop.
* @public */ project: string | undefined; /** *The name of the experiment to stop.
* @public */ experiment: string | undefined; /** *Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.
A string that describes why you are stopping the experiment.
* @public */ reason?: string | undefined; } /** * @public */ export interface StopExperimentResponse { /** *The date and time that the experiment stopped.
* @public */ endedTime?: Date | undefined; } /** * @public */ export interface UpdateExperimentRequest { /** *The name or ARN of the project that contains the experiment that you want to update.
* @public */ project: string | undefined; /** *The name of the experiment to update.
* @public */ experiment: string | undefined; /** *An optional description of the experiment.
* @public */ description?: string | undefined; /** *An array of structures that define the variations being tested in the experiment.
* @public */ treatments?: TreatmentConfig[] | undefined; /** *An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.
* @public */ metricGoals?: MetricGoalConfig[] | undefined; /** *When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the experiment name as the randomizationSalt.
The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.
This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.
* @public */ samplingRate?: number | undefined; /** *Adds an audience segment to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.
* @public */ segment?: string | undefined; /** *Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.
* @public */ removeSegment?: boolean | undefined; /** *A structure that contains the configuration of which variation o use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
* @public */ onlineAbConfig?: OnlineAbConfig | undefined; } /** * @public */ export interface UpdateExperimentResponse { /** *A structure containing the configuration details of the experiment that was updated.
* @public */ experiment: Experiment | undefined; } /** * @public */ export interface GetFeatureRequest { /** *The name or ARN of the project that contains the feature.
* @public */ project: string | undefined; /** *The name of the feature that you want to retrieve information for.
* @public */ feature: string | undefined; } /** * @public */ export interface GetFeatureResponse { /** *A structure containing the configuration details of the feature.
* @public */ feature: Feature | undefined; } /** * @public */ export interface ListFeaturesRequest { /** *The name or ARN of the project to return the feature list from.
* @public */ project: string | undefined; /** *The maximum number of results to include in the response.
* @public */ maxResults?: number | undefined; /** *The token to use when requesting the next set of results. You received this token from a previous ListFeatures operation.
This structure contains information about one Evidently feature in your account.
* @public */ export interface FeatureSummary { /** *The ARN of the feature.
* @public */ arn: string | undefined; /** *The name of the feature.
* @public */ name: string | undefined; /** *The name or ARN of the project that contains the feature.
* @public */ project?: string | undefined; /** *The current state of the feature.
* @public */ status: FeatureStatus | undefined; /** *The date and time that the feature is created.
* @public */ createdTime: Date | undefined; /** *The date and time that the feature was most recently updated.
* @public */ lastUpdatedTime: Date | undefined; /** *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.
An array of structures that define
* @public */ evaluationRules?: EvaluationRule[] | undefined; /** *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.
* @public */ defaultVariation?: string | undefined; /** *The list of tag keys and values associated with this feature.
* @public */ tags?: RecordAn array of structures that contain the configuration details of the features in the specified project.
* @public */ features?: FeatureSummary[] | undefined; /** *The token to use in a subsequent ListFeatures operation to return the next set of results.
The name or ARN of the project that contains the feature to be updated.
* @public */ project: string | undefined; /** *The name of the feature to be updated.
* @public */ feature: string | undefined; /** *Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or experiments. Specify DEFAULT_VARIATION to serve the default variation to all users instead.
An optional description of the feature.
* @public */ description?: string | undefined; /** *To update variation configurations for this feature, or add new ones, specify this structure. In this array, include any variations that you want to add or update. If the array includes a variation name that already exists for this feature, it is updated. If it includes a new variation name, it is added as a new variation.
* @public */ addOrUpdateVariations?: VariationConfig[] | undefined; /** *Removes a variation from the feature. If the variation you specify doesn't exist, then this makes no change and does not report an error.
This operation fails if you try to remove a variation that is part of an ongoing launch or experiment.
* @public */ removeVariations?: string[] | undefined; /** *The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.
* @public */ defaultVariation?: string | undefined; /** *Specified users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.
This parameter is limited to 2500 overrides or a total of 40KB. The 40KB limit includes an overhead of 6 bytes per override.
* @public */ entityOverrides?: RecordA structure that contains information about the updated feature.
* @public */ feature: Feature | undefined; } /** * @public */ export interface GetProjectRequest { /** *The name or ARN of the project that you want to see the details of.
* @public */ project: string | undefined; } /** * @public */ export interface GetProjectResponse { /** *A structure containing the configuration details of the project.
* @public */ project: Project | undefined; } /** * @public */ export interface GetLaunchRequest { /** *The name or ARN of the project that contains the launch.
* @public */ project: string | undefined; /** *The name of the launch that you want to see the details of.
* @public */ launch: string | undefined; } /** * @public */ export interface GetLaunchResponse { /** *A structure containing the configuration details of the launch.
* @public */ launch?: Launch | undefined; } /** * @public */ export interface ListLaunchesRequest { /** *The name or ARN of the project to return the launch list from.
* @public */ project: string | undefined; /** *The maximum number of results to include in the response.
* @public */ maxResults?: number | undefined; /** *The token to use when requesting the next set of results. You received this token from a previous ListLaunches operation.
Use this optional parameter to limit the returned results to only the launches with the status that you specify here.
* @public */ status?: LaunchStatus | undefined; } /** * @public */ export interface ListLaunchesResponse { /** *An array of structures that contain the configuration details of the launches in the specified project.
* @public */ launches?: Launch[] | undefined; /** *The token to use in a subsequent ListLaunches operation to return the next set of results.
The name or ARN of the project that contains the launch to start.
* @public */ project: string | undefined; /** *The name of the launch to start.
* @public */ launch: string | undefined; } /** * @public */ export interface StartLaunchResponse { /** *A structure that contains information about the launch that was started.
* @public */ launch: Launch | undefined; } /** * @public */ export interface StopLaunchRequest { /** *The name or ARN of the project that contains the launch that you want to stop.
* @public */ project: string | undefined; /** *The name of the launch to stop.
* @public */ launch: string | undefined; /** *Specify whether to consider the launch as COMPLETED or CANCELLED after it stops.
A string that describes why you are stopping the launch.
* @public */ reason?: string | undefined; } /** * @public */ export interface StopLaunchResponse { /** *The date and time that the launch stopped.
* @public */ endedTime?: Date | undefined; } /** * @public */ export interface UpdateLaunchRequest { /** *The name or ARN of the project that contains the launch that you want to update.
* @public */ project: string | undefined; /** *The name of the launch that is to be updated.
* @public */ launch: string | undefined; /** *An optional description for the launch.
* @public */ description?: string | undefined; /** *An array of structures that contains the feature and variations that are to be used for the launch.
* @public */ groups?: LaunchGroupConfig[] | undefined; /** *An array of structures that define the metrics that will be used to monitor the launch performance.
* @public */ metricMonitors?: MetricMonitorConfig[] | undefined; /** *When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the launch name as the randomizationSalt.
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
* @public */ scheduledSplitsConfig?: ScheduledSplitsLaunchConfig | undefined; } /** * @public */ export interface UpdateLaunchResponse { /** *A structure that contains the new configuration of the launch that was updated.
* @public */ launch: Launch | undefined; } /** * @public */ export interface ListProjectsRequest { /** *The maximum number of results to include in the response.
* @public */ maxResults?: number | undefined; /** *The token to use when requesting the next set of results. You received this token from a previous ListProjects operation.
A structure that contains configuration information about an Evidently project.
* @public */ export interface ProjectSummary { /** *The name or ARN of the project.
* @public */ arn: string | undefined; /** *The name of the project.
* @public */ name: string | undefined; /** *The current state of the project.
* @public */ status: ProjectStatus | undefined; /** *The description of the project.
* @public */ description?: string | undefined; /** *The date and time that the project is created.
* @public */ createdTime: Date | undefined; /** *The date and time that the project was most recently updated.
* @public */ lastUpdatedTime: Date | undefined; /** *The number of features currently in the project.
* @public */ featureCount?: number | undefined; /** *The number of launches currently in the project, including launches that are ongoing, completed, and not started yet.
* @public */ launchCount?: number | undefined; /** *The number of ongoing launches currently in the project.
* @public */ activeLaunchCount?: number | undefined; /** *The number of experiments currently in the project.
* @public */ experimentCount?: number | undefined; /** *The number of experiments currently in the project.
* @public */ activeExperimentCount?: number | undefined; /** *The list of tag keys and values associated with this project.
* @public */ tags?: RecordAn array of structures that contain the configuration details of the projects in the Region.
* @public */ projects?: ProjectSummary[] | undefined; /** *The token to use in a subsequent ListProjects operation to return the next set of results.
The name or ARN of the project to write the events to.
* @public */ project: string | undefined; /** *An array of event structures that contain the performance data that is being sent to Evidently.
* @public */ events: Event[] | undefined; } /** *A structure that contains Evidently's response to the sent events, including an event ID and error codes, if any.
* @public */ export interface PutProjectEventsResultEntry { /** *A unique ID assigned to this PutProjectEvents operation.
If the PutProjectEvents operation has an error, the error code is returned here.
If the PutProjectEvents operation has an error, the error message is returned here.
The number of events in the operation that could not be used by Evidently.
* @public */ failedEventCount?: number | undefined; /** *A structure that contains Evidently's response to the sent events, including an event ID and error codes, if any.
* @public */ eventResults?: PutProjectEventsResultEntry[] | undefined; } /** * @public */ export interface UpdateProjectRequest { /** *The name or ARN of the project to update.
* @public */ project: string | undefined; /** *Use this parameter if the project will use client-side evaluation powered by AppConfig. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation. This mitigates the latency and availability risks that come with an API call. allows you to
This parameter is a structure that contains information about the AppConfig application that will be used for client-side evaluation.
* @public */ appConfigResource?: ProjectAppConfigResourceConfig | undefined; /** *An optional description of the project.
* @public */ description?: string | undefined; } /** * @public */ export interface UpdateProjectResponse { /** *A structure containing information about the updated project.
* @public */ project: Project | undefined; } /** * @public */ export interface UpdateProjectDataDeliveryRequest { /** *The name or ARN of the project that you want to modify the data storage options for.
* @public */ project: string | undefined; /** *A structure containing the S3 bucket name and bucket prefix where you want to store evaluation events.
* @public */ s3Destination?: S3DestinationConfig | undefined; /** *A structure containing the CloudWatch Logs log group where you want to store evaluation events.
* @public */ cloudWatchLogs?: CloudWatchLogsDestinationConfig | undefined; } /** * @public */ export interface UpdateProjectDataDeliveryResponse { /** *A structure containing details about the project that you updated.
* @public */ project: Project | undefined; } /** * @public */ export interface GetSegmentRequest { /** *The ARN of the segment to return information for.
* @public */ segment: string | undefined; } /** * @public */ export interface GetSegmentResponse { /** *A structure that contains the complete information about the segment.
* @public */ segment: Segment | undefined; } /** * @public */ export interface ListSegmentReferencesRequest { /** *The ARN of the segment that you want to view information for.
* @public */ segment: string | undefined; /** *The maximum number of results to include in the response. If you omit this, the default of 50 is used.
* @public */ maxResults?: number | undefined; /** *The token to use when requesting the next set of results. You received this token from a previous ListSegmentReferences operation.
Specifies whether to return information about launches or experiments that use this segment.
* @public */ type: SegmentReferenceResourceType | undefined; } /** *A structure that contains information about one experiment or launch that uses the specified segment.
* @public */ export interface RefResource { /** *The name of the experiment or launch.
* @public */ name: string | undefined; /** *Specifies whether the resource that this structure contains information about is an experiment or a launch.
* @public */ type: string | undefined; /** *The ARN of the experiment or launch.
* @public */ arn?: string | undefined; /** *The status of the experiment or launch.
* @public */ status?: string | undefined; /** *The day and time that this experiment or launch started.
* @public */ startTime?: string | undefined; /** *The day and time that this experiment or launch ended.
* @public */ endTime?: string | undefined; /** *The day and time that this experiment or launch was most recently updated.
* @public */ lastUpdatedOn?: string | undefined; } /** * @public */ export interface ListSegmentReferencesResponse { /** *An array of structures, where each structure contains information about one experiment or launch that uses this segment.
* @public */ referencedBy?: RefResource[] | undefined; /** *The token to use in a subsequent ListSegmentReferences operation to return the next set of results.
The maximum number of results to include in the response. If you omit this, the default of 50 is used.
* @public */ maxResults?: number | undefined; /** *The token to use when requesting the next set of results. You received this token from a previous ListSegments operation.
An array of structures that contain information about the segments in this Region.
* @public */ segments?: Segment[] | undefined; /** *The token to use in a subsequent ListSegments operation to return the next set of results.
The ARN of the CloudWatch Evidently resource that you're adding tags to.
* @public */ resourceArn: string | undefined; /** *The list of key-value pairs to associate with the resource.
* @public */ tags: RecordThe pattern to test.
* @public */ pattern: __AutomaticJsonStringConversion | string | undefined; /** *A sample evaluationContext JSON block to test against the specified pattern.
Returns true if the pattern matches the payload.
The ARN of the CloudWatch Evidently resource that you're removing tags from.
* @public */ resourceArn: string | undefined; /** *The list of tag keys to remove from the resource.
* @public */ tagKeys: string[] | undefined; } /** * @public */ export interface UntagResourceResponse { }