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 |
- Operations
- BatchEvaluateFeature
- CreateExperiment
- CreateFeature
- CreateLaunch
- CreateProject
- CreateSegment
- DeleteExperiment
- DeleteFeature
- DeleteLaunch
- DeleteProject
- DeleteSegment
- EvaluateFeature
- GetExperiment
- GetExperimentResults
- GetFeature
- GetLaunch
- GetProject
- GetSegment
- ListExperiments
- ListFeatures
- ListLaunches
- ListProjects
- ListSegmentReferences
- ListSegments
- ListTagsForResource
- PutProjectEvents
- StartExperiment
- StartLaunch
- StopExperiment
- StopLaunch
- TagResource
- TestSegmentPattern
- UntagResource
- UpdateExperiment
- UpdateFeature
- UpdateLaunch
- UpdateProject
- UpdateProjectDataDelivery
- Types
- CloudWatchLogsDestination
- CloudWatchLogsDestinationConfig
- EvaluationRequest
- EvaluationResult
- EvaluationRule
- Event
- Experiment
- ExperimentExecution
- ExperimentReport
- ExperimentResultsData
- ExperimentSchedule
- Feature
- FeatureSummary
- Launch
- LaunchExecution
- LaunchGroup
- LaunchGroupConfig
- MetricDefinition
- MetricDefinitionConfig
- MetricGoal
- MetricGoalConfig
- MetricMonitor
- MetricMonitorConfig
- OnlineAbConfig
- OnlineAbDefinition
- Project
- ProjectAppConfigResource
- ProjectAppConfigResourceConfig
- ProjectDataDelivery
- ProjectDataDeliveryConfig
- ProjectSummary
- PutProjectEventsResultEntry
- RefResource
- S3Destination
- S3DestinationConfig
- ScheduledSplit
- ScheduledSplitConfig
- ScheduledSplitsLaunchConfig
- ScheduledSplitsLaunchDefinition
- Segment
- SegmentOverride
- Treatment
- TreatmentConfig
- VariableValue
- Variation
- VariationConfig
Synopsis
- batchEvaluateFeature_project :: Lens' BatchEvaluateFeature Text
- batchEvaluateFeature_requests :: Lens' BatchEvaluateFeature (NonEmpty EvaluationRequest)
- batchEvaluateFeatureResponse_results :: Lens' BatchEvaluateFeatureResponse (Maybe [EvaluationResult])
- batchEvaluateFeatureResponse_httpStatus :: Lens' BatchEvaluateFeatureResponse Int
- createExperiment_description :: Lens' CreateExperiment (Maybe Text)
- createExperiment_onlineAbConfig :: Lens' CreateExperiment (Maybe OnlineAbConfig)
- createExperiment_randomizationSalt :: Lens' CreateExperiment (Maybe Text)
- createExperiment_samplingRate :: Lens' CreateExperiment (Maybe Natural)
- createExperiment_segment :: Lens' CreateExperiment (Maybe Text)
- createExperiment_tags :: Lens' CreateExperiment (Maybe (HashMap Text Text))
- createExperiment_metricGoals :: Lens' CreateExperiment (NonEmpty MetricGoalConfig)
- createExperiment_name :: Lens' CreateExperiment Text
- createExperiment_project :: Lens' CreateExperiment Text
- createExperiment_treatments :: Lens' CreateExperiment [TreatmentConfig]
- createExperimentResponse_httpStatus :: Lens' CreateExperimentResponse Int
- createExperimentResponse_experiment :: Lens' CreateExperimentResponse Experiment
- createFeature_defaultVariation :: Lens' CreateFeature (Maybe Text)
- createFeature_description :: Lens' CreateFeature (Maybe Text)
- createFeature_entityOverrides :: Lens' CreateFeature (Maybe (HashMap Text Text))
- createFeature_evaluationStrategy :: Lens' CreateFeature (Maybe FeatureEvaluationStrategy)
- createFeature_tags :: Lens' CreateFeature (Maybe (HashMap Text Text))
- createFeature_name :: Lens' CreateFeature Text
- createFeature_project :: Lens' CreateFeature Text
- createFeature_variations :: Lens' CreateFeature (NonEmpty VariationConfig)
- createFeatureResponse_feature :: Lens' CreateFeatureResponse (Maybe Feature)
- createFeatureResponse_httpStatus :: Lens' CreateFeatureResponse Int
- createLaunch_description :: Lens' CreateLaunch (Maybe Text)
- createLaunch_metricMonitors :: Lens' CreateLaunch (Maybe [MetricMonitorConfig])
- createLaunch_randomizationSalt :: Lens' CreateLaunch (Maybe Text)
- createLaunch_scheduledSplitsConfig :: Lens' CreateLaunch (Maybe ScheduledSplitsLaunchConfig)
- createLaunch_tags :: Lens' CreateLaunch (Maybe (HashMap Text Text))
- createLaunch_groups :: Lens' CreateLaunch (NonEmpty LaunchGroupConfig)
- createLaunch_name :: Lens' CreateLaunch Text
- createLaunch_project :: Lens' CreateLaunch Text
- createLaunchResponse_httpStatus :: Lens' CreateLaunchResponse Int
- createLaunchResponse_launch :: Lens' CreateLaunchResponse Launch
- createProject_appConfigResource :: Lens' CreateProject (Maybe ProjectAppConfigResourceConfig)
- createProject_dataDelivery :: Lens' CreateProject (Maybe ProjectDataDeliveryConfig)
- createProject_description :: Lens' CreateProject (Maybe Text)
- createProject_tags :: Lens' CreateProject (Maybe (HashMap Text Text))
- createProject_name :: Lens' CreateProject Text
- createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int
- createProjectResponse_project :: Lens' CreateProjectResponse Project
- createSegment_description :: Lens' CreateSegment (Maybe Text)
- createSegment_tags :: Lens' CreateSegment (Maybe (HashMap Text Text))
- createSegment_name :: Lens' CreateSegment Text
- createSegment_pattern :: Lens' CreateSegment Text
- createSegmentResponse_httpStatus :: Lens' CreateSegmentResponse Int
- createSegmentResponse_segment :: Lens' CreateSegmentResponse Segment
- deleteExperiment_experiment :: Lens' DeleteExperiment Text
- deleteExperiment_project :: Lens' DeleteExperiment Text
- deleteExperimentResponse_httpStatus :: Lens' DeleteExperimentResponse Int
- deleteFeature_feature :: Lens' DeleteFeature Text
- deleteFeature_project :: Lens' DeleteFeature Text
- deleteFeatureResponse_httpStatus :: Lens' DeleteFeatureResponse Int
- deleteLaunch_launch :: Lens' DeleteLaunch Text
- deleteLaunch_project :: Lens' DeleteLaunch Text
- deleteLaunchResponse_httpStatus :: Lens' DeleteLaunchResponse Int
- deleteProject_project :: Lens' DeleteProject Text
- deleteProjectResponse_httpStatus :: Lens' DeleteProjectResponse Int
- deleteSegment_segment :: Lens' DeleteSegment Text
- deleteSegmentResponse_httpStatus :: Lens' DeleteSegmentResponse Int
- evaluateFeature_evaluationContext :: Lens' EvaluateFeature (Maybe Text)
- evaluateFeature_entityId :: Lens' EvaluateFeature Text
- evaluateFeature_feature :: Lens' EvaluateFeature Text
- evaluateFeature_project :: Lens' EvaluateFeature Text
- 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
- getExperiment_experiment :: Lens' GetExperiment Text
- getExperiment_project :: Lens' GetExperiment Text
- getExperimentResponse_experiment :: Lens' GetExperimentResponse (Maybe Experiment)
- getExperimentResponse_httpStatus :: Lens' GetExperimentResponse Int
- getExperimentResults_baseStat :: Lens' GetExperimentResults (Maybe ExperimentBaseStat)
- getExperimentResults_endTime :: Lens' GetExperimentResults (Maybe UTCTime)
- getExperimentResults_period :: Lens' GetExperimentResults (Maybe Natural)
- getExperimentResults_reportNames :: Lens' GetExperimentResults (Maybe [ExperimentReportName])
- getExperimentResults_resultStats :: Lens' GetExperimentResults (Maybe [ExperimentResultRequestType])
- getExperimentResults_startTime :: Lens' GetExperimentResults (Maybe UTCTime)
- getExperimentResults_experiment :: Lens' GetExperimentResults Text
- getExperimentResults_metricNames :: Lens' GetExperimentResults (NonEmpty Text)
- getExperimentResults_project :: Lens' GetExperimentResults Text
- getExperimentResults_treatmentNames :: Lens' GetExperimentResults (NonEmpty Text)
- getExperimentResultsResponse_details :: Lens' GetExperimentResultsResponse (Maybe Text)
- getExperimentResultsResponse_reports :: Lens' GetExperimentResultsResponse (Maybe [ExperimentReport])
- getExperimentResultsResponse_resultsData :: Lens' GetExperimentResultsResponse (Maybe [ExperimentResultsData])
- getExperimentResultsResponse_timestamps :: Lens' GetExperimentResultsResponse (Maybe [UTCTime])
- getExperimentResultsResponse_httpStatus :: Lens' GetExperimentResultsResponse Int
- getFeature_feature :: Lens' GetFeature Text
- getFeature_project :: Lens' GetFeature Text
- getFeatureResponse_httpStatus :: Lens' GetFeatureResponse Int
- getFeatureResponse_feature :: Lens' GetFeatureResponse Feature
- getLaunch_launch :: Lens' GetLaunch Text
- getLaunch_project :: Lens' GetLaunch Text
- getLaunchResponse_launch :: Lens' GetLaunchResponse (Maybe Launch)
- getLaunchResponse_httpStatus :: Lens' GetLaunchResponse Int
- getProject_project :: Lens' GetProject Text
- getProjectResponse_httpStatus :: Lens' GetProjectResponse Int
- getProjectResponse_project :: Lens' GetProjectResponse Project
- getSegment_segment :: Lens' GetSegment Text
- getSegmentResponse_httpStatus :: Lens' GetSegmentResponse Int
- getSegmentResponse_segment :: Lens' GetSegmentResponse Segment
- listExperiments_maxResults :: Lens' ListExperiments (Maybe Natural)
- listExperiments_nextToken :: Lens' ListExperiments (Maybe Text)
- listExperiments_status :: Lens' ListExperiments (Maybe ExperimentStatus)
- listExperiments_project :: Lens' ListExperiments Text
- listExperimentsResponse_experiments :: Lens' ListExperimentsResponse (Maybe [Experiment])
- listExperimentsResponse_nextToken :: Lens' ListExperimentsResponse (Maybe Text)
- listExperimentsResponse_httpStatus :: Lens' ListExperimentsResponse Int
- listFeatures_maxResults :: Lens' ListFeatures (Maybe Natural)
- listFeatures_nextToken :: Lens' ListFeatures (Maybe Text)
- listFeatures_project :: Lens' ListFeatures Text
- listFeaturesResponse_features :: Lens' ListFeaturesResponse (Maybe [FeatureSummary])
- listFeaturesResponse_nextToken :: Lens' ListFeaturesResponse (Maybe Text)
- listFeaturesResponse_httpStatus :: Lens' ListFeaturesResponse Int
- listLaunches_maxResults :: Lens' ListLaunches (Maybe Natural)
- listLaunches_nextToken :: Lens' ListLaunches (Maybe Text)
- listLaunches_status :: Lens' ListLaunches (Maybe LaunchStatus)
- listLaunches_project :: Lens' ListLaunches Text
- listLaunchesResponse_launches :: Lens' ListLaunchesResponse (Maybe [Launch])
- listLaunchesResponse_nextToken :: Lens' ListLaunchesResponse (Maybe Text)
- listLaunchesResponse_httpStatus :: Lens' ListLaunchesResponse Int
- listProjects_maxResults :: Lens' ListProjects (Maybe Natural)
- listProjects_nextToken :: Lens' ListProjects (Maybe Text)
- listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text)
- listProjectsResponse_projects :: Lens' ListProjectsResponse (Maybe [ProjectSummary])
- listProjectsResponse_httpStatus :: Lens' ListProjectsResponse Int
- listSegmentReferences_maxResults :: Lens' ListSegmentReferences (Maybe Natural)
- listSegmentReferences_nextToken :: Lens' ListSegmentReferences (Maybe Text)
- listSegmentReferences_segment :: Lens' ListSegmentReferences Text
- listSegmentReferences_type :: Lens' ListSegmentReferences SegmentReferenceResourceType
- listSegmentReferencesResponse_nextToken :: Lens' ListSegmentReferencesResponse (Maybe Text)
- listSegmentReferencesResponse_referencedBy :: Lens' ListSegmentReferencesResponse (Maybe [RefResource])
- listSegmentReferencesResponse_httpStatus :: Lens' ListSegmentReferencesResponse Int
- listSegments_maxResults :: Lens' ListSegments (Maybe Natural)
- listSegments_nextToken :: Lens' ListSegments (Maybe Text)
- listSegmentsResponse_nextToken :: Lens' ListSegmentsResponse (Maybe Text)
- listSegmentsResponse_segments :: Lens' ListSegmentsResponse (Maybe [Segment])
- listSegmentsResponse_httpStatus :: Lens' ListSegmentsResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- putProjectEvents_events :: Lens' PutProjectEvents [Event]
- putProjectEvents_project :: Lens' PutProjectEvents Text
- putProjectEventsResponse_eventResults :: Lens' PutProjectEventsResponse (Maybe [PutProjectEventsResultEntry])
- putProjectEventsResponse_failedEventCount :: Lens' PutProjectEventsResponse (Maybe Int)
- putProjectEventsResponse_httpStatus :: Lens' PutProjectEventsResponse Int
- startExperiment_analysisCompleteTime :: Lens' StartExperiment UTCTime
- startExperiment_experiment :: Lens' StartExperiment Text
- startExperiment_project :: Lens' StartExperiment Text
- startExperimentResponse_startedTime :: Lens' StartExperimentResponse (Maybe UTCTime)
- startExperimentResponse_httpStatus :: Lens' StartExperimentResponse Int
- startLaunch_launch :: Lens' StartLaunch Text
- startLaunch_project :: Lens' StartLaunch Text
- startLaunchResponse_httpStatus :: Lens' StartLaunchResponse Int
- startLaunchResponse_launch :: Lens' StartLaunchResponse Launch
- stopExperiment_desiredState :: Lens' StopExperiment (Maybe ExperimentStopDesiredState)
- stopExperiment_reason :: Lens' StopExperiment (Maybe Text)
- stopExperiment_experiment :: Lens' StopExperiment Text
- stopExperiment_project :: Lens' StopExperiment Text
- stopExperimentResponse_endedTime :: Lens' StopExperimentResponse (Maybe UTCTime)
- stopExperimentResponse_httpStatus :: Lens' StopExperimentResponse Int
- stopLaunch_desiredState :: Lens' StopLaunch (Maybe LaunchStopDesiredState)
- stopLaunch_reason :: Lens' StopLaunch (Maybe Text)
- stopLaunch_launch :: Lens' StopLaunch Text
- stopLaunch_project :: Lens' StopLaunch Text
- stopLaunchResponse_endedTime :: Lens' StopLaunchResponse (Maybe UTCTime)
- stopLaunchResponse_httpStatus :: Lens' StopLaunchResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- testSegmentPattern_pattern :: Lens' TestSegmentPattern Text
- testSegmentPattern_payload :: Lens' TestSegmentPattern Text
- testSegmentPatternResponse_httpStatus :: Lens' TestSegmentPatternResponse Int
- testSegmentPatternResponse_match :: Lens' TestSegmentPatternResponse Bool
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateExperiment_description :: Lens' UpdateExperiment (Maybe Text)
- updateExperiment_metricGoals :: Lens' UpdateExperiment (Maybe (NonEmpty MetricGoalConfig))
- updateExperiment_onlineAbConfig :: Lens' UpdateExperiment (Maybe OnlineAbConfig)
- updateExperiment_randomizationSalt :: Lens' UpdateExperiment (Maybe Text)
- updateExperiment_removeSegment :: Lens' UpdateExperiment (Maybe Bool)
- updateExperiment_samplingRate :: Lens' UpdateExperiment (Maybe Natural)
- updateExperiment_segment :: Lens' UpdateExperiment (Maybe Text)
- updateExperiment_treatments :: Lens' UpdateExperiment (Maybe [TreatmentConfig])
- updateExperiment_experiment :: Lens' UpdateExperiment Text
- updateExperiment_project :: Lens' UpdateExperiment Text
- updateExperimentResponse_httpStatus :: Lens' UpdateExperimentResponse Int
- updateExperimentResponse_experiment :: Lens' UpdateExperimentResponse Experiment
- updateFeature_addOrUpdateVariations :: Lens' UpdateFeature (Maybe (NonEmpty VariationConfig))
- updateFeature_defaultVariation :: Lens' UpdateFeature (Maybe Text)
- updateFeature_description :: Lens' UpdateFeature (Maybe Text)
- updateFeature_entityOverrides :: Lens' UpdateFeature (Maybe (HashMap Text Text))
- updateFeature_evaluationStrategy :: Lens' UpdateFeature (Maybe FeatureEvaluationStrategy)
- updateFeature_removeVariations :: Lens' UpdateFeature (Maybe [Text])
- updateFeature_feature :: Lens' UpdateFeature Text
- updateFeature_project :: Lens' UpdateFeature Text
- updateFeatureResponse_httpStatus :: Lens' UpdateFeatureResponse Int
- updateFeatureResponse_feature :: Lens' UpdateFeatureResponse Feature
- updateLaunch_description :: Lens' UpdateLaunch (Maybe Text)
- updateLaunch_groups :: Lens' UpdateLaunch (Maybe (NonEmpty LaunchGroupConfig))
- updateLaunch_metricMonitors :: Lens' UpdateLaunch (Maybe [MetricMonitorConfig])
- updateLaunch_randomizationSalt :: Lens' UpdateLaunch (Maybe Text)
- updateLaunch_scheduledSplitsConfig :: Lens' UpdateLaunch (Maybe ScheduledSplitsLaunchConfig)
- updateLaunch_launch :: Lens' UpdateLaunch Text
- updateLaunch_project :: Lens' UpdateLaunch Text
- updateLaunchResponse_httpStatus :: Lens' UpdateLaunchResponse Int
- updateLaunchResponse_launch :: Lens' UpdateLaunchResponse Launch
- updateProject_appConfigResource :: Lens' UpdateProject (Maybe ProjectAppConfigResourceConfig)
- updateProject_description :: Lens' UpdateProject (Maybe Text)
- updateProject_project :: Lens' UpdateProject Text
- updateProjectResponse_httpStatus :: Lens' UpdateProjectResponse Int
- updateProjectResponse_project :: Lens' UpdateProjectResponse Project
- updateProjectDataDelivery_cloudWatchLogs :: Lens' UpdateProjectDataDelivery (Maybe CloudWatchLogsDestinationConfig)
- updateProjectDataDelivery_s3Destination :: Lens' UpdateProjectDataDelivery (Maybe S3DestinationConfig)
- updateProjectDataDelivery_project :: Lens' UpdateProjectDataDelivery Text
- updateProjectDataDeliveryResponse_httpStatus :: Lens' UpdateProjectDataDeliveryResponse Int
- updateProjectDataDeliveryResponse_project :: Lens' UpdateProjectDataDeliveryResponse Project
- cloudWatchLogsDestination_logGroup :: Lens' CloudWatchLogsDestination (Maybe Text)
- cloudWatchLogsDestinationConfig_logGroup :: Lens' CloudWatchLogsDestinationConfig (Maybe Text)
- evaluationRequest_evaluationContext :: Lens' EvaluationRequest (Maybe Text)
- evaluationRequest_entityId :: Lens' EvaluationRequest Text
- evaluationRequest_feature :: Lens' EvaluationRequest Text
- evaluationResult_details :: Lens' EvaluationResult (Maybe Text)
- evaluationResult_project :: Lens' EvaluationResult (Maybe Text)
- evaluationResult_reason :: Lens' EvaluationResult (Maybe Text)
- evaluationResult_value :: Lens' EvaluationResult (Maybe VariableValue)
- evaluationResult_variation :: Lens' EvaluationResult (Maybe Text)
- evaluationResult_entityId :: Lens' EvaluationResult Text
- evaluationResult_feature :: Lens' EvaluationResult Text
- evaluationRule_name :: Lens' EvaluationRule (Maybe Text)
- evaluationRule_type :: Lens' EvaluationRule Text
- event_data :: Lens' Event Text
- event_timestamp :: Lens' Event UTCTime
- event_type :: Lens' Event EventType
- experiment_description :: Lens' Experiment (Maybe Text)
- experiment_execution :: Lens' Experiment (Maybe ExperimentExecution)
- experiment_metricGoals :: Lens' Experiment (Maybe (NonEmpty MetricGoal))
- experiment_onlineAbDefinition :: Lens' Experiment (Maybe OnlineAbDefinition)
- experiment_project :: Lens' Experiment (Maybe Text)
- experiment_randomizationSalt :: Lens' Experiment (Maybe Text)
- experiment_samplingRate :: Lens' Experiment (Maybe Natural)
- experiment_schedule :: Lens' Experiment (Maybe ExperimentSchedule)
- experiment_segment :: Lens' Experiment (Maybe Text)
- experiment_statusReason :: Lens' Experiment (Maybe Text)
- experiment_tags :: Lens' Experiment (Maybe (HashMap Text Text))
- experiment_treatments :: Lens' Experiment (Maybe (NonEmpty Treatment))
- experiment_arn :: Lens' Experiment Text
- experiment_createdTime :: Lens' Experiment UTCTime
- experiment_lastUpdatedTime :: Lens' Experiment UTCTime
- experiment_name :: Lens' Experiment Text
- experiment_status :: Lens' Experiment ExperimentStatus
- experiment_type :: Lens' Experiment ExperimentType
- experimentExecution_endedTime :: Lens' ExperimentExecution (Maybe UTCTime)
- experimentExecution_startedTime :: Lens' ExperimentExecution (Maybe UTCTime)
- experimentReport_content :: Lens' ExperimentReport (Maybe Text)
- experimentReport_metricName :: Lens' ExperimentReport (Maybe Text)
- experimentReport_reportName :: Lens' ExperimentReport (Maybe ExperimentReportName)
- experimentReport_treatmentName :: Lens' ExperimentReport (Maybe Text)
- experimentResultsData_metricName :: Lens' ExperimentResultsData (Maybe Text)
- experimentResultsData_resultStat :: Lens' ExperimentResultsData (Maybe ExperimentResultResponseType)
- experimentResultsData_treatmentName :: Lens' ExperimentResultsData (Maybe Text)
- experimentResultsData_values :: Lens' ExperimentResultsData (Maybe [Double])
- experimentSchedule_analysisCompleteTime :: Lens' ExperimentSchedule (Maybe UTCTime)
- feature_defaultVariation :: Lens' Feature (Maybe Text)
- feature_description :: Lens' Feature (Maybe Text)
- feature_entityOverrides :: Lens' Feature (Maybe (HashMap Text Text))
- feature_evaluationRules :: Lens' Feature (Maybe [EvaluationRule])
- feature_project :: Lens' Feature (Maybe Text)
- feature_tags :: Lens' Feature (Maybe (HashMap Text Text))
- feature_arn :: Lens' Feature Text
- feature_createdTime :: Lens' Feature UTCTime
- feature_evaluationStrategy :: Lens' Feature FeatureEvaluationStrategy
- feature_lastUpdatedTime :: Lens' Feature UTCTime
- feature_name :: Lens' Feature Text
- feature_status :: Lens' Feature FeatureStatus
- feature_valueType :: Lens' Feature VariationValueType
- feature_variations :: Lens' Feature [Variation]
- featureSummary_defaultVariation :: Lens' FeatureSummary (Maybe Text)
- featureSummary_evaluationRules :: Lens' FeatureSummary (Maybe [EvaluationRule])
- featureSummary_project :: Lens' FeatureSummary (Maybe Text)
- featureSummary_tags :: Lens' FeatureSummary (Maybe (HashMap Text Text))
- featureSummary_arn :: Lens' FeatureSummary Text
- featureSummary_createdTime :: Lens' FeatureSummary UTCTime
- featureSummary_evaluationStrategy :: Lens' FeatureSummary FeatureEvaluationStrategy
- featureSummary_lastUpdatedTime :: Lens' FeatureSummary UTCTime
- featureSummary_name :: Lens' FeatureSummary Text
- featureSummary_status :: Lens' FeatureSummary FeatureStatus
- launch_description :: Lens' Launch (Maybe Text)
- launch_execution :: Lens' Launch (Maybe LaunchExecution)
- launch_groups :: Lens' Launch (Maybe [LaunchGroup])
- launch_metricMonitors :: Lens' Launch (Maybe [MetricMonitor])
- launch_project :: Lens' Launch (Maybe Text)
- launch_randomizationSalt :: Lens' Launch (Maybe Text)
- launch_scheduledSplitsDefinition :: Lens' Launch (Maybe ScheduledSplitsLaunchDefinition)
- launch_statusReason :: Lens' Launch (Maybe Text)
- launch_tags :: Lens' Launch (Maybe (HashMap Text Text))
- launch_arn :: Lens' Launch Text
- launch_createdTime :: Lens' Launch UTCTime
- launch_lastUpdatedTime :: Lens' Launch UTCTime
- launch_name :: Lens' Launch Text
- launch_status :: Lens' Launch LaunchStatus
- launch_type :: Lens' Launch LaunchType
- launchExecution_endedTime :: Lens' LaunchExecution (Maybe UTCTime)
- launchExecution_startedTime :: Lens' LaunchExecution (Maybe UTCTime)
- launchGroup_description :: Lens' LaunchGroup (Maybe Text)
- launchGroup_featureVariations :: Lens' LaunchGroup (HashMap Text Text)
- launchGroup_name :: Lens' LaunchGroup Text
- launchGroupConfig_description :: Lens' LaunchGroupConfig (Maybe Text)
- launchGroupConfig_feature :: Lens' LaunchGroupConfig Text
- launchGroupConfig_name :: Lens' LaunchGroupConfig Text
- launchGroupConfig_variation :: Lens' LaunchGroupConfig Text
- metricDefinition_entityIdKey :: Lens' MetricDefinition (Maybe Text)
- metricDefinition_eventPattern :: Lens' MetricDefinition (Maybe Text)
- metricDefinition_name :: Lens' MetricDefinition (Maybe Text)
- metricDefinition_unitLabel :: Lens' MetricDefinition (Maybe Text)
- metricDefinition_valueKey :: Lens' MetricDefinition (Maybe Text)
- metricDefinitionConfig_eventPattern :: Lens' MetricDefinitionConfig (Maybe Text)
- metricDefinitionConfig_unitLabel :: Lens' MetricDefinitionConfig (Maybe Text)
- metricDefinitionConfig_entityIdKey :: Lens' MetricDefinitionConfig Text
- metricDefinitionConfig_name :: Lens' MetricDefinitionConfig Text
- metricDefinitionConfig_valueKey :: Lens' MetricDefinitionConfig Text
- metricGoal_desiredChange :: Lens' MetricGoal (Maybe ChangeDirectionEnum)
- metricGoal_metricDefinition :: Lens' MetricGoal MetricDefinition
- metricGoalConfig_desiredChange :: Lens' MetricGoalConfig (Maybe ChangeDirectionEnum)
- metricGoalConfig_metricDefinition :: Lens' MetricGoalConfig MetricDefinitionConfig
- metricMonitor_metricDefinition :: Lens' MetricMonitor MetricDefinition
- metricMonitorConfig_metricDefinition :: Lens' MetricMonitorConfig MetricDefinitionConfig
- onlineAbConfig_controlTreatmentName :: Lens' OnlineAbConfig (Maybe Text)
- onlineAbConfig_treatmentWeights :: Lens' OnlineAbConfig (Maybe (HashMap Text Natural))
- onlineAbDefinition_controlTreatmentName :: Lens' OnlineAbDefinition (Maybe Text)
- onlineAbDefinition_treatmentWeights :: Lens' OnlineAbDefinition (Maybe (HashMap Text Natural))
- project_activeExperimentCount :: Lens' Project (Maybe Integer)
- project_activeLaunchCount :: Lens' Project (Maybe Integer)
- project_appConfigResource :: Lens' Project (Maybe ProjectAppConfigResource)
- project_dataDelivery :: Lens' Project (Maybe ProjectDataDelivery)
- project_description :: Lens' Project (Maybe Text)
- project_experimentCount :: Lens' Project (Maybe Integer)
- project_featureCount :: Lens' Project (Maybe Integer)
- project_launchCount :: Lens' Project (Maybe Integer)
- project_tags :: Lens' Project (Maybe (HashMap Text Text))
- project_arn :: Lens' Project Text
- project_createdTime :: Lens' Project UTCTime
- project_lastUpdatedTime :: Lens' Project UTCTime
- project_name :: Lens' Project Text
- project_status :: Lens' Project ProjectStatus
- projectAppConfigResource_applicationId :: Lens' ProjectAppConfigResource Text
- projectAppConfigResource_configurationProfileId :: Lens' ProjectAppConfigResource Text
- projectAppConfigResource_environmentId :: Lens' ProjectAppConfigResource Text
- projectAppConfigResourceConfig_applicationId :: Lens' ProjectAppConfigResourceConfig (Maybe Text)
- projectAppConfigResourceConfig_environmentId :: Lens' ProjectAppConfigResourceConfig (Maybe Text)
- projectDataDelivery_cloudWatchLogs :: Lens' ProjectDataDelivery (Maybe CloudWatchLogsDestination)
- projectDataDelivery_s3Destination :: Lens' ProjectDataDelivery (Maybe S3Destination)
- projectDataDeliveryConfig_cloudWatchLogs :: Lens' ProjectDataDeliveryConfig (Maybe CloudWatchLogsDestinationConfig)
- projectDataDeliveryConfig_s3Destination :: Lens' ProjectDataDeliveryConfig (Maybe S3DestinationConfig)
- projectSummary_activeExperimentCount :: Lens' ProjectSummary (Maybe Integer)
- projectSummary_activeLaunchCount :: Lens' ProjectSummary (Maybe Integer)
- projectSummary_description :: Lens' ProjectSummary (Maybe Text)
- projectSummary_experimentCount :: Lens' ProjectSummary (Maybe Integer)
- projectSummary_featureCount :: Lens' ProjectSummary (Maybe Integer)
- projectSummary_launchCount :: Lens' ProjectSummary (Maybe Integer)
- projectSummary_tags :: Lens' ProjectSummary (Maybe (HashMap Text Text))
- projectSummary_arn :: Lens' ProjectSummary Text
- projectSummary_createdTime :: Lens' ProjectSummary UTCTime
- projectSummary_lastUpdatedTime :: Lens' ProjectSummary UTCTime
- projectSummary_name :: Lens' ProjectSummary Text
- projectSummary_status :: Lens' ProjectSummary ProjectStatus
- putProjectEventsResultEntry_errorCode :: Lens' PutProjectEventsResultEntry (Maybe Text)
- putProjectEventsResultEntry_errorMessage :: Lens' PutProjectEventsResultEntry (Maybe Text)
- putProjectEventsResultEntry_eventId :: Lens' PutProjectEventsResultEntry (Maybe Text)
- refResource_arn :: Lens' RefResource (Maybe Text)
- refResource_endTime :: Lens' RefResource (Maybe Text)
- refResource_lastUpdatedOn :: Lens' RefResource (Maybe Text)
- refResource_startTime :: Lens' RefResource (Maybe Text)
- refResource_status :: Lens' RefResource (Maybe Text)
- refResource_name :: Lens' RefResource Text
- refResource_type :: Lens' RefResource Text
- s3Destination_bucket :: Lens' S3Destination (Maybe Text)
- s3Destination_prefix :: Lens' S3Destination (Maybe Text)
- s3DestinationConfig_bucket :: Lens' S3DestinationConfig (Maybe Text)
- s3DestinationConfig_prefix :: Lens' S3DestinationConfig (Maybe Text)
- scheduledSplit_groupWeights :: Lens' ScheduledSplit (Maybe (HashMap Text Natural))
- scheduledSplit_segmentOverrides :: Lens' ScheduledSplit (Maybe [SegmentOverride])
- scheduledSplit_startTime :: Lens' ScheduledSplit UTCTime
- scheduledSplitConfig_segmentOverrides :: Lens' ScheduledSplitConfig (Maybe [SegmentOverride])
- scheduledSplitConfig_groupWeights :: Lens' ScheduledSplitConfig (HashMap Text Natural)
- scheduledSplitConfig_startTime :: Lens' ScheduledSplitConfig UTCTime
- scheduledSplitsLaunchConfig_steps :: Lens' ScheduledSplitsLaunchConfig (NonEmpty ScheduledSplitConfig)
- scheduledSplitsLaunchDefinition_steps :: Lens' ScheduledSplitsLaunchDefinition (Maybe (NonEmpty ScheduledSplit))
- segment_description :: Lens' Segment (Maybe Text)
- segment_experimentCount :: Lens' Segment (Maybe Integer)
- segment_launchCount :: Lens' Segment (Maybe Integer)
- segment_tags :: Lens' Segment (Maybe (HashMap Text Text))
- segment_arn :: Lens' Segment Text
- segment_createdTime :: Lens' Segment UTCTime
- segment_lastUpdatedTime :: Lens' Segment UTCTime
- segment_name :: Lens' Segment Text
- segment_pattern :: Lens' Segment Text
- segmentOverride_evaluationOrder :: Lens' SegmentOverride Integer
- segmentOverride_segment :: Lens' SegmentOverride Text
- segmentOverride_weights :: Lens' SegmentOverride (HashMap Text Natural)
- treatment_description :: Lens' Treatment (Maybe Text)
- treatment_featureVariations :: Lens' Treatment (Maybe (HashMap Text Text))
- treatment_name :: Lens' Treatment Text
- treatmentConfig_description :: Lens' TreatmentConfig (Maybe Text)
- treatmentConfig_feature :: Lens' TreatmentConfig Text
- treatmentConfig_name :: Lens' TreatmentConfig Text
- treatmentConfig_variation :: Lens' TreatmentConfig Text
- variableValue_boolValue :: Lens' VariableValue (Maybe Bool)
- variableValue_doubleValue :: Lens' VariableValue (Maybe Double)
- variableValue_longValue :: Lens' VariableValue (Maybe Integer)
- variableValue_stringValue :: Lens' VariableValue (Maybe Text)
- variation_name :: Lens' Variation (Maybe Text)
- variation_value :: Lens' Variation (Maybe VariableValue)
- variationConfig_name :: Lens' VariationConfig Text
- variationConfig_value :: Lens' VariationConfig VariableValue
Operations
BatchEvaluateFeature
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.
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.
CreateExperiment
createExperiment_description :: Lens' CreateExperiment (Maybe Text) Source #
An optional description of the experiment.
createExperiment_onlineAbConfig :: Lens' CreateExperiment (Maybe OnlineAbConfig) Source #
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.
createExperiment_randomizationSalt :: Lens' CreateExperiment (Maybe Text) Source #
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
.
createExperiment_samplingRate :: Lens' CreateExperiment (Maybe Natural) Source #
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.
createExperiment_segment :: Lens' CreateExperiment (Maybe Text) Source #
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.
createExperiment_tags :: Lens' CreateExperiment (Maybe (HashMap Text Text)) Source #
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.
<p>You can associate as many as 50 tags with an experiment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
createExperiment_metricGoals :: Lens' CreateExperiment (NonEmpty MetricGoalConfig) Source #
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.
createExperiment_name :: Lens' CreateExperiment Text Source #
A name for the new experiment.
createExperiment_project :: Lens' CreateExperiment Text Source #
The name or ARN of the project that you want to create the new experiment in.
createExperiment_treatments :: Lens' CreateExperiment [TreatmentConfig] Source #
An array of structures that describe the configuration of each feature variation used in the experiment.
createExperimentResponse_httpStatus :: Lens' CreateExperimentResponse Int Source #
The response's http status code.
createExperimentResponse_experiment :: Lens' CreateExperimentResponse Experiment Source #
A structure containing the configuration details of the experiment that you created.
CreateFeature
createFeature_defaultVariation :: Lens' CreateFeature (Maybe Text) Source #
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.
createFeature_description :: Lens' CreateFeature (Maybe Text) Source #
An optional description of the feature.
createFeature_entityOverrides :: Lens' CreateFeature (Maybe (HashMap Text Text)) Source #
Specify 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.
createFeature_evaluationStrategy :: Lens' CreateFeature (Maybe FeatureEvaluationStrategy) Source #
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.
createFeature_tags :: Lens' CreateFeature (Maybe (HashMap Text Text)) Source #
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.
<p>You can associate as many as 50 tags with a feature.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
createFeature_name :: Lens' CreateFeature Text Source #
The name for the new feature.
createFeature_project :: Lens' CreateFeature Text Source #
The name or ARN of the project that is to contain the new feature.
createFeature_variations :: Lens' CreateFeature (NonEmpty VariationConfig) Source #
An array of structures that contain the configuration of the feature's different variations.
createFeatureResponse_feature :: Lens' CreateFeatureResponse (Maybe Feature) Source #
A structure that contains information about the new feature.
createFeatureResponse_httpStatus :: Lens' CreateFeatureResponse Int Source #
The response's http status code.
CreateLaunch
createLaunch_description :: Lens' CreateLaunch (Maybe Text) Source #
An optional description for the launch.
createLaunch_metricMonitors :: Lens' CreateLaunch (Maybe [MetricMonitorConfig]) Source #
An array of structures that define the metrics that will be used to monitor the launch performance.
createLaunch_randomizationSalt :: Lens' CreateLaunch (Maybe Text) Source #
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
.
createLaunch_scheduledSplitsConfig :: Lens' CreateLaunch (Maybe ScheduledSplitsLaunchConfig) Source #
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
createLaunch_tags :: Lens' CreateLaunch (Maybe (HashMap Text Text)) Source #
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.
<p>You can associate as many as 50 tags with a launch.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
createLaunch_groups :: Lens' CreateLaunch (NonEmpty LaunchGroupConfig) Source #
An array of structures that contains the feature and variations that are to be used for the launch.
createLaunch_name :: Lens' CreateLaunch Text Source #
The name for the new launch.
createLaunch_project :: Lens' CreateLaunch Text Source #
The name or ARN of the project that you want to create the launch in.
createLaunchResponse_httpStatus :: Lens' CreateLaunchResponse Int Source #
The response's http status code.
createLaunchResponse_launch :: Lens' CreateLaunchResponse Launch Source #
A structure that contains the configuration of the launch that was created.
CreateProject
createProject_appConfigResource :: Lens' CreateProject (Maybe ProjectAppConfigResourceConfig) Source #
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.
createProject_dataDelivery :: Lens' CreateProject (Maybe ProjectDataDeliveryConfig) Source #
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.
createProject_description :: Lens' CreateProject (Maybe Text) Source #
An optional description of the project.
createProject_tags :: Lens' CreateProject (Maybe (HashMap Text Text)) Source #
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.
<p>You can associate as many as 50 tags with a project.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
createProject_name :: Lens' CreateProject Text Source #
The name for the project.
createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int Source #
The response's http status code.
createProjectResponse_project :: Lens' CreateProjectResponse Project Source #
A structure that contains information about the created project.
CreateSegment
createSegment_description :: Lens' CreateSegment (Maybe Text) Source #
An optional description for this segment.
createSegment_tags :: Lens' CreateSegment (Maybe (HashMap Text Text)) Source #
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.
<p>You can associate as many as 50 tags with a segment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
createSegment_name :: Lens' CreateSegment Text Source #
A name for the segment.
createSegment_pattern :: Lens' CreateSegment Text Source #
The pattern to use for the segment. For more information about pattern syntax, see Segment rule pattern syntax.
createSegmentResponse_httpStatus :: Lens' CreateSegmentResponse Int Source #
The response's http status code.
createSegmentResponse_segment :: Lens' CreateSegmentResponse Segment Source #
A structure that contains the complete information about the segment that was just created.
DeleteExperiment
deleteExperiment_experiment :: Lens' DeleteExperiment Text Source #
The name of the experiment to delete.
deleteExperiment_project :: Lens' DeleteExperiment Text Source #
The name or ARN of the project that contains the experiment to delete.
deleteExperimentResponse_httpStatus :: Lens' DeleteExperimentResponse Int Source #
The response's http status code.
DeleteFeature
deleteFeature_feature :: Lens' DeleteFeature Text Source #
The name of the feature to delete.
deleteFeature_project :: Lens' DeleteFeature Text Source #
The name or ARN of the project that contains the feature to delete.
deleteFeatureResponse_httpStatus :: Lens' DeleteFeatureResponse Int Source #
The response's http status code.
DeleteLaunch
deleteLaunch_launch :: Lens' DeleteLaunch Text Source #
The name of the launch to delete.
deleteLaunch_project :: Lens' DeleteLaunch Text Source #
The name or ARN of the project that contains the launch to delete.
deleteLaunchResponse_httpStatus :: Lens' DeleteLaunchResponse Int Source #
The response's http status code.
DeleteProject
deleteProject_project :: Lens' DeleteProject Text Source #
The name or ARN of the project to delete.
deleteProjectResponse_httpStatus :: Lens' DeleteProjectResponse Int Source #
The response's http status code.
DeleteSegment
deleteSegment_segment :: Lens' DeleteSegment Text Source #
Specifies the segment to delete.
deleteSegmentResponse_httpStatus :: Lens' DeleteSegmentResponse Int Source #
The response's http status code.
EvaluateFeature
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.
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.
GetExperiment
getExperiment_experiment :: Lens' GetExperiment Text Source #
The name of the experiment that you want to see the details of.
getExperiment_project :: Lens' GetExperiment Text Source #
The name or ARN of the project that contains the experiment.
getExperimentResponse_experiment :: Lens' GetExperimentResponse (Maybe Experiment) Source #
A structure containing the configuration details of the experiment.
getExperimentResponse_httpStatus :: Lens' GetExperimentResponse Int Source #
The response's http status code.
GetExperimentResults
getExperimentResults_baseStat :: Lens' GetExperimentResults (Maybe ExperimentBaseStat) Source #
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.
getExperimentResults_endTime :: Lens' GetExperimentResults (Maybe UTCTime) Source #
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.
getExperimentResults_period :: Lens' GetExperimentResults (Maybe Natural) Source #
In seconds, the amount of time to aggregate results together.
getExperimentResults_reportNames :: Lens' GetExperimentResults (Maybe [ExperimentReportName]) Source #
The names of the report types that you want to see. Currently,
BayesianInference
is the only valid value.
getExperimentResults_resultStats :: Lens' GetExperimentResults (Maybe [ExperimentResultRequestType]) Source #
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 thebaseStat
of a variation and the baseline. Evidently returns the 95% confidence interval.TreatmentEffect
is the difference in the statistic specified by thebaseStat
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 thebaseStat
parameter. Therefore, ifbaseStat
ismean
, this returns the mean of the values collected for each variation.
getExperimentResults_startTime :: Lens' GetExperimentResults (Maybe UTCTime) Source #
The date and time that the experiment started.
getExperimentResults_experiment :: Lens' GetExperimentResults Text Source #
The name of the experiment to retrieve the results of.
getExperimentResults_metricNames :: Lens' GetExperimentResults (NonEmpty Text) Source #
The names of the experiment metrics that you want to see the results of.
getExperimentResults_project :: Lens' GetExperimentResults Text Source #
The name or ARN of the project that contains the experiment that you want to see the results of.
getExperimentResults_treatmentNames :: Lens' GetExperimentResults (NonEmpty Text) Source #
The names of the experiment treatments that you want to see the results for.
getExperimentResultsResponse_details :: Lens' GetExperimentResultsResponse (Maybe Text) Source #
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.
getExperimentResultsResponse_reports :: Lens' GetExperimentResultsResponse (Maybe [ExperimentReport]) Source #
An array of structures that include the reports that you requested.
getExperimentResultsResponse_resultsData :: Lens' GetExperimentResultsResponse (Maybe [ExperimentResultsData]) Source #
An array of structures that include experiment results including metric names and values.
getExperimentResultsResponse_timestamps :: Lens' GetExperimentResultsResponse (Maybe [UTCTime]) Source #
The timestamps of each result returned.
getExperimentResultsResponse_httpStatus :: Lens' GetExperimentResultsResponse Int Source #
The response's http status code.
GetFeature
getFeature_feature :: Lens' GetFeature Text Source #
The name of the feature that you want to retrieve information for.
getFeature_project :: Lens' GetFeature Text Source #
The name or ARN of the project that contains the feature.
getFeatureResponse_httpStatus :: Lens' GetFeatureResponse Int Source #
The response's http status code.
getFeatureResponse_feature :: Lens' GetFeatureResponse Feature Source #
A structure containing the configuration details of the feature.
GetLaunch
getLaunch_launch :: Lens' GetLaunch Text Source #
The name of the launch that you want to see the details of.
getLaunch_project :: Lens' GetLaunch Text Source #
The name or ARN of the project that contains the launch.
getLaunchResponse_launch :: Lens' GetLaunchResponse (Maybe Launch) Source #
A structure containing the configuration details of the launch.
getLaunchResponse_httpStatus :: Lens' GetLaunchResponse Int Source #
The response's http status code.
GetProject
getProject_project :: Lens' GetProject Text Source #
The name or ARN of the project that you want to see the details of.
getProjectResponse_httpStatus :: Lens' GetProjectResponse Int Source #
The response's http status code.
getProjectResponse_project :: Lens' GetProjectResponse Project Source #
A structure containing the configuration details of the project.
GetSegment
getSegment_segment :: Lens' GetSegment Text Source #
The ARN of the segment to return information for.
getSegmentResponse_httpStatus :: Lens' GetSegmentResponse Int Source #
The response's http status code.
getSegmentResponse_segment :: Lens' GetSegmentResponse Segment Source #
A structure that contains the complete information about the segment.
ListExperiments
listExperiments_maxResults :: Lens' ListExperiments (Maybe Natural) Source #
The maximum number of results to include in the response.
listExperiments_nextToken :: Lens' ListExperiments (Maybe Text) Source #
The token to use when requesting the next set of results. You received
this token from a previous ListExperiments
operation.
listExperiments_status :: Lens' ListExperiments (Maybe ExperimentStatus) Source #
Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.
listExperiments_project :: Lens' ListExperiments Text Source #
The name or ARN of the project to return the experiment list from.
listExperimentsResponse_experiments :: Lens' ListExperimentsResponse (Maybe [Experiment]) Source #
An array of structures that contain the configuration details of the experiments in the specified project.
listExperimentsResponse_nextToken :: Lens' ListExperimentsResponse (Maybe Text) Source #
The token to use in a subsequent ListExperiments
operation to return
the next set of results.
listExperimentsResponse_httpStatus :: Lens' ListExperimentsResponse Int Source #
The response's http status code.
ListFeatures
listFeatures_maxResults :: Lens' ListFeatures (Maybe Natural) Source #
The maximum number of results to include in the response.
listFeatures_nextToken :: Lens' ListFeatures (Maybe Text) Source #
The token to use when requesting the next set of results. You received
this token from a previous ListFeatures
operation.
listFeatures_project :: Lens' ListFeatures Text Source #
The name or ARN of the project to return the feature list from.
listFeaturesResponse_features :: Lens' ListFeaturesResponse (Maybe [FeatureSummary]) Source #
An array of structures that contain the configuration details of the features in the specified project.
listFeaturesResponse_nextToken :: Lens' ListFeaturesResponse (Maybe Text) Source #
The token to use in a subsequent ListFeatures
operation to return the
next set of results.
listFeaturesResponse_httpStatus :: Lens' ListFeaturesResponse Int Source #
The response's http status code.
ListLaunches
listLaunches_maxResults :: Lens' ListLaunches (Maybe Natural) Source #
The maximum number of results to include in the response.
listLaunches_nextToken :: Lens' ListLaunches (Maybe Text) Source #
The token to use when requesting the next set of results. You received
this token from a previous ListLaunches
operation.
listLaunches_status :: Lens' ListLaunches (Maybe LaunchStatus) Source #
Use this optional parameter to limit the returned results to only the launches with the status that you specify here.
listLaunches_project :: Lens' ListLaunches Text Source #
The name or ARN of the project to return the launch list from.
listLaunchesResponse_launches :: Lens' ListLaunchesResponse (Maybe [Launch]) Source #
An array of structures that contain the configuration details of the launches in the specified project.
listLaunchesResponse_nextToken :: Lens' ListLaunchesResponse (Maybe Text) Source #
The token to use in a subsequent ListLaunches
operation to return the
next set of results.
listLaunchesResponse_httpStatus :: Lens' ListLaunchesResponse Int Source #
The response's http status code.
ListProjects
listProjects_maxResults :: Lens' ListProjects (Maybe Natural) Source #
The maximum number of results to include in the response.
listProjects_nextToken :: Lens' ListProjects (Maybe Text) Source #
The token to use when requesting the next set of results. You received
this token from a previous ListProjects
operation.
listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text) Source #
The token to use in a subsequent ListProjects
operation to return the
next set of results.
listProjectsResponse_projects :: Lens' ListProjectsResponse (Maybe [ProjectSummary]) Source #
An array of structures that contain the configuration details of the projects in the Region.
listProjectsResponse_httpStatus :: Lens' ListProjectsResponse Int Source #
The response's http status code.
ListSegmentReferences
listSegmentReferences_maxResults :: Lens' ListSegmentReferences (Maybe Natural) Source #
The maximum number of results to include in the response. If you omit this, the default of 50 is used.
listSegmentReferences_nextToken :: Lens' ListSegmentReferences (Maybe Text) Source #
The token to use when requesting the next set of results. You received
this token from a previous ListSegmentReferences
operation.
listSegmentReferences_segment :: Lens' ListSegmentReferences Text Source #
The ARN of the segment that you want to view information for.
listSegmentReferences_type :: Lens' ListSegmentReferences SegmentReferenceResourceType Source #
Specifies whether to return information about launches or experiments that use this segment.
listSegmentReferencesResponse_nextToken :: Lens' ListSegmentReferencesResponse (Maybe Text) Source #
The token to use in a subsequent ListSegmentReferences
operation to
return the next set of results.
listSegmentReferencesResponse_referencedBy :: Lens' ListSegmentReferencesResponse (Maybe [RefResource]) Source #
An array of structures, where each structure contains information about one experiment or launch that uses this segment.
listSegmentReferencesResponse_httpStatus :: Lens' ListSegmentReferencesResponse Int Source #
The response's http status code.
ListSegments
listSegments_maxResults :: Lens' ListSegments (Maybe Natural) Source #
The maximum number of results to include in the response. If you omit this, the default of 50 is used.
listSegments_nextToken :: Lens' ListSegments (Maybe Text) Source #
The token to use when requesting the next set of results. You received
this token from a previous ListSegments
operation.
listSegmentsResponse_nextToken :: Lens' ListSegmentsResponse (Maybe Text) Source #
The token to use in a subsequent ListSegments
operation to return the
next set of results.
listSegmentsResponse_segments :: Lens' ListSegmentsResponse (Maybe [Segment]) Source #
An array of structures that contain information about the segments in this Region.
listSegmentsResponse_httpStatus :: Lens' ListSegmentsResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The ARN of the resource that you want to see the tags of.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #
The list of tag keys and values associated with the resource you specified.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
PutProjectEvents
putProjectEvents_events :: Lens' PutProjectEvents [Event] Source #
An array of event structures that contain the performance data that is being sent to Evidently.
putProjectEvents_project :: Lens' PutProjectEvents Text Source #
The name or ARN of the project to write the events to.
putProjectEventsResponse_eventResults :: Lens' PutProjectEventsResponse (Maybe [PutProjectEventsResultEntry]) Source #
A structure that contains Evidently's response to the sent events, including an event ID and error codes, if any.
putProjectEventsResponse_failedEventCount :: Lens' PutProjectEventsResponse (Maybe Int) Source #
The number of events in the operation that could not be used by Evidently.
putProjectEventsResponse_httpStatus :: Lens' PutProjectEventsResponse Int Source #
The response's http status code.
StartExperiment
startExperiment_analysisCompleteTime :: Lens' StartExperiment UTCTime Source #
The date and time to end the experiment. This must be no more than 30 days after the experiment starts.
startExperiment_experiment :: Lens' StartExperiment Text Source #
The name of the experiment to start.
startExperiment_project :: Lens' StartExperiment Text Source #
The name or ARN of the project that contains the experiment to start.
startExperimentResponse_startedTime :: Lens' StartExperimentResponse (Maybe UTCTime) Source #
A timestamp that indicates when the experiment started.
startExperimentResponse_httpStatus :: Lens' StartExperimentResponse Int Source #
The response's http status code.
StartLaunch
startLaunch_launch :: Lens' StartLaunch Text Source #
The name of the launch to start.
startLaunch_project :: Lens' StartLaunch Text Source #
The name or ARN of the project that contains the launch to start.
startLaunchResponse_httpStatus :: Lens' StartLaunchResponse Int Source #
The response's http status code.
startLaunchResponse_launch :: Lens' StartLaunchResponse Launch Source #
A structure that contains information about the launch that was started.
StopExperiment
stopExperiment_desiredState :: Lens' StopExperiment (Maybe ExperimentStopDesiredState) Source #
Specify whether the experiment is to be considered COMPLETED
or
CANCELLED
after it stops.
stopExperiment_reason :: Lens' StopExperiment (Maybe Text) Source #
A string that describes why you are stopping the experiment.
stopExperiment_experiment :: Lens' StopExperiment Text Source #
The name of the experiment to stop.
stopExperiment_project :: Lens' StopExperiment Text Source #
The name or ARN of the project that contains the experiment to stop.
stopExperimentResponse_endedTime :: Lens' StopExperimentResponse (Maybe UTCTime) Source #
The date and time that the experiment stopped.
stopExperimentResponse_httpStatus :: Lens' StopExperimentResponse Int Source #
The response's http status code.
StopLaunch
stopLaunch_desiredState :: Lens' StopLaunch (Maybe LaunchStopDesiredState) Source #
Specify whether to consider the launch as COMPLETED
or CANCELLED
after it stops.
stopLaunch_reason :: Lens' StopLaunch (Maybe Text) Source #
A string that describes why you are stopping the launch.
stopLaunch_launch :: Lens' StopLaunch Text Source #
The name of the launch to stop.
stopLaunch_project :: Lens' StopLaunch Text Source #
The name or ARN of the project that contains the launch that you want to stop.
stopLaunchResponse_endedTime :: Lens' StopLaunchResponse (Maybe UTCTime) Source #
The date and time that the launch stopped.
stopLaunchResponse_httpStatus :: Lens' StopLaunchResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The ARN of the CloudWatch Evidently resource that you're adding tags to.
tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #
The list of key-value pairs to associate with the resource.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
TestSegmentPattern
testSegmentPattern_pattern :: Lens' TestSegmentPattern Text Source #
The pattern to test.
testSegmentPattern_payload :: Lens' TestSegmentPattern Text Source #
A sample evaluationContext
JSON block to test against the specified
pattern.
testSegmentPatternResponse_httpStatus :: Lens' TestSegmentPatternResponse Int Source #
The response's http status code.
testSegmentPatternResponse_match :: Lens' TestSegmentPatternResponse Bool Source #
Returns true
if the pattern matches the payload.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The ARN of the CloudWatch Evidently resource that you're removing tags from.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
The list of tag keys to remove from the resource.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateExperiment
updateExperiment_description :: Lens' UpdateExperiment (Maybe Text) Source #
An optional description of the experiment.
updateExperiment_metricGoals :: Lens' UpdateExperiment (Maybe (NonEmpty MetricGoalConfig)) Source #
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.
updateExperiment_onlineAbConfig :: Lens' UpdateExperiment (Maybe OnlineAbConfig) Source #
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.
updateExperiment_randomizationSalt :: Lens' UpdateExperiment (Maybe Text) Source #
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
.
updateExperiment_removeSegment :: Lens' UpdateExperiment (Maybe Bool) Source #
Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.
updateExperiment_samplingRate :: Lens' UpdateExperiment (Maybe Natural) Source #
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.
updateExperiment_segment :: Lens' UpdateExperiment (Maybe Text) Source #
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.
updateExperiment_treatments :: Lens' UpdateExperiment (Maybe [TreatmentConfig]) Source #
An array of structures that define the variations being tested in the experiment.
updateExperiment_experiment :: Lens' UpdateExperiment Text Source #
The name of the experiment to update.
updateExperiment_project :: Lens' UpdateExperiment Text Source #
The name or ARN of the project that contains the experiment that you want to update.
updateExperimentResponse_httpStatus :: Lens' UpdateExperimentResponse Int Source #
The response's http status code.
updateExperimentResponse_experiment :: Lens' UpdateExperimentResponse Experiment Source #
A structure containing the configuration details of the experiment that was updated.
UpdateFeature
updateFeature_addOrUpdateVariations :: Lens' UpdateFeature (Maybe (NonEmpty VariationConfig)) Source #
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.
updateFeature_defaultVariation :: Lens' UpdateFeature (Maybe Text) Source #
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.
updateFeature_description :: Lens' UpdateFeature (Maybe Text) Source #
An optional description of the feature.
updateFeature_entityOverrides :: Lens' UpdateFeature (Maybe (HashMap Text Text)) Source #
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.
updateFeature_evaluationStrategy :: Lens' UpdateFeature (Maybe FeatureEvaluationStrategy) Source #
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.
updateFeature_removeVariations :: Lens' UpdateFeature (Maybe [Text]) Source #
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.
updateFeature_feature :: Lens' UpdateFeature Text Source #
The name of the feature to be updated.
updateFeature_project :: Lens' UpdateFeature Text Source #
The name or ARN of the project that contains the feature to be updated.
updateFeatureResponse_httpStatus :: Lens' UpdateFeatureResponse Int Source #
The response's http status code.
updateFeatureResponse_feature :: Lens' UpdateFeatureResponse Feature Source #
A structure that contains information about the updated feature.
UpdateLaunch
updateLaunch_description :: Lens' UpdateLaunch (Maybe Text) Source #
An optional description for the launch.
updateLaunch_groups :: Lens' UpdateLaunch (Maybe (NonEmpty LaunchGroupConfig)) Source #
An array of structures that contains the feature and variations that are to be used for the launch.
updateLaunch_metricMonitors :: Lens' UpdateLaunch (Maybe [MetricMonitorConfig]) Source #
An array of structures that define the metrics that will be used to monitor the launch performance.
updateLaunch_randomizationSalt :: Lens' UpdateLaunch (Maybe Text) Source #
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
.
updateLaunch_scheduledSplitsConfig :: Lens' UpdateLaunch (Maybe ScheduledSplitsLaunchConfig) Source #
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
updateLaunch_launch :: Lens' UpdateLaunch Text Source #
The name of the launch that is to be updated.
updateLaunch_project :: Lens' UpdateLaunch Text Source #
The name or ARN of the project that contains the launch that you want to update.
updateLaunchResponse_httpStatus :: Lens' UpdateLaunchResponse Int Source #
The response's http status code.
updateLaunchResponse_launch :: Lens' UpdateLaunchResponse Launch Source #
A structure that contains the new configuration of the launch that was updated.
UpdateProject
updateProject_appConfigResource :: Lens' UpdateProject (Maybe ProjectAppConfigResourceConfig) Source #
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.
updateProject_description :: Lens' UpdateProject (Maybe Text) Source #
An optional description of the project.
updateProject_project :: Lens' UpdateProject Text Source #
The name or ARN of the project to update.
updateProjectResponse_httpStatus :: Lens' UpdateProjectResponse Int Source #
The response's http status code.
updateProjectResponse_project :: Lens' UpdateProjectResponse Project Source #
A structure containing information about the updated project.
UpdateProjectDataDelivery
updateProjectDataDelivery_cloudWatchLogs :: Lens' UpdateProjectDataDelivery (Maybe CloudWatchLogsDestinationConfig) Source #
A structure containing the CloudWatch Logs log group where you want to store evaluation events.
updateProjectDataDelivery_s3Destination :: Lens' UpdateProjectDataDelivery (Maybe S3DestinationConfig) Source #
A structure containing the S3 bucket name and bucket prefix where you want to store evaluation events.
updateProjectDataDelivery_project :: Lens' UpdateProjectDataDelivery Text Source #
The name or ARN of the project that you want to modify the data storage options for.
updateProjectDataDeliveryResponse_httpStatus :: Lens' UpdateProjectDataDeliveryResponse Int Source #
The response's http status code.
updateProjectDataDeliveryResponse_project :: Lens' UpdateProjectDataDeliveryResponse Project Source #
A structure containing details about the project that you updated.
Types
CloudWatchLogsDestination
cloudWatchLogsDestination_logGroup :: Lens' CloudWatchLogsDestination (Maybe Text) Source #
The name of the log group where the project stores evaluation events.
CloudWatchLogsDestinationConfig
cloudWatchLogsDestinationConfig_logGroup :: Lens' CloudWatchLogsDestinationConfig (Maybe Text) Source #
The name of the log group where the project stores evaluation events.
EvaluationRequest
evaluationRequest_evaluationContext :: Lens' EvaluationRequest (Maybe Text) Source #
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.
evaluationRequest_entityId :: Lens' EvaluationRequest Text Source #
An internal ID that represents a unique user session of the application.
This entityID
is checked against any override rules assigned for this
feature.
evaluationRequest_feature :: Lens' EvaluationRequest Text Source #
The name of the feature being evaluated.
EvaluationResult
evaluationResult_details :: Lens' EvaluationResult (Maybe Text) Source #
If this user was assigned to a launch or experiment, this field lists the launch or experiment name.
evaluationResult_project :: Lens' EvaluationResult (Maybe Text) Source #
The name or ARN of the project that contains the feature being evaluated.
evaluationResult_reason :: Lens' EvaluationResult (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; or EXPERIMENT_RULE_MATCH
, if the user session was
enrolled in an experiment.
evaluationResult_value :: Lens' EvaluationResult (Maybe VariableValue) Source #
The value assigned to this variation to differentiate it from the other variations of this feature.
evaluationResult_variation :: Lens' EvaluationResult (Maybe Text) Source #
The name of the variation that was served to the user session.
evaluationResult_entityId :: Lens' EvaluationResult Text Source #
An internal ID that represents a unique user session of the application.
evaluationResult_feature :: Lens' EvaluationResult Text Source #
The name of the feature being evaluated.
EvaluationRule
evaluationRule_name :: Lens' EvaluationRule (Maybe Text) Source #
The name of the experiment or launch.
evaluationRule_type :: Lens' EvaluationRule Text Source #
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.
Event
event_type :: Lens' Event EventType Source #
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.
Experiment
experiment_description :: Lens' Experiment (Maybe Text) Source #
A description of the experiment.
experiment_execution :: Lens' Experiment (Maybe ExperimentExecution) Source #
A structure that contains the date and time that the experiment started and ended.
experiment_metricGoals :: Lens' Experiment (Maybe (NonEmpty MetricGoal)) Source #
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.
experiment_onlineAbDefinition :: Lens' Experiment (Maybe OnlineAbDefinition) Source #
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.
experiment_project :: Lens' Experiment (Maybe Text) Source #
The name or ARN of the project that contains this experiment.
experiment_randomizationSalt :: Lens' Experiment (Maybe Text) Source #
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
.
experiment_samplingRate :: Lens' Experiment (Maybe Natural) Source #
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.
experiment_schedule :: Lens' Experiment (Maybe ExperimentSchedule) Source #
A structure that contains the time and date that Evidently completed the analysis of the experiment.
experiment_segment :: Lens' Experiment (Maybe Text) Source #
The audience segment being used for the experiment, if a segment is being used.
experiment_statusReason :: Lens' Experiment (Maybe Text) Source #
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.
experiment_tags :: Lens' Experiment (Maybe (HashMap Text Text)) Source #
The list of tag keys and values associated with this experiment.
experiment_treatments :: Lens' Experiment (Maybe (NonEmpty Treatment)) Source #
An array of structures that describe the configuration of each feature variation used in the experiment.
experiment_arn :: Lens' Experiment Text Source #
The ARN of the experiment.
experiment_createdTime :: Lens' Experiment UTCTime Source #
The date and time that the experiment is first created.
experiment_lastUpdatedTime :: Lens' Experiment UTCTime Source #
The date and time that the experiment was most recently updated.
experiment_name :: Lens' Experiment Text Source #
The name of the experiment.
experiment_status :: Lens' Experiment ExperimentStatus Source #
The current state of the experiment.
experiment_type :: Lens' Experiment ExperimentType Source #
The type of this experiment. Currently, this value must be
aws.experiment.onlineab
.
ExperimentExecution
experimentExecution_endedTime :: Lens' ExperimentExecution (Maybe UTCTime) Source #
The date and time that the experiment ended.
experimentExecution_startedTime :: Lens' ExperimentExecution (Maybe UTCTime) Source #
The date and time that the experiment started.
ExperimentReport
experimentReport_content :: Lens' ExperimentReport (Maybe Text) Source #
The content of the report.
experimentReport_metricName :: Lens' ExperimentReport (Maybe Text) Source #
The name of the metric that is analyzed in this experiment report.
experimentReport_reportName :: Lens' ExperimentReport (Maybe ExperimentReportName) Source #
The type of analysis used for this report.
experimentReport_treatmentName :: Lens' ExperimentReport (Maybe Text) Source #
The name of the variation that this report pertains to.
ExperimentResultsData
experimentResultsData_metricName :: Lens' ExperimentResultsData (Maybe Text) Source #
The name of the metric.
experimentResultsData_resultStat :: Lens' ExperimentResultsData (Maybe ExperimentResultResponseType) Source #
The experiment statistic that these results pertain to.
experimentResultsData_treatmentName :: Lens' ExperimentResultsData (Maybe Text) Source #
The treatment, or variation, that returned the values
in this
structure.
experimentResultsData_values :: Lens' ExperimentResultsData (Maybe [Double]) Source #
The values for the metricName
that were recorded in the experiment.
ExperimentSchedule
experimentSchedule_analysisCompleteTime :: Lens' ExperimentSchedule (Maybe UTCTime) Source #
The time and date that Evidently completed the analysis of the experiment.
Feature
feature_defaultVariation :: Lens' Feature (Maybe Text) Source #
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.
feature_entityOverrides :: Lens' Feature (Maybe (HashMap Text Text)) Source #
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.
feature_evaluationRules :: Lens' Feature (Maybe [EvaluationRule]) Source #
An array of structures that define the evaluation rules for the feature.
feature_project :: Lens' Feature (Maybe Text) Source #
The name or ARN of the project that contains the feature.
feature_tags :: Lens' Feature (Maybe (HashMap Text Text)) Source #
The list of tag keys and values associated with this feature.
feature_evaluationStrategy :: Lens' Feature FeatureEvaluationStrategy Source #
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.
feature_lastUpdatedTime :: Lens' Feature UTCTime Source #
The date and time that the feature was most recently updated.
feature_status :: Lens' Feature FeatureStatus Source #
The current state of the feature.
feature_valueType :: Lens' Feature VariationValueType Source #
Defines the type of value used to define the different feature variations. For more information, see Variation types
feature_variations :: Lens' Feature [Variation] Source #
An array of structures that contain the configuration of the feature's different variations.
FeatureSummary
featureSummary_defaultVariation :: Lens' FeatureSummary (Maybe Text) Source #
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.
featureSummary_evaluationRules :: Lens' FeatureSummary (Maybe [EvaluationRule]) Source #
An array of structures that define
featureSummary_project :: Lens' FeatureSummary (Maybe Text) Source #
The name or ARN of the project that contains the feature.
featureSummary_tags :: Lens' FeatureSummary (Maybe (HashMap Text Text)) Source #
The list of tag keys and values associated with this feature.
featureSummary_arn :: Lens' FeatureSummary Text Source #
The ARN of the feature.
featureSummary_createdTime :: Lens' FeatureSummary UTCTime Source #
The date and time that the feature is created.
featureSummary_evaluationStrategy :: Lens' FeatureSummary FeatureEvaluationStrategy Source #
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.
featureSummary_lastUpdatedTime :: Lens' FeatureSummary UTCTime Source #
The date and time that the feature was most recently updated.
featureSummary_name :: Lens' FeatureSummary Text Source #
The name of the feature.
featureSummary_status :: Lens' FeatureSummary FeatureStatus Source #
The current state of the feature.
Launch
launch_execution :: Lens' Launch (Maybe LaunchExecution) Source #
A structure that contains information about the start and end times of the launch.
launch_groups :: Lens' Launch (Maybe [LaunchGroup]) Source #
An array of structures that define the feature variations that are being used in the launch.
launch_metricMonitors :: Lens' Launch (Maybe [MetricMonitor]) Source #
An array of structures that define the metrics that are being used to monitor the launch performance.
launch_project :: Lens' Launch (Maybe Text) Source #
The name or ARN of the project that contains the launch.
launch_randomizationSalt :: Lens' Launch (Maybe Text) Source #
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
.
launch_scheduledSplitsDefinition :: Lens' Launch (Maybe ScheduledSplitsLaunchDefinition) Source #
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
launch_statusReason :: Lens' Launch (Maybe Text) Source #
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.
launch_tags :: Lens' Launch (Maybe (HashMap Text Text)) Source #
The list of tag keys and values associated with this launch.
launch_lastUpdatedTime :: Lens' Launch UTCTime Source #
The date and time that the launch was most recently updated.
launch_status :: Lens' Launch LaunchStatus Source #
The current state of the launch.
launch_type :: Lens' Launch LaunchType Source #
The type of launch.
LaunchExecution
launchExecution_endedTime :: Lens' LaunchExecution (Maybe UTCTime) Source #
The date and time that the launch ended.
launchExecution_startedTime :: Lens' LaunchExecution (Maybe UTCTime) Source #
The date and time that the launch started.
LaunchGroup
launchGroup_description :: Lens' LaunchGroup (Maybe Text) Source #
A description of the launch group.
launchGroup_featureVariations :: Lens' LaunchGroup (HashMap Text Text) Source #
The feature variation for this launch group. This is a key-value pair.
launchGroup_name :: Lens' LaunchGroup Text Source #
The name of the launch group.
LaunchGroupConfig
launchGroupConfig_description :: Lens' LaunchGroupConfig (Maybe Text) Source #
A description of the launch group.
launchGroupConfig_feature :: Lens' LaunchGroupConfig Text Source #
The feature that this launch is using.
launchGroupConfig_name :: Lens' LaunchGroupConfig Text Source #
A name for this launch group.
launchGroupConfig_variation :: Lens' LaunchGroupConfig Text Source #
The feature variation to use for this launch group.
MetricDefinition
metricDefinition_entityIdKey :: Lens' MetricDefinition (Maybe Text) Source #
The entity, such as a user or session, that does an action that causes a metric value to be recorded.
metricDefinition_eventPattern :: Lens' MetricDefinition (Maybe Text) Source #
The EventBridge event pattern that defines how the metric is recorded.
For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
metricDefinition_name :: Lens' MetricDefinition (Maybe Text) Source #
The name of the metric.
metricDefinition_unitLabel :: Lens' MetricDefinition (Maybe Text) Source #
The label for the units that the metric is measuring.
metricDefinition_valueKey :: Lens' MetricDefinition (Maybe Text) Source #
The value that is tracked to produce the metric.
MetricDefinitionConfig
metricDefinitionConfig_eventPattern :: Lens' MetricDefinitionConfig (Maybe Text) Source #
The EventBridge event pattern that defines how the metric is recorded.
For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
metricDefinitionConfig_unitLabel :: Lens' MetricDefinitionConfig (Maybe Text) Source #
A label for the units that the metric is measuring.
metricDefinitionConfig_entityIdKey :: Lens' MetricDefinitionConfig Text Source #
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
.
metricDefinitionConfig_name :: Lens' MetricDefinitionConfig Text Source #
A name for the metric.
metricDefinitionConfig_valueKey :: Lens' MetricDefinitionConfig Text Source #
The value that is tracked to produce the metric.
MetricGoal
metricGoal_desiredChange :: Lens' MetricGoal (Maybe ChangeDirectionEnum) Source #
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.
metricGoal_metricDefinition :: Lens' MetricGoal MetricDefinition Source #
A structure that contains details about the metric.
MetricGoalConfig
metricGoalConfig_desiredChange :: Lens' MetricGoalConfig (Maybe ChangeDirectionEnum) Source #
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.
metricGoalConfig_metricDefinition :: Lens' MetricGoalConfig MetricDefinitionConfig Source #
A structure that contains details about the metric.
MetricMonitor
metricMonitor_metricDefinition :: Lens' MetricMonitor MetricDefinition Source #
A structure that defines the metric.
MetricMonitorConfig
metricMonitorConfig_metricDefinition :: Lens' MetricMonitorConfig MetricDefinitionConfig Source #
A structure that defines the metric.
OnlineAbConfig
onlineAbConfig_controlTreatmentName :: Lens' OnlineAbConfig (Maybe Text) Source #
The name of the variation that is to be the default variation that the other variations are compared to.
onlineAbConfig_treatmentWeights :: Lens' OnlineAbConfig (Maybe (HashMap Text Natural)) Source #
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.
OnlineAbDefinition
onlineAbDefinition_controlTreatmentName :: Lens' OnlineAbDefinition (Maybe Text) Source #
The name of the variation that is the default variation that the other variations are compared to.
onlineAbDefinition_treatmentWeights :: Lens' OnlineAbDefinition (Maybe (HashMap Text Natural)) Source #
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.
Project
project_activeExperimentCount :: Lens' Project (Maybe Integer) Source #
The number of ongoing experiments currently in the project.
project_activeLaunchCount :: Lens' Project (Maybe Integer) Source #
The number of ongoing launches currently in the project.
project_appConfigResource :: Lens' Project (Maybe ProjectAppConfigResource) Source #
This structure defines the configuration of how your application integrates with AppConfig to run client-side evaluation.
project_dataDelivery :: Lens' Project (Maybe ProjectDataDelivery) Source #
A structure that contains information about where Evidently is to store evaluation events for longer term storage.
project_description :: Lens' Project (Maybe Text) Source #
The user-entered description of the project.
project_experimentCount :: Lens' Project (Maybe Integer) Source #
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.
project_featureCount :: Lens' Project (Maybe Integer) Source #
The number of features currently in the project.
project_launchCount :: Lens' Project (Maybe Integer) Source #
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.
project_tags :: Lens' Project (Maybe (HashMap Text Text)) Source #
The list of tag keys and values associated with this project.
project_lastUpdatedTime :: Lens' Project UTCTime Source #
The date and time that the project was most recently updated.
project_status :: Lens' Project ProjectStatus Source #
The current state of the project.
ProjectAppConfigResource
projectAppConfigResource_applicationId :: Lens' ProjectAppConfigResource Text Source #
The ID of the AppConfig application to use for client-side evaluation.
projectAppConfigResource_configurationProfileId :: Lens' ProjectAppConfigResource Text Source #
The ID of the AppConfig profile to use for client-side evaluation.
projectAppConfigResource_environmentId :: Lens' ProjectAppConfigResource Text Source #
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
.
ProjectAppConfigResourceConfig
projectAppConfigResourceConfig_applicationId :: Lens' ProjectAppConfigResourceConfig (Maybe Text) Source #
The ID of the AppConfig application to use for client-side evaluation.
projectAppConfigResourceConfig_environmentId :: Lens' ProjectAppConfigResourceConfig (Maybe Text) Source #
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
.
ProjectDataDelivery
projectDataDelivery_cloudWatchLogs :: Lens' ProjectDataDelivery (Maybe CloudWatchLogsDestination) Source #
If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.
projectDataDelivery_s3Destination :: Lens' ProjectDataDelivery (Maybe S3Destination) Source #
If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
ProjectDataDeliveryConfig
projectDataDeliveryConfig_cloudWatchLogs :: Lens' ProjectDataDeliveryConfig (Maybe CloudWatchLogsDestinationConfig) Source #
If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name.
projectDataDeliveryConfig_s3Destination :: Lens' ProjectDataDeliveryConfig (Maybe S3DestinationConfig) Source #
If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
ProjectSummary
projectSummary_activeExperimentCount :: Lens' ProjectSummary (Maybe Integer) Source #
The number of experiments currently in the project.
projectSummary_activeLaunchCount :: Lens' ProjectSummary (Maybe Integer) Source #
The number of ongoing launches currently in the project.
projectSummary_description :: Lens' ProjectSummary (Maybe Text) Source #
The description of the project.
projectSummary_experimentCount :: Lens' ProjectSummary (Maybe Integer) Source #
The number of experiments currently in the project.
projectSummary_featureCount :: Lens' ProjectSummary (Maybe Integer) Source #
The number of features currently in the project.
projectSummary_launchCount :: Lens' ProjectSummary (Maybe Integer) Source #
The number of launches currently in the project, including launches that are ongoing, completed, and not started yet.
projectSummary_tags :: Lens' ProjectSummary (Maybe (HashMap Text Text)) Source #
The list of tag keys and values associated with this project.
projectSummary_arn :: Lens' ProjectSummary Text Source #
The name or ARN of the project.
projectSummary_createdTime :: Lens' ProjectSummary UTCTime Source #
The date and time that the project is created.
projectSummary_lastUpdatedTime :: Lens' ProjectSummary UTCTime Source #
The date and time that the project was most recently updated.
projectSummary_name :: Lens' ProjectSummary Text Source #
The name of the project.
projectSummary_status :: Lens' ProjectSummary ProjectStatus Source #
The current state of the project.
PutProjectEventsResultEntry
putProjectEventsResultEntry_errorCode :: Lens' PutProjectEventsResultEntry (Maybe Text) Source #
If the PutProjectEvents
operation has an error, the error code is
returned here.
putProjectEventsResultEntry_errorMessage :: Lens' PutProjectEventsResultEntry (Maybe Text) Source #
If the PutProjectEvents
operation has an error, the error message is
returned here.
putProjectEventsResultEntry_eventId :: Lens' PutProjectEventsResultEntry (Maybe Text) Source #
A unique ID assigned to this PutProjectEvents
operation.
RefResource
refResource_arn :: Lens' RefResource (Maybe Text) Source #
The ARN of the experiment or launch.
refResource_endTime :: Lens' RefResource (Maybe Text) Source #
The day and time that this experiment or launch ended.
refResource_lastUpdatedOn :: Lens' RefResource (Maybe Text) Source #
The day and time that this experiment or launch was most recently updated.
refResource_startTime :: Lens' RefResource (Maybe Text) Source #
The day and time that this experiment or launch started.
refResource_status :: Lens' RefResource (Maybe Text) Source #
The status of the experiment or launch.
refResource_name :: Lens' RefResource Text Source #
The name of the experiment or launch.
refResource_type :: Lens' RefResource Text Source #
Specifies whether the resource that this structure contains information about is an experiment or a launch.
S3Destination
s3Destination_bucket :: Lens' S3Destination (Maybe Text) Source #
The name of the bucket in which Evidently stores evaluation events.
s3Destination_prefix :: Lens' S3Destination (Maybe Text) Source #
The bucket prefix in which Evidently stores evaluation events.
S3DestinationConfig
s3DestinationConfig_bucket :: Lens' S3DestinationConfig (Maybe Text) Source #
The name of the bucket in which Evidently stores evaluation events.
s3DestinationConfig_prefix :: Lens' S3DestinationConfig (Maybe Text) Source #
The bucket prefix in which Evidently stores evaluation events.
ScheduledSplit
scheduledSplit_groupWeights :: Lens' ScheduledSplit (Maybe (HashMap Text Natural)) Source #
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.
scheduledSplit_segmentOverrides :: Lens' ScheduledSplit (Maybe [SegmentOverride]) Source #
Use 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.
scheduledSplit_startTime :: Lens' ScheduledSplit UTCTime Source #
The date and time that this step of the launch starts.
ScheduledSplitConfig
scheduledSplitConfig_segmentOverrides :: Lens' ScheduledSplitConfig (Maybe [SegmentOverride]) Source #
Use 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.
scheduledSplitConfig_groupWeights :: Lens' ScheduledSplitConfig (HashMap Text Natural) Source #
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.
<p>The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.</p> <p>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.</p>
scheduledSplitConfig_startTime :: Lens' ScheduledSplitConfig UTCTime Source #
The date and time that this step of the launch starts.
ScheduledSplitsLaunchConfig
scheduledSplitsLaunchConfig_steps :: Lens' ScheduledSplitsLaunchConfig (NonEmpty ScheduledSplitConfig) Source #
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.
ScheduledSplitsLaunchDefinition
scheduledSplitsLaunchDefinition_steps :: Lens' ScheduledSplitsLaunchDefinition (Maybe (NonEmpty ScheduledSplit)) Source #
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.
Segment
segment_description :: Lens' Segment (Maybe Text) Source #
The customer-created description for this segment.
segment_experimentCount :: Lens' Segment (Maybe Integer) Source #
The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.
segment_launchCount :: Lens' Segment (Maybe Integer) Source #
The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.
segment_tags :: Lens' Segment (Maybe (HashMap Text Text)) Source #
The list of tag keys and values associated with this launch.
segment_createdTime :: Lens' Segment UTCTime Source #
The date and time that this segment was created.
segment_lastUpdatedTime :: Lens' Segment UTCTime Source #
The date and time that this segment was most recently updated.
segment_pattern :: Lens' Segment Text Source #
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.
SegmentOverride
segmentOverride_evaluationOrder :: Lens' SegmentOverride Integer Source #
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.
segmentOverride_segment :: Lens' SegmentOverride Text Source #
The ARN of the segment to use.
segmentOverride_weights :: Lens' SegmentOverride (HashMap Text Natural) Source #
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.
Treatment
treatment_featureVariations :: Lens' Treatment (Maybe (HashMap Text Text)) Source #
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.
TreatmentConfig
treatmentConfig_description :: Lens' TreatmentConfig (Maybe Text) Source #
A description for this treatment.
treatmentConfig_feature :: Lens' TreatmentConfig Text Source #
The feature that this experiment is testing.
treatmentConfig_name :: Lens' TreatmentConfig Text Source #
A name for this treatment.
treatmentConfig_variation :: Lens' TreatmentConfig Text Source #
The name of the variation to use as this treatment in the experiment.
VariableValue
variableValue_boolValue :: Lens' VariableValue (Maybe Bool) Source #
If this feature uses the Boolean variation type, this field contains the Boolean value of this variation.
variableValue_doubleValue :: Lens' VariableValue (Maybe Double) Source #
If this feature uses the double integer variation type, this field contains the double integer value of this variation.
variableValue_longValue :: Lens' VariableValue (Maybe Integer) Source #
If this feature uses the long variation type, this field contains the long value of this variation.
variableValue_stringValue :: Lens' VariableValue (Maybe Text) Source #
If this feature uses the string variation type, this field contains the string value of this variation.
Variation
variation_value :: Lens' Variation (Maybe VariableValue) Source #
The value assigned to this variation.
VariationConfig
variationConfig_name :: Lens' VariationConfig Text Source #
The name of the variation.
variationConfig_value :: Lens' VariationConfig VariableValue Source #
The value assigned to this variation.