| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Evidently.Types
Contents
- Service Configuration
- Errors
- ChangeDirectionEnum
- EventType
- ExperimentBaseStat
- ExperimentReportName
- ExperimentResultRequestType
- ExperimentResultResponseType
- ExperimentStatus
- ExperimentStopDesiredState
- ExperimentType
- FeatureEvaluationStrategy
- FeatureStatus
- LaunchStatus
- LaunchStopDesiredState
- LaunchType
- ProjectStatus
- SegmentReferenceResourceType
- VariationValueType
- 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
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype ChangeDirectionEnum where
- newtype EventType where
- EventType' { }
- pattern EventType_Aws_evidently_custom :: EventType
- pattern EventType_Aws_evidently_evaluation :: EventType
- newtype ExperimentBaseStat where
- newtype ExperimentReportName where
- newtype ExperimentResultRequestType where
- ExperimentResultRequestType' { }
- pattern ExperimentResultRequestType_BaseStat :: ExperimentResultRequestType
- pattern ExperimentResultRequestType_ConfidenceInterval :: ExperimentResultRequestType
- pattern ExperimentResultRequestType_PValue :: ExperimentResultRequestType
- pattern ExperimentResultRequestType_TreatmentEffect :: ExperimentResultRequestType
- newtype ExperimentResultResponseType where
- ExperimentResultResponseType' { }
- pattern ExperimentResultResponseType_ConfidenceIntervalLowerBound :: ExperimentResultResponseType
- pattern ExperimentResultResponseType_ConfidenceIntervalUpperBound :: ExperimentResultResponseType
- pattern ExperimentResultResponseType_Mean :: ExperimentResultResponseType
- pattern ExperimentResultResponseType_PValue :: ExperimentResultResponseType
- pattern ExperimentResultResponseType_TreatmentEffect :: ExperimentResultResponseType
- newtype ExperimentStatus where
- ExperimentStatus' { }
- pattern ExperimentStatus_CANCELLED :: ExperimentStatus
- pattern ExperimentStatus_COMPLETED :: ExperimentStatus
- pattern ExperimentStatus_CREATED :: ExperimentStatus
- pattern ExperimentStatus_RUNNING :: ExperimentStatus
- pattern ExperimentStatus_UPDATING :: ExperimentStatus
- newtype ExperimentStopDesiredState where
- newtype ExperimentType where
- newtype FeatureEvaluationStrategy where
- newtype FeatureStatus where
- FeatureStatus' { }
- pattern FeatureStatus_AVAILABLE :: FeatureStatus
- pattern FeatureStatus_UPDATING :: FeatureStatus
- newtype LaunchStatus where
- LaunchStatus' { }
- pattern LaunchStatus_CANCELLED :: LaunchStatus
- pattern LaunchStatus_COMPLETED :: LaunchStatus
- pattern LaunchStatus_CREATED :: LaunchStatus
- pattern LaunchStatus_RUNNING :: LaunchStatus
- pattern LaunchStatus_UPDATING :: LaunchStatus
- newtype LaunchStopDesiredState where
- newtype LaunchType where
- LaunchType' { }
- pattern LaunchType_Aws_evidently_splits :: LaunchType
- newtype ProjectStatus where
- ProjectStatus' { }
- pattern ProjectStatus_AVAILABLE :: ProjectStatus
- pattern ProjectStatus_UPDATING :: ProjectStatus
- newtype SegmentReferenceResourceType where
- newtype VariationValueType where
- VariationValueType' { }
- pattern VariationValueType_BOOLEAN :: VariationValueType
- pattern VariationValueType_DOUBLE :: VariationValueType
- pattern VariationValueType_LONG :: VariationValueType
- pattern VariationValueType_STRING :: VariationValueType
- data CloudWatchLogsDestination = CloudWatchLogsDestination' {}
- newCloudWatchLogsDestination :: CloudWatchLogsDestination
- cloudWatchLogsDestination_logGroup :: Lens' CloudWatchLogsDestination (Maybe Text)
- data CloudWatchLogsDestinationConfig = CloudWatchLogsDestinationConfig' {}
- newCloudWatchLogsDestinationConfig :: CloudWatchLogsDestinationConfig
- cloudWatchLogsDestinationConfig_logGroup :: Lens' CloudWatchLogsDestinationConfig (Maybe Text)
- data EvaluationRequest = EvaluationRequest' {}
- newEvaluationRequest :: Text -> Text -> EvaluationRequest
- evaluationRequest_evaluationContext :: Lens' EvaluationRequest (Maybe Text)
- evaluationRequest_entityId :: Lens' EvaluationRequest Text
- evaluationRequest_feature :: Lens' EvaluationRequest Text
- data EvaluationResult = EvaluationResult' {}
- newEvaluationResult :: Text -> Text -> EvaluationResult
- 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
- data EvaluationRule = EvaluationRule' {}
- newEvaluationRule :: Text -> EvaluationRule
- evaluationRule_name :: Lens' EvaluationRule (Maybe Text)
- evaluationRule_type :: Lens' EvaluationRule Text
- data Event = Event' {}
- newEvent :: Text -> UTCTime -> EventType -> Event
- event_data :: Lens' Event Text
- event_timestamp :: Lens' Event UTCTime
- event_type :: Lens' Event EventType
- data Experiment = Experiment' {
- description :: Maybe Text
- execution :: Maybe ExperimentExecution
- metricGoals :: Maybe (NonEmpty MetricGoal)
- onlineAbDefinition :: Maybe OnlineAbDefinition
- project :: Maybe Text
- randomizationSalt :: Maybe Text
- samplingRate :: Maybe Natural
- schedule :: Maybe ExperimentSchedule
- segment :: Maybe Text
- statusReason :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- treatments :: Maybe (NonEmpty Treatment)
- arn :: Text
- createdTime :: POSIX
- lastUpdatedTime :: POSIX
- name :: Text
- status :: ExperimentStatus
- type' :: ExperimentType
- newExperiment :: Text -> UTCTime -> UTCTime -> Text -> ExperimentStatus -> ExperimentType -> Experiment
- 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
- data ExperimentExecution = ExperimentExecution' {}
- newExperimentExecution :: ExperimentExecution
- experimentExecution_endedTime :: Lens' ExperimentExecution (Maybe UTCTime)
- experimentExecution_startedTime :: Lens' ExperimentExecution (Maybe UTCTime)
- data ExperimentReport = ExperimentReport' {}
- newExperimentReport :: ExperimentReport
- experimentReport_content :: Lens' ExperimentReport (Maybe Text)
- experimentReport_metricName :: Lens' ExperimentReport (Maybe Text)
- experimentReport_reportName :: Lens' ExperimentReport (Maybe ExperimentReportName)
- experimentReport_treatmentName :: Lens' ExperimentReport (Maybe Text)
- data ExperimentResultsData = ExperimentResultsData' {}
- newExperimentResultsData :: ExperimentResultsData
- experimentResultsData_metricName :: Lens' ExperimentResultsData (Maybe Text)
- experimentResultsData_resultStat :: Lens' ExperimentResultsData (Maybe ExperimentResultResponseType)
- experimentResultsData_treatmentName :: Lens' ExperimentResultsData (Maybe Text)
- experimentResultsData_values :: Lens' ExperimentResultsData (Maybe [Double])
- data ExperimentSchedule = ExperimentSchedule' {}
- newExperimentSchedule :: ExperimentSchedule
- experimentSchedule_analysisCompleteTime :: Lens' ExperimentSchedule (Maybe UTCTime)
- data Feature = Feature' {
- defaultVariation :: Maybe Text
- description :: Maybe Text
- entityOverrides :: Maybe (HashMap Text Text)
- evaluationRules :: Maybe [EvaluationRule]
- project :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- arn :: Text
- createdTime :: POSIX
- evaluationStrategy :: FeatureEvaluationStrategy
- lastUpdatedTime :: POSIX
- name :: Text
- status :: FeatureStatus
- valueType :: VariationValueType
- variations :: [Variation]
- newFeature :: Text -> UTCTime -> FeatureEvaluationStrategy -> UTCTime -> Text -> FeatureStatus -> VariationValueType -> Feature
- 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]
- data FeatureSummary = FeatureSummary' {}
- newFeatureSummary :: Text -> UTCTime -> FeatureEvaluationStrategy -> UTCTime -> Text -> FeatureStatus -> FeatureSummary
- 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
- data Launch = Launch' {
- description :: Maybe Text
- execution :: Maybe LaunchExecution
- groups :: Maybe [LaunchGroup]
- metricMonitors :: Maybe [MetricMonitor]
- project :: Maybe Text
- randomizationSalt :: Maybe Text
- scheduledSplitsDefinition :: Maybe ScheduledSplitsLaunchDefinition
- statusReason :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- arn :: Text
- createdTime :: POSIX
- lastUpdatedTime :: POSIX
- name :: Text
- status :: LaunchStatus
- type' :: LaunchType
- newLaunch :: Text -> UTCTime -> UTCTime -> Text -> LaunchStatus -> LaunchType -> Launch
- 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
- data LaunchExecution = LaunchExecution' {}
- newLaunchExecution :: LaunchExecution
- launchExecution_endedTime :: Lens' LaunchExecution (Maybe UTCTime)
- launchExecution_startedTime :: Lens' LaunchExecution (Maybe UTCTime)
- data LaunchGroup = LaunchGroup' {
- description :: Maybe Text
- featureVariations :: HashMap Text Text
- name :: Text
- newLaunchGroup :: Text -> LaunchGroup
- launchGroup_description :: Lens' LaunchGroup (Maybe Text)
- launchGroup_featureVariations :: Lens' LaunchGroup (HashMap Text Text)
- launchGroup_name :: Lens' LaunchGroup Text
- data LaunchGroupConfig = LaunchGroupConfig' {}
- newLaunchGroupConfig :: Text -> Text -> Text -> LaunchGroupConfig
- launchGroupConfig_description :: Lens' LaunchGroupConfig (Maybe Text)
- launchGroupConfig_feature :: Lens' LaunchGroupConfig Text
- launchGroupConfig_name :: Lens' LaunchGroupConfig Text
- launchGroupConfig_variation :: Lens' LaunchGroupConfig Text
- data MetricDefinition = MetricDefinition' {}
- newMetricDefinition :: MetricDefinition
- 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)
- data MetricDefinitionConfig = MetricDefinitionConfig' {}
- newMetricDefinitionConfig :: Text -> Text -> Text -> MetricDefinitionConfig
- 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
- data MetricGoal = MetricGoal' {}
- newMetricGoal :: MetricDefinition -> MetricGoal
- metricGoal_desiredChange :: Lens' MetricGoal (Maybe ChangeDirectionEnum)
- metricGoal_metricDefinition :: Lens' MetricGoal MetricDefinition
- data MetricGoalConfig = MetricGoalConfig' {}
- newMetricGoalConfig :: MetricDefinitionConfig -> MetricGoalConfig
- metricGoalConfig_desiredChange :: Lens' MetricGoalConfig (Maybe ChangeDirectionEnum)
- metricGoalConfig_metricDefinition :: Lens' MetricGoalConfig MetricDefinitionConfig
- data MetricMonitor = MetricMonitor' {}
- newMetricMonitor :: MetricDefinition -> MetricMonitor
- metricMonitor_metricDefinition :: Lens' MetricMonitor MetricDefinition
- data MetricMonitorConfig = MetricMonitorConfig' {}
- newMetricMonitorConfig :: MetricDefinitionConfig -> MetricMonitorConfig
- metricMonitorConfig_metricDefinition :: Lens' MetricMonitorConfig MetricDefinitionConfig
- data OnlineAbConfig = OnlineAbConfig' {}
- newOnlineAbConfig :: OnlineAbConfig
- onlineAbConfig_controlTreatmentName :: Lens' OnlineAbConfig (Maybe Text)
- onlineAbConfig_treatmentWeights :: Lens' OnlineAbConfig (Maybe (HashMap Text Natural))
- data OnlineAbDefinition = OnlineAbDefinition' {}
- newOnlineAbDefinition :: OnlineAbDefinition
- onlineAbDefinition_controlTreatmentName :: Lens' OnlineAbDefinition (Maybe Text)
- onlineAbDefinition_treatmentWeights :: Lens' OnlineAbDefinition (Maybe (HashMap Text Natural))
- data Project = Project' {
- activeExperimentCount :: Maybe Integer
- activeLaunchCount :: Maybe Integer
- appConfigResource :: Maybe ProjectAppConfigResource
- dataDelivery :: Maybe ProjectDataDelivery
- description :: Maybe Text
- experimentCount :: Maybe Integer
- featureCount :: Maybe Integer
- launchCount :: Maybe Integer
- tags :: Maybe (HashMap Text Text)
- arn :: Text
- createdTime :: POSIX
- lastUpdatedTime :: POSIX
- name :: Text
- status :: ProjectStatus
- newProject :: Text -> UTCTime -> UTCTime -> Text -> ProjectStatus -> Project
- 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
- data ProjectAppConfigResource = ProjectAppConfigResource' {}
- newProjectAppConfigResource :: Text -> Text -> Text -> ProjectAppConfigResource
- projectAppConfigResource_applicationId :: Lens' ProjectAppConfigResource Text
- projectAppConfigResource_configurationProfileId :: Lens' ProjectAppConfigResource Text
- projectAppConfigResource_environmentId :: Lens' ProjectAppConfigResource Text
- data ProjectAppConfigResourceConfig = ProjectAppConfigResourceConfig' {}
- newProjectAppConfigResourceConfig :: ProjectAppConfigResourceConfig
- projectAppConfigResourceConfig_applicationId :: Lens' ProjectAppConfigResourceConfig (Maybe Text)
- projectAppConfigResourceConfig_environmentId :: Lens' ProjectAppConfigResourceConfig (Maybe Text)
- data ProjectDataDelivery = ProjectDataDelivery' {}
- newProjectDataDelivery :: ProjectDataDelivery
- projectDataDelivery_cloudWatchLogs :: Lens' ProjectDataDelivery (Maybe CloudWatchLogsDestination)
- projectDataDelivery_s3Destination :: Lens' ProjectDataDelivery (Maybe S3Destination)
- data ProjectDataDeliveryConfig = ProjectDataDeliveryConfig' {}
- newProjectDataDeliveryConfig :: ProjectDataDeliveryConfig
- projectDataDeliveryConfig_cloudWatchLogs :: Lens' ProjectDataDeliveryConfig (Maybe CloudWatchLogsDestinationConfig)
- projectDataDeliveryConfig_s3Destination :: Lens' ProjectDataDeliveryConfig (Maybe S3DestinationConfig)
- data ProjectSummary = ProjectSummary' {
- activeExperimentCount :: Maybe Integer
- activeLaunchCount :: Maybe Integer
- description :: Maybe Text
- experimentCount :: Maybe Integer
- featureCount :: Maybe Integer
- launchCount :: Maybe Integer
- tags :: Maybe (HashMap Text Text)
- arn :: Text
- createdTime :: POSIX
- lastUpdatedTime :: POSIX
- name :: Text
- status :: ProjectStatus
- newProjectSummary :: Text -> UTCTime -> UTCTime -> Text -> ProjectStatus -> ProjectSummary
- 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
- data PutProjectEventsResultEntry = PutProjectEventsResultEntry' {}
- newPutProjectEventsResultEntry :: PutProjectEventsResultEntry
- putProjectEventsResultEntry_errorCode :: Lens' PutProjectEventsResultEntry (Maybe Text)
- putProjectEventsResultEntry_errorMessage :: Lens' PutProjectEventsResultEntry (Maybe Text)
- putProjectEventsResultEntry_eventId :: Lens' PutProjectEventsResultEntry (Maybe Text)
- data RefResource = RefResource' {}
- newRefResource :: Text -> Text -> RefResource
- 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
- data S3Destination = S3Destination' {}
- newS3Destination :: S3Destination
- s3Destination_bucket :: Lens' S3Destination (Maybe Text)
- s3Destination_prefix :: Lens' S3Destination (Maybe Text)
- data S3DestinationConfig = S3DestinationConfig' {}
- newS3DestinationConfig :: S3DestinationConfig
- s3DestinationConfig_bucket :: Lens' S3DestinationConfig (Maybe Text)
- s3DestinationConfig_prefix :: Lens' S3DestinationConfig (Maybe Text)
- data ScheduledSplit = ScheduledSplit' {}
- newScheduledSplit :: UTCTime -> ScheduledSplit
- scheduledSplit_groupWeights :: Lens' ScheduledSplit (Maybe (HashMap Text Natural))
- scheduledSplit_segmentOverrides :: Lens' ScheduledSplit (Maybe [SegmentOverride])
- scheduledSplit_startTime :: Lens' ScheduledSplit UTCTime
- data ScheduledSplitConfig = ScheduledSplitConfig' {}
- newScheduledSplitConfig :: UTCTime -> ScheduledSplitConfig
- scheduledSplitConfig_segmentOverrides :: Lens' ScheduledSplitConfig (Maybe [SegmentOverride])
- scheduledSplitConfig_groupWeights :: Lens' ScheduledSplitConfig (HashMap Text Natural)
- scheduledSplitConfig_startTime :: Lens' ScheduledSplitConfig UTCTime
- data ScheduledSplitsLaunchConfig = ScheduledSplitsLaunchConfig' {}
- newScheduledSplitsLaunchConfig :: NonEmpty ScheduledSplitConfig -> ScheduledSplitsLaunchConfig
- scheduledSplitsLaunchConfig_steps :: Lens' ScheduledSplitsLaunchConfig (NonEmpty ScheduledSplitConfig)
- data ScheduledSplitsLaunchDefinition = ScheduledSplitsLaunchDefinition' {
- steps :: Maybe (NonEmpty ScheduledSplit)
- newScheduledSplitsLaunchDefinition :: ScheduledSplitsLaunchDefinition
- scheduledSplitsLaunchDefinition_steps :: Lens' ScheduledSplitsLaunchDefinition (Maybe (NonEmpty ScheduledSplit))
- data Segment = Segment' {
- description :: Maybe Text
- experimentCount :: Maybe Integer
- launchCount :: Maybe Integer
- tags :: Maybe (HashMap Text Text)
- arn :: Text
- createdTime :: POSIX
- lastUpdatedTime :: POSIX
- name :: Text
- pattern' :: Text
- newSegment :: Text -> UTCTime -> UTCTime -> Text -> Text -> Segment
- 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
- data SegmentOverride = SegmentOverride' {}
- newSegmentOverride :: Integer -> Text -> SegmentOverride
- segmentOverride_evaluationOrder :: Lens' SegmentOverride Integer
- segmentOverride_segment :: Lens' SegmentOverride Text
- segmentOverride_weights :: Lens' SegmentOverride (HashMap Text Natural)
- data Treatment = Treatment' {
- description :: Maybe Text
- featureVariations :: Maybe (HashMap Text Text)
- name :: Text
- newTreatment :: Text -> Treatment
- treatment_description :: Lens' Treatment (Maybe Text)
- treatment_featureVariations :: Lens' Treatment (Maybe (HashMap Text Text))
- treatment_name :: Lens' Treatment Text
- data TreatmentConfig = TreatmentConfig' {}
- newTreatmentConfig :: Text -> Text -> Text -> TreatmentConfig
- treatmentConfig_description :: Lens' TreatmentConfig (Maybe Text)
- treatmentConfig_feature :: Lens' TreatmentConfig Text
- treatmentConfig_name :: Lens' TreatmentConfig Text
- treatmentConfig_variation :: Lens' TreatmentConfig Text
- data VariableValue = VariableValue' {}
- newVariableValue :: VariableValue
- variableValue_boolValue :: Lens' VariableValue (Maybe Bool)
- variableValue_doubleValue :: Lens' VariableValue (Maybe Double)
- variableValue_longValue :: Lens' VariableValue (Maybe Integer)
- variableValue_stringValue :: Lens' VariableValue (Maybe Text)
- data Variation = Variation' {}
- newVariation :: Variation
- variation_name :: Lens' Variation (Maybe Text)
- variation_value :: Lens' Variation (Maybe VariableValue)
- data VariationConfig = VariationConfig' {
- name :: Text
- value :: VariableValue
- newVariationConfig :: Text -> VariableValue -> VariationConfig
- variationConfig_name :: Lens' VariationConfig Text
- variationConfig_value :: Lens' VariationConfig VariableValue
Service Configuration
defaultService :: Service Source #
API version 2021-02-01 of the Amazon CloudWatch Evidently SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient permissions to perform this action.
_ConflictException :: AsError a => Fold a ServiceError Source #
A resource was in an inconsistent state during an update or a deletion.
_InternalServerException :: AsError a => Fold a ServiceError Source #
Unexpected error while processing the request. Retry the request.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The request references a resource that does not exist.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request would cause a service quota to be exceeded.
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The service was unavailable. Retry the request.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied because of request throttling. Retry the request.
_ValidationException :: AsError a => Fold a ServiceError Source #
The value of a parameter in the request caused an error.
ChangeDirectionEnum
newtype ChangeDirectionEnum Source #
Constructors
| ChangeDirectionEnum' | |
Fields | |
Bundled Patterns
| pattern ChangeDirectionEnum_DECREASE :: ChangeDirectionEnum | |
| pattern ChangeDirectionEnum_INCREASE :: ChangeDirectionEnum |
Instances
EventType
Constructors
| EventType' | |
Fields | |
Bundled Patterns
| pattern EventType_Aws_evidently_custom :: EventType | |
| pattern EventType_Aws_evidently_evaluation :: EventType |
Instances
ExperimentBaseStat
newtype ExperimentBaseStat Source #
Constructors
| ExperimentBaseStat' | |
Fields | |
Bundled Patterns
| pattern ExperimentBaseStat_Mean :: ExperimentBaseStat |
Instances
ExperimentReportName
newtype ExperimentReportName Source #
Constructors
| ExperimentReportName' | |
Fields | |
Bundled Patterns
| pattern ExperimentReportName_BayesianInference :: ExperimentReportName |
Instances
ExperimentResultRequestType
newtype ExperimentResultRequestType Source #
Constructors
| ExperimentResultRequestType' | |
Fields | |
Bundled Patterns
Instances
ExperimentResultResponseType
newtype ExperimentResultResponseType Source #
Constructors
| ExperimentResultResponseType' | |
Fields | |
Bundled Patterns
Instances
ExperimentStatus
newtype ExperimentStatus Source #
Constructors
| ExperimentStatus' | |
Fields | |
Bundled Patterns
| pattern ExperimentStatus_CANCELLED :: ExperimentStatus | |
| pattern ExperimentStatus_COMPLETED :: ExperimentStatus | |
| pattern ExperimentStatus_CREATED :: ExperimentStatus | |
| pattern ExperimentStatus_RUNNING :: ExperimentStatus | |
| pattern ExperimentStatus_UPDATING :: ExperimentStatus |
Instances
ExperimentStopDesiredState
newtype ExperimentStopDesiredState Source #
Constructors
| ExperimentStopDesiredState' | |
Fields | |
Bundled Patterns
| pattern ExperimentStopDesiredState_CANCELLED :: ExperimentStopDesiredState | |
| pattern ExperimentStopDesiredState_COMPLETED :: ExperimentStopDesiredState |
Instances
ExperimentType
newtype ExperimentType Source #
Constructors
| ExperimentType' | |
Fields | |
Bundled Patterns
| pattern ExperimentType_Aws_evidently_onlineab :: ExperimentType |
Instances
FeatureEvaluationStrategy
newtype FeatureEvaluationStrategy Source #
Constructors
| FeatureEvaluationStrategy' | |
Fields | |
Bundled Patterns
| pattern FeatureEvaluationStrategy_ALL_RULES :: FeatureEvaluationStrategy | |
| pattern FeatureEvaluationStrategy_DEFAULT_VARIATION :: FeatureEvaluationStrategy |
Instances
FeatureStatus
newtype FeatureStatus Source #
Constructors
| FeatureStatus' | |
Fields | |
Bundled Patterns
| pattern FeatureStatus_AVAILABLE :: FeatureStatus | |
| pattern FeatureStatus_UPDATING :: FeatureStatus |
Instances
LaunchStatus
newtype LaunchStatus Source #
Constructors
| LaunchStatus' | |
Fields | |
Bundled Patterns
| pattern LaunchStatus_CANCELLED :: LaunchStatus | |
| pattern LaunchStatus_COMPLETED :: LaunchStatus | |
| pattern LaunchStatus_CREATED :: LaunchStatus | |
| pattern LaunchStatus_RUNNING :: LaunchStatus | |
| pattern LaunchStatus_UPDATING :: LaunchStatus |
Instances
LaunchStopDesiredState
newtype LaunchStopDesiredState Source #
Constructors
| LaunchStopDesiredState' | |
Fields | |
Bundled Patterns
| pattern LaunchStopDesiredState_CANCELLED :: LaunchStopDesiredState | |
| pattern LaunchStopDesiredState_COMPLETED :: LaunchStopDesiredState |
Instances
LaunchType
newtype LaunchType Source #
Constructors
| LaunchType' | |
Fields | |
Bundled Patterns
| pattern LaunchType_Aws_evidently_splits :: LaunchType |
Instances
ProjectStatus
newtype ProjectStatus Source #
Constructors
| ProjectStatus' | |
Fields | |
Bundled Patterns
| pattern ProjectStatus_AVAILABLE :: ProjectStatus | |
| pattern ProjectStatus_UPDATING :: ProjectStatus |
Instances
SegmentReferenceResourceType
newtype SegmentReferenceResourceType Source #
Constructors
| SegmentReferenceResourceType' | |
Fields | |
Bundled Patterns
| pattern SegmentReferenceResourceType_EXPERIMENT :: SegmentReferenceResourceType | |
| pattern SegmentReferenceResourceType_LAUNCH :: SegmentReferenceResourceType |
Instances
VariationValueType
newtype VariationValueType Source #
Constructors
| VariationValueType' | |
Fields | |
Bundled Patterns
| pattern VariationValueType_BOOLEAN :: VariationValueType | |
| pattern VariationValueType_DOUBLE :: VariationValueType | |
| pattern VariationValueType_LONG :: VariationValueType | |
| pattern VariationValueType_STRING :: VariationValueType |
Instances
CloudWatchLogsDestination
data CloudWatchLogsDestination Source #
A structure containing the CloudWatch Logs log group where the project stores evaluation events.
See: newCloudWatchLogsDestination smart constructor.
Constructors
| CloudWatchLogsDestination' | |
Instances
newCloudWatchLogsDestination :: CloudWatchLogsDestination Source #
Create a value of CloudWatchLogsDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logGroup:CloudWatchLogsDestination', cloudWatchLogsDestination_logGroup - The name of the log group where the project stores evaluation events.
cloudWatchLogsDestination_logGroup :: Lens' CloudWatchLogsDestination (Maybe Text) Source #
The name of the log group where the project stores evaluation events.
CloudWatchLogsDestinationConfig
data CloudWatchLogsDestinationConfig Source #
A structure containing the CloudWatch Logs log group where the project stores evaluation events.
See: newCloudWatchLogsDestinationConfig smart constructor.
Constructors
| CloudWatchLogsDestinationConfig' | |
Instances
newCloudWatchLogsDestinationConfig :: CloudWatchLogsDestinationConfig Source #
Create a value of CloudWatchLogsDestinationConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logGroup:CloudWatchLogsDestinationConfig', cloudWatchLogsDestinationConfig_logGroup - The name of the log group where the project stores evaluation events.
cloudWatchLogsDestinationConfig_logGroup :: Lens' CloudWatchLogsDestinationConfig (Maybe Text) Source #
The name of the log group where the project stores evaluation events.
EvaluationRequest
data EvaluationRequest Source #
This structure assigns a feature variation to one user session.
See: newEvaluationRequest smart constructor.
Constructors
| EvaluationRequest' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> EvaluationRequest |
Create a value of EvaluationRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:evaluationContext:EvaluationRequest', evaluationRequest_evaluationContext - 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.
$sel:entityId:EvaluationRequest', evaluationRequest_entityId - An internal ID that represents a unique user session of the application.
This entityID is checked against any override rules assigned for this
feature.
$sel:feature:EvaluationRequest', evaluationRequest_feature - The name of the feature being evaluated.
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
data EvaluationResult Source #
This structure displays the results of one feature evaluation assignment to one user session.
See: newEvaluationResult smart constructor.
Constructors
| EvaluationResult' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> EvaluationResult |
Create a value of EvaluationResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:details:EvaluationResult', evaluationResult_details - If this user was assigned to a launch or experiment, this field lists
the launch or experiment name.
$sel:project:EvaluationResult', evaluationResult_project - The name or ARN of the project that contains the feature being
evaluated.
$sel:reason:EvaluationResult', evaluationResult_reason - 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.
$sel:value:EvaluationResult', evaluationResult_value - The value assigned to this variation to differentiate it from the other
variations of this feature.
$sel:variation:EvaluationResult', evaluationResult_variation - The name of the variation that was served to the user session.
$sel:entityId:EvaluationResult', evaluationResult_entityId - An internal ID that represents a unique user session of the application.
$sel:feature:EvaluationResult', evaluationResult_feature - The name of the feature being evaluated.
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
data EvaluationRule Source #
A structure that contains the information about an evaluation rule for this feature, if it is used in a launch or experiment.
See: newEvaluationRule smart constructor.
Constructors
| EvaluationRule' | |
Instances
Arguments
| :: Text | |
| -> EvaluationRule |
Create a value of EvaluationRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:EvaluationRule', evaluationRule_name - The name of the experiment or launch.
$sel:type':EvaluationRule', evaluationRule_type - 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.
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
A structure that contains the information about one evaluation event or custom event sent to Evidently. This is a JSON payload. If this event specifies a pre-defined event type, the payload must follow the defined event schema.
See: newEvent smart constructor.
Constructors
| Event' | |
Fields
| |
Instances
| ToJSON Event Source # | |
Defined in Amazonka.Evidently.Types.Event | |
| Generic Event Source # | |
| Read Event Source # | |
| Show Event Source # | |
| NFData Event Source # | |
Defined in Amazonka.Evidently.Types.Event | |
| Eq Event Source # | |
| Hashable Event Source # | |
Defined in Amazonka.Evidently.Types.Event | |
| type Rep Event Source # | |
Defined in Amazonka.Evidently.Types.Event type Rep Event = D1 ('MetaData "Event" "Amazonka.Evidently.Types.Event" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "Event'" 'PrefixI 'True) (S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EventType)))) | |
Create a value of Event with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:data':Event', event_data - The event data.
$sel:timestamp:Event', event_timestamp - The timestamp of the event.
$sel:type':Event', event_type - 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.
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
data Experiment Source #
A structure containing the configuration details of an experiment.
See: newExperiment smart constructor.
Constructors
| Experiment' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> Text | |
| -> ExperimentStatus | |
| -> ExperimentType | |
| -> Experiment |
Create a value of Experiment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
Experiment, experiment_description - A description of the experiment.
$sel:execution:Experiment', experiment_execution - A structure that contains the date and time that the experiment started
and ended.
$sel:metricGoals:Experiment', experiment_metricGoals - 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.
$sel:onlineAbDefinition:Experiment', experiment_onlineAbDefinition - 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.
$sel:project:Experiment', experiment_project - The name or ARN of the project that contains this experiment.
$sel:randomizationSalt:Experiment', experiment_randomizationSalt - 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.
$sel:samplingRate:Experiment', experiment_samplingRate - 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.
$sel:schedule:Experiment', experiment_schedule - A structure that contains the time and date that Evidently completed the
analysis of the experiment.
$sel:segment:Experiment', experiment_segment - The audience segment being used for the experiment, if a segment is
being used.
$sel:statusReason:Experiment', experiment_statusReason - 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.
$sel:tags:Experiment', experiment_tags - The list of tag keys and values associated with this experiment.
$sel:treatments:Experiment', experiment_treatments - An array of structures that describe the configuration of each feature
variation used in the experiment.
$sel:arn:Experiment', experiment_arn - The ARN of the experiment.
$sel:createdTime:Experiment', experiment_createdTime - The date and time that the experiment is first created.
$sel:lastUpdatedTime:Experiment', experiment_lastUpdatedTime - The date and time that the experiment was most recently updated.
Experiment, experiment_name - The name of the experiment.
$sel:status:Experiment', experiment_status - The current state of the experiment.
$sel:type':Experiment', experiment_type - The type of this experiment. Currently, this value must be
aws.experiment.onlineab.
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
data ExperimentExecution Source #
This structure contains the date and time that the experiment started and ended.
See: newExperimentExecution smart constructor.
Constructors
| ExperimentExecution' | |
Instances
newExperimentExecution :: ExperimentExecution Source #
Create a value of ExperimentExecution with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endedTime:ExperimentExecution', experimentExecution_endedTime - The date and time that the experiment ended.
$sel:startedTime:ExperimentExecution', experimentExecution_startedTime - The date and time that the experiment started.
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
data ExperimentReport Source #
A structure that contains results of an experiment.
See: newExperimentReport smart constructor.
Constructors
| ExperimentReport' | |
Fields
| |
Instances
newExperimentReport :: ExperimentReport Source #
Create a value of ExperimentReport with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:content:ExperimentReport', experimentReport_content - The content of the report.
$sel:metricName:ExperimentReport', experimentReport_metricName - The name of the metric that is analyzed in this experiment report.
$sel:reportName:ExperimentReport', experimentReport_reportName - The type of analysis used for this report.
$sel:treatmentName:ExperimentReport', experimentReport_treatmentName - The name of the variation that this report pertains to.
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
data ExperimentResultsData Source #
A structure that contains experiment results for one metric that is monitored in the experiment.
See: newExperimentResultsData smart constructor.
Constructors
| ExperimentResultsData' | |
Fields
| |
Instances
newExperimentResultsData :: ExperimentResultsData Source #
Create a value of ExperimentResultsData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metricName:ExperimentResultsData', experimentResultsData_metricName - The name of the metric.
$sel:resultStat:ExperimentResultsData', experimentResultsData_resultStat - The experiment statistic that these results pertain to.
$sel:treatmentName:ExperimentResultsData', experimentResultsData_treatmentName - The treatment, or variation, that returned the values in this
structure.
$sel:values:ExperimentResultsData', experimentResultsData_values - The values for the metricName that were recorded in the experiment.
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
data ExperimentSchedule Source #
This structure contains the time and date that Evidently completed the analysis of the experiment.
See: newExperimentSchedule smart constructor.
Constructors
| ExperimentSchedule' | |
Fields
| |
Instances
newExperimentSchedule :: ExperimentSchedule Source #
Create a value of ExperimentSchedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:analysisCompleteTime:ExperimentSchedule', experimentSchedule_analysisCompleteTime - The time and date that Evidently completed the analysis of the
experiment.
experimentSchedule_analysisCompleteTime :: Lens' ExperimentSchedule (Maybe UTCTime) Source #
The time and date that Evidently completed the analysis of the experiment.
Feature
This structure contains information about one Evidently feature in your account.
See: newFeature smart constructor.
Constructors
| Feature' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> UTCTime | |
| -> FeatureEvaluationStrategy | |
| -> UTCTime | |
| -> Text | |
| -> FeatureStatus | |
| -> VariationValueType | |
| -> Feature |
Create a value of Feature with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultVariation:Feature', feature_defaultVariation - The name of the variation that is used as the default variation. The
default variation is served to users who are not allocated to any
ongoing launches or experiments of this feature.
This variation must also be listed in the variations structure.
If you omit defaultVariation, the first variation listed in the
variations structure is used as the default variation.
$sel:description:Feature', feature_description - The description of the feature.
$sel:entityOverrides:Feature', feature_entityOverrides - A set of key-value pairs that specify users who should always be served
a specific variation of a feature. Each key specifies a user using their
user ID, account ID, or some other identifier. The value specifies the
name of the variation that the user is to be served.
For the override to be successful, the value of the key must match the
entityId used in the
EvaluateFeature
operation.
$sel:evaluationRules:Feature', feature_evaluationRules - An array of structures that define the evaluation rules for the feature.
$sel:project:Feature', feature_project - The name or ARN of the project that contains the feature.
$sel:tags:Feature', feature_tags - The list of tag keys and values associated with this feature.
$sel:arn:Feature', feature_arn - The ARN of the feature.
$sel:createdTime:Feature', feature_createdTime - The date and time that the feature is created.
$sel:evaluationStrategy:Feature', feature_evaluationStrategy - If this value is ALL_RULES, the traffic allocation specified by any
ongoing launches or experiments is being used. If this is
DEFAULT_VARIATION, the default variation is being served to all users.
$sel:lastUpdatedTime:Feature', feature_lastUpdatedTime - The date and time that the feature was most recently updated.
Feature, feature_name - The name of the feature.
$sel:status:Feature', feature_status - The current state of the feature.
$sel:valueType:Feature', feature_valueType - Defines the type of value used to define the different feature
variations. For more information, see
Variation types
$sel:variations:Feature', feature_variations - An array of structures that contain the configuration of the feature's
different variations.
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
data FeatureSummary Source #
This structure contains information about one Evidently feature in your account.
See: newFeatureSummary smart constructor.
Constructors
| FeatureSummary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> UTCTime | |
| -> FeatureEvaluationStrategy | |
| -> UTCTime | |
| -> Text | |
| -> FeatureStatus | |
| -> FeatureSummary |
Create a value of FeatureSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultVariation:FeatureSummary', featureSummary_defaultVariation - The name of the variation that is used as the default variation. The
default variation is served to users who are not allocated to any
ongoing launches or experiments of this feature.
$sel:evaluationRules:FeatureSummary', featureSummary_evaluationRules - An array of structures that define
$sel:project:FeatureSummary', featureSummary_project - The name or ARN of the project that contains the feature.
$sel:tags:FeatureSummary', featureSummary_tags - The list of tag keys and values associated with this feature.
$sel:arn:FeatureSummary', featureSummary_arn - The ARN of the feature.
$sel:createdTime:FeatureSummary', featureSummary_createdTime - The date and time that the feature is created.
$sel:evaluationStrategy:FeatureSummary', featureSummary_evaluationStrategy - If this value is ALL_RULES, the traffic allocation specified by any
ongoing launches or experiments is being used. If this is
DEFAULT_VARIATION, the default variation is being served to all users.
$sel:lastUpdatedTime:FeatureSummary', featureSummary_lastUpdatedTime - The date and time that the feature was most recently updated.
FeatureSummary, featureSummary_name - The name of the feature.
$sel:status:FeatureSummary', featureSummary_status - The current state of the feature.
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
This structure contains the configuration details of one Evidently launch.
See: newLaunch smart constructor.
Constructors
| Launch' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> Text | |
| -> LaunchStatus | |
| -> LaunchType | |
| -> Launch |
Create a value of Launch with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
Launch, launch_description - The description of the launch.
$sel:execution:Launch', launch_execution - A structure that contains information about the start and end times of
the launch.
$sel:groups:Launch', launch_groups - An array of structures that define the feature variations that are being
used in the launch.
$sel:metricMonitors:Launch', launch_metricMonitors - An array of structures that define the metrics that are being used to
monitor the launch performance.
$sel:project:Launch', launch_project - The name or ARN of the project that contains the launch.
$sel:randomizationSalt:Launch', launch_randomizationSalt - 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.
$sel:scheduledSplitsDefinition:Launch', launch_scheduledSplitsDefinition - An array of structures that define the traffic allocation percentages
among the feature variations during each step of the launch.
$sel:statusReason:Launch', launch_statusReason - 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.
$sel:tags:Launch', launch_tags - The list of tag keys and values associated with this launch.
$sel:arn:Launch', launch_arn - The ARN of the launch.
$sel:createdTime:Launch', launch_createdTime - The date and time that the launch is created.
$sel:lastUpdatedTime:Launch', launch_lastUpdatedTime - The date and time that the launch was most recently updated.
Launch, launch_name - The name of the launch.
$sel:status:Launch', launch_status - The current state of the launch.
$sel:type':Launch', launch_type - The type of 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
data LaunchExecution Source #
This structure contains information about the start and end times of the launch.
See: newLaunchExecution smart constructor.
Constructors
| LaunchExecution' | |
Instances
newLaunchExecution :: LaunchExecution Source #
Create a value of LaunchExecution with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endedTime:LaunchExecution', launchExecution_endedTime - The date and time that the launch ended.
$sel:startedTime:LaunchExecution', launchExecution_startedTime - The date and time that the launch started.
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
data LaunchGroup Source #
A structure that defines one launch group in a launch. A launch group is a variation of the feature that you are including in the launch.
See: newLaunchGroup smart constructor.
Constructors
| LaunchGroup' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> LaunchGroup |
Create a value of LaunchGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:LaunchGroup', launchGroup_description - A description of the launch group.
$sel:featureVariations:LaunchGroup', launchGroup_featureVariations - The feature variation for this launch group. This is a key-value pair.
$sel:name:LaunchGroup', launchGroup_name - The name of the launch group.
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
data LaunchGroupConfig Source #
A structure that defines one launch group in a launch. A launch group is a variation of the feature that you are including in the launch.
See: newLaunchGroupConfig smart constructor.
Constructors
| LaunchGroupConfig' | |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> LaunchGroupConfig |
Create a value of LaunchGroupConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:LaunchGroupConfig', launchGroupConfig_description - A description of the launch group.
$sel:feature:LaunchGroupConfig', launchGroupConfig_feature - The feature that this launch is using.
$sel:name:LaunchGroupConfig', launchGroupConfig_name - A name for this launch group.
$sel:variation:LaunchGroupConfig', launchGroupConfig_variation - The feature variation to use for this launch group.
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
data MetricDefinition Source #
This structure defines a metric that is being used to evaluate the variations during a launch or experiment.
See: newMetricDefinition smart constructor.
Constructors
| MetricDefinition' | |
Fields
| |
Instances
newMetricDefinition :: MetricDefinition Source #
Create a value of MetricDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entityIdKey:MetricDefinition', metricDefinition_entityIdKey - The entity, such as a user or session, that does an action that causes a
metric value to be recorded.
$sel:eventPattern:MetricDefinition', metricDefinition_eventPattern - The EventBridge event pattern that defines how the metric is recorded.
For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
$sel:name:MetricDefinition', metricDefinition_name - The name of the metric.
$sel:unitLabel:MetricDefinition', metricDefinition_unitLabel - The label for the units that the metric is measuring.
$sel:valueKey:MetricDefinition', metricDefinition_valueKey - The value that is tracked to produce the metric.
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
data MetricDefinitionConfig Source #
This structure defines a metric that you want to use to evaluate the variations during a launch or experiment.
See: newMetricDefinitionConfig smart constructor.
Constructors
| MetricDefinitionConfig' | |
Fields
| |
Instances
newMetricDefinitionConfig Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> MetricDefinitionConfig |
Create a value of MetricDefinitionConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventPattern:MetricDefinitionConfig', metricDefinitionConfig_eventPattern - The EventBridge event pattern that defines how the metric is recorded.
For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
$sel:unitLabel:MetricDefinitionConfig', metricDefinitionConfig_unitLabel - A label for the units that the metric is measuring.
$sel:entityIdKey:MetricDefinitionConfig', metricDefinitionConfig_entityIdKey - 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.
$sel:name:MetricDefinitionConfig', metricDefinitionConfig_name - A name for the metric.
$sel:valueKey:MetricDefinitionConfig', metricDefinitionConfig_valueKey - The value that is tracked to produce the metric.
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
data MetricGoal Source #
A structure that tells Evidently whether higher or lower values are desired for a metric that is used in an experiment.
See: newMetricGoal smart constructor.
Constructors
| MetricGoal' | |
Fields
| |
Instances
Arguments
| :: MetricDefinition | |
| -> MetricGoal |
Create a value of MetricGoal with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:desiredChange:MetricGoal', metricGoal_desiredChange - 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.
$sel:metricDefinition:MetricGoal', metricGoal_metricDefinition - A structure that contains details about the metric.
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
data MetricGoalConfig Source #
Use this structure to tell Evidently whether higher or lower values are desired for a metric that is used in an experiment.
See: newMetricGoalConfig smart constructor.
Constructors
| MetricGoalConfig' | |
Fields
| |
Instances
Create a value of MetricGoalConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:desiredChange:MetricGoalConfig', metricGoalConfig_desiredChange - 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.
$sel:metricDefinition:MetricGoalConfig', metricGoalConfig_metricDefinition - A structure that contains details about the metric.
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
data MetricMonitor Source #
A structure that defines a metric to be used to monitor performance of the variations during a launch.
See: newMetricMonitor smart constructor.
Constructors
| MetricMonitor' | |
Fields
| |
Instances
Create a value of MetricMonitor with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metricDefinition:MetricMonitor', metricMonitor_metricDefinition - A structure that defines the metric.
metricMonitor_metricDefinition :: Lens' MetricMonitor MetricDefinition Source #
A structure that defines the metric.
MetricMonitorConfig
data MetricMonitorConfig Source #
A structure that defines a metric to be used to monitor performance of the variations during a launch.
See: newMetricMonitorConfig smart constructor.
Constructors
| MetricMonitorConfig' | |
Fields
| |
Instances
newMetricMonitorConfig Source #
Create a value of MetricMonitorConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metricDefinition:MetricMonitorConfig', metricMonitorConfig_metricDefinition - A structure that defines the metric.
metricMonitorConfig_metricDefinition :: Lens' MetricMonitorConfig MetricDefinitionConfig Source #
A structure that defines the metric.
OnlineAbConfig
data OnlineAbConfig 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.
See: newOnlineAbConfig smart constructor.
Constructors
| OnlineAbConfig' | |
Fields
| |
Instances
newOnlineAbConfig :: OnlineAbConfig Source #
Create a value of OnlineAbConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:controlTreatmentName:OnlineAbConfig', onlineAbConfig_controlTreatmentName - The name of the variation that is to be the default variation that the
other variations are compared to.
$sel:treatmentWeights:OnlineAbConfig', onlineAbConfig_treatmentWeights - 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.
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
data 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.
See: newOnlineAbDefinition smart constructor.
Constructors
| OnlineAbDefinition' | |
Fields
| |
Instances
newOnlineAbDefinition :: OnlineAbDefinition Source #
Create a value of OnlineAbDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:controlTreatmentName:OnlineAbDefinition', onlineAbDefinition_controlTreatmentName - The name of the variation that is the default variation that the other
variations are compared to.
$sel:treatmentWeights:OnlineAbDefinition', onlineAbDefinition_treatmentWeights - 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.
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
This structure defines a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together.
See: newProject smart constructor.
Constructors
| Project' | |
Fields
| |
Instances
Create a value of Project with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:activeExperimentCount:Project', project_activeExperimentCount - The number of ongoing experiments currently in the project.
$sel:activeLaunchCount:Project', project_activeLaunchCount - The number of ongoing launches currently in the project.
$sel:appConfigResource:Project', project_appConfigResource - This structure defines the configuration of how your application
integrates with AppConfig to run client-side evaluation.
$sel:dataDelivery:Project', project_dataDelivery - A structure that contains information about where Evidently is to store
evaluation events for longer term storage.
$sel:description:Project', project_description - The user-entered description of the project.
$sel:experimentCount:Project', project_experimentCount - 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.
$sel:featureCount:Project', project_featureCount - The number of features currently in the project.
$sel:launchCount:Project', project_launchCount - 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.
$sel:tags:Project', project_tags - The list of tag keys and values associated with this project.
$sel:arn:Project', project_arn - The name or ARN of the project.
$sel:createdTime:Project', project_createdTime - The date and time that the project is created.
$sel:lastUpdatedTime:Project', project_lastUpdatedTime - The date and time that the project was most recently updated.
$sel:name:Project', project_name - The name of the project.
$sel:status:Project', project_status - The current state of the 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
data ProjectAppConfigResource Source #
This is a structure that defines the configuration of how your application integrates with AppConfig to run client-side evaluation.
See: newProjectAppConfigResource smart constructor.
Constructors
| ProjectAppConfigResource' | |
Fields
| |
Instances
newProjectAppConfigResource Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ProjectAppConfigResource |
Create a value of ProjectAppConfigResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:ProjectAppConfigResource', projectAppConfigResource_applicationId - The ID of the AppConfig application to use for client-side evaluation.
$sel:configurationProfileId:ProjectAppConfigResource', projectAppConfigResource_configurationProfileId - The ID of the AppConfig profile to use for client-side evaluation.
$sel:environmentId:ProjectAppConfigResource', projectAppConfigResource_environmentId - 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.
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
data ProjectAppConfigResourceConfig Source #
Use this parameter to configure client-side evaluation for your project. Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the EvaluateFeature operation to assign the variations. This mitigates the latency and availability risks that come with an API call.
ProjectAppConfigResource is a structure that defines the configuration
of how your application integrates with AppConfig to run client-side
evaluation.
See: newProjectAppConfigResourceConfig smart constructor.
Constructors
| ProjectAppConfigResourceConfig' | |
Fields
| |
Instances
newProjectAppConfigResourceConfig :: ProjectAppConfigResourceConfig Source #
Create a value of ProjectAppConfigResourceConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:ProjectAppConfigResourceConfig', projectAppConfigResourceConfig_applicationId - The ID of the AppConfig application to use for client-side evaluation.
$sel:environmentId:ProjectAppConfigResourceConfig', projectAppConfigResourceConfig_environmentId - 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_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
data ProjectDataDelivery Source #
A structure that contains information about where Evidently is to store evaluation events for longer term storage.
See: newProjectDataDelivery smart constructor.
Constructors
| ProjectDataDelivery' | |
Fields
| |
Instances
newProjectDataDelivery :: ProjectDataDelivery Source #
Create a value of ProjectDataDelivery with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cloudWatchLogs:ProjectDataDelivery', projectDataDelivery_cloudWatchLogs - If the project stores evaluation events in CloudWatch Logs, this
structure stores the log group name.
$sel:s3Destination:ProjectDataDelivery', projectDataDelivery_s3Destination - If the project stores evaluation events in an Amazon S3 bucket, this
structure stores the bucket name and bucket prefix.
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
data ProjectDataDeliveryConfig Source #
A structure that contains information about where Evidently is to store evaluation events for longer term storage.
See: newProjectDataDeliveryConfig smart constructor.
Constructors
| ProjectDataDeliveryConfig' | |
Fields
| |
Instances
newProjectDataDeliveryConfig :: ProjectDataDeliveryConfig Source #
Create a value of ProjectDataDeliveryConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cloudWatchLogs:ProjectDataDeliveryConfig', projectDataDeliveryConfig_cloudWatchLogs - If the project stores evaluation events in CloudWatch Logs, this
structure stores the log group name.
$sel:s3Destination:ProjectDataDeliveryConfig', projectDataDeliveryConfig_s3Destination - If the project stores evaluation events in an Amazon S3 bucket, this
structure stores the bucket name and bucket prefix.
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
data ProjectSummary Source #
A structure that contains configuration information about an Evidently project.
See: newProjectSummary smart constructor.
Constructors
| ProjectSummary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> Text | |
| -> ProjectStatus | |
| -> ProjectSummary |
Create a value of ProjectSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:activeExperimentCount:ProjectSummary', projectSummary_activeExperimentCount - The number of experiments currently in the project.
$sel:activeLaunchCount:ProjectSummary', projectSummary_activeLaunchCount - The number of ongoing launches currently in the project.
$sel:description:ProjectSummary', projectSummary_description - The description of the project.
$sel:experimentCount:ProjectSummary', projectSummary_experimentCount - The number of experiments currently in the project.
$sel:featureCount:ProjectSummary', projectSummary_featureCount - The number of features currently in the project.
$sel:launchCount:ProjectSummary', projectSummary_launchCount - The number of launches currently in the project, including launches that
are ongoing, completed, and not started yet.
$sel:tags:ProjectSummary', projectSummary_tags - The list of tag keys and values associated with this project.
$sel:arn:ProjectSummary', projectSummary_arn - The name or ARN of the project.
$sel:createdTime:ProjectSummary', projectSummary_createdTime - The date and time that the project is created.
$sel:lastUpdatedTime:ProjectSummary', projectSummary_lastUpdatedTime - The date and time that the project was most recently updated.
$sel:name:ProjectSummary', projectSummary_name - The name of the project.
$sel:status:ProjectSummary', projectSummary_status - The current state of the project.
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
data PutProjectEventsResultEntry Source #
A structure that contains Evidently's response to the sent events, including an event ID and error codes, if any.
See: newPutProjectEventsResultEntry smart constructor.
Constructors
| PutProjectEventsResultEntry' | |
Instances
newPutProjectEventsResultEntry :: PutProjectEventsResultEntry Source #
Create a value of PutProjectEventsResultEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:PutProjectEventsResultEntry', putProjectEventsResultEntry_errorCode - If the PutProjectEvents operation has an error, the error code is
returned here.
$sel:errorMessage:PutProjectEventsResultEntry', putProjectEventsResultEntry_errorMessage - If the PutProjectEvents operation has an error, the error message is
returned here.
$sel:eventId:PutProjectEventsResultEntry', putProjectEventsResultEntry_eventId - A unique ID assigned to this PutProjectEvents operation.
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
data RefResource Source #
A structure that contains information about one experiment or launch that uses the specified segment.
See: newRefResource smart constructor.
Constructors
| RefResource' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> RefResource |
Create a value of RefResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:RefResource', refResource_arn - The ARN of the experiment or launch.
$sel:endTime:RefResource', refResource_endTime - The day and time that this experiment or launch ended.
$sel:lastUpdatedOn:RefResource', refResource_lastUpdatedOn - The day and time that this experiment or launch was most recently
updated.
$sel:startTime:RefResource', refResource_startTime - The day and time that this experiment or launch started.
$sel:status:RefResource', refResource_status - The status of the experiment or launch.
$sel:name:RefResource', refResource_name - The name of the experiment or launch.
$sel:type':RefResource', refResource_type - Specifies whether the resource that this structure contains information
about is an experiment or a launch.
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
data S3Destination Source #
If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
See: newS3Destination smart constructor.
Constructors
| S3Destination' | |
Instances
newS3Destination :: S3Destination Source #
Create a value of S3Destination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucket:S3Destination', s3Destination_bucket - The name of the bucket in which Evidently stores evaluation events.
$sel:prefix:S3Destination', s3Destination_prefix - The bucket prefix in which Evidently stores evaluation events.
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
data S3DestinationConfig Source #
If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
See: newS3DestinationConfig smart constructor.
Constructors
| S3DestinationConfig' | |
Instances
newS3DestinationConfig :: S3DestinationConfig Source #
Create a value of S3DestinationConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucket:S3DestinationConfig', s3DestinationConfig_bucket - The name of the bucket in which Evidently stores evaluation events.
$sel:prefix:S3DestinationConfig', s3DestinationConfig_prefix - The bucket prefix in which Evidently stores evaluation events.
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
data ScheduledSplit Source #
This structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.
See: newScheduledSplit smart constructor.
Constructors
| ScheduledSplit' | |
Fields
| |
Instances
Arguments
| :: UTCTime | |
| -> ScheduledSplit |
Create a value of ScheduledSplit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupWeights:ScheduledSplit', scheduledSplit_groupWeights - 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.
$sel:segmentOverrides:ScheduledSplit', scheduledSplit_segmentOverrides - 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.
$sel:startTime:ScheduledSplit', scheduledSplit_startTime - The date and time that this step of the launch starts.
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
data ScheduledSplitConfig Source #
This structure defines the traffic allocation percentages among the feature variations during one step of a launch, and the start time of that step.
See: newScheduledSplitConfig smart constructor.
Constructors
| ScheduledSplitConfig' | |
Fields
| |
Instances
newScheduledSplitConfig Source #
Create a value of ScheduledSplitConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:segmentOverrides:ScheduledSplitConfig', scheduledSplitConfig_segmentOverrides - 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.
$sel:groupWeights:ScheduledSplitConfig', scheduledSplitConfig_groupWeights - 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>
$sel:startTime:ScheduledSplitConfig', scheduledSplitConfig_startTime - The date and time that this step of the launch starts.
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
data ScheduledSplitsLaunchConfig Source #
An array of structures that define the traffic allocation percentages among the feature variations during each step of a launch. This also defines the start time of each step.
See: newScheduledSplitsLaunchConfig smart constructor.
Constructors
| ScheduledSplitsLaunchConfig' | |
Fields
| |
Instances
newScheduledSplitsLaunchConfig Source #
Arguments
| :: NonEmpty ScheduledSplitConfig | |
| -> ScheduledSplitsLaunchConfig |
Create a value of ScheduledSplitsLaunchConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:steps:ScheduledSplitsLaunchConfig', scheduledSplitsLaunchConfig_steps - 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.
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
data ScheduledSplitsLaunchDefinition Source #
An array of structures that define the traffic allocation percentages among the feature variations during each step of a launch. This also defines the start time of each step.
See: newScheduledSplitsLaunchDefinition smart constructor.
Constructors
| ScheduledSplitsLaunchDefinition' | |
Fields
| |
Instances
newScheduledSplitsLaunchDefinition :: ScheduledSplitsLaunchDefinition Source #
Create a value of ScheduledSplitsLaunchDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:steps:ScheduledSplitsLaunchDefinition', scheduledSplitsLaunchDefinition_steps - 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_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
This structure contains information about one audience segment. You can use segments in your experiments and launches to narrow the user sessions used for experiment or launch to only the user sessions that match one or more criteria.
See: newSegment smart constructor.
Constructors
| Segment' | |
Fields
| |
Instances
Create a value of Segment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:Segment', segment_description - The customer-created description for this segment.
$sel:experimentCount:Segment', segment_experimentCount - The number of experiments that this segment is used in. This count
includes all current experiments, not just those that are currently
running.
$sel:launchCount:Segment', segment_launchCount - The number of launches that this segment is used in. This count includes
all current launches, not just those that are currently running.
$sel:tags:Segment', segment_tags - The list of tag keys and values associated with this launch.
$sel:arn:Segment', segment_arn - The ARN of the segment.
$sel:createdTime:Segment', segment_createdTime - The date and time that this segment was created.
$sel:lastUpdatedTime:Segment', segment_lastUpdatedTime - The date and time that this segment was most recently updated.
$sel:name:Segment', segment_name - The name of the segment.
$sel:pattern':Segment', segment_pattern - 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.
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
data SegmentOverride Source #
This structure specifies a segment that you have already created, and defines the traffic split for that segment to be used in a launch.
See: newSegmentOverride smart constructor.
Constructors
| SegmentOverride' | |
Fields
| |
Instances
Arguments
| :: Integer | |
| -> Text | |
| -> SegmentOverride |
Create a value of SegmentOverride with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:evaluationOrder:SegmentOverride', segmentOverride_evaluationOrder - 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.
$sel:segment:SegmentOverride', segmentOverride_segment - The ARN of the segment to use.
$sel:weights:SegmentOverride', segmentOverride_weights - 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.
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
A structure that defines one treatment in an experiment. A treatment is a variation of the feature that you are including in the experiment.
See: newTreatment smart constructor.
Constructors
| Treatment' | |
Fields
| |
Instances
| FromJSON Treatment Source # | |
| Generic Treatment Source # | |
| Read Treatment Source # | |
| Show Treatment Source # | |
| NFData Treatment Source # | |
Defined in Amazonka.Evidently.Types.Treatment | |
| Eq Treatment Source # | |
| Hashable Treatment Source # | |
Defined in Amazonka.Evidently.Types.Treatment | |
| type Rep Treatment Source # | |
Defined in Amazonka.Evidently.Types.Treatment type Rep Treatment = D1 ('MetaData "Treatment" "Amazonka.Evidently.Types.Treatment" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "Treatment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "featureVariations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of Treatment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:Treatment', treatment_description - The description of the treatment.
$sel:featureVariations:Treatment', treatment_featureVariations - 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.
$sel:name:Treatment', treatment_name - The name of this 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
data TreatmentConfig Source #
A structure that defines one treatment in an experiment. A treatment is a variation of the feature that you are including in the experiment.
See: newTreatmentConfig smart constructor.
Constructors
| TreatmentConfig' | |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> TreatmentConfig |
Create a value of TreatmentConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:TreatmentConfig', treatmentConfig_description - A description for this treatment.
$sel:feature:TreatmentConfig', treatmentConfig_feature - The feature that this experiment is testing.
$sel:name:TreatmentConfig', treatmentConfig_name - A name for this treatment.
$sel:variation:TreatmentConfig', treatmentConfig_variation - The name of the variation to use as this treatment in the experiment.
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
data VariableValue Source #
The value assigned to a feature variation. This structure must contain
exactly one field. It can be boolValue, doubleValue, longValue, or
stringValue.
See: newVariableValue smart constructor.
Constructors
| VariableValue' | |
Fields
| |
Instances
newVariableValue :: VariableValue Source #
Create a value of VariableValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:boolValue:VariableValue', variableValue_boolValue - If this feature uses the Boolean variation type, this field contains the
Boolean value of this variation.
$sel:doubleValue:VariableValue', variableValue_doubleValue - If this feature uses the double integer variation type, this field
contains the double integer value of this variation.
$sel:longValue:VariableValue', variableValue_longValue - If this feature uses the long variation type, this field contains the
long value of this variation.
$sel:stringValue:VariableValue', variableValue_stringValue - If this feature uses the string variation type, this field contains the
string value of this variation.
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
This structure contains the name and variation value of one variation of a feature.
See: newVariation smart constructor.
Constructors
| Variation' | |
Instances
| FromJSON Variation Source # | |
| Generic Variation Source # | |
| Read Variation Source # | |
| Show Variation Source # | |
| NFData Variation Source # | |
Defined in Amazonka.Evidently.Types.Variation | |
| Eq Variation Source # | |
| Hashable Variation Source # | |
Defined in Amazonka.Evidently.Types.Variation | |
| type Rep Variation Source # | |
Defined in Amazonka.Evidently.Types.Variation type Rep Variation = D1 ('MetaData "Variation" "Amazonka.Evidently.Types.Variation" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "Variation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VariableValue)))) | |
newVariation :: Variation Source #
Create a value of Variation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Variation', variation_name - The name of the variation.
$sel:value:Variation', variation_value - The value assigned to this variation.
variation_value :: Lens' Variation (Maybe VariableValue) Source #
The value assigned to this variation.
VariationConfig
data VariationConfig Source #
This structure contains the name and variation value of one variation of a feature.
See: newVariationConfig smart constructor.
Constructors
| VariationConfig' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> VariableValue | |
| -> VariationConfig |
Create a value of VariationConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:VariationConfig', variationConfig_name - The name of the variation.
$sel:value:VariationConfig', variationConfig_value - The value assigned to this variation.
variationConfig_name :: Lens' VariationConfig Text Source #
The name of the variation.
variationConfig_value :: Lens' VariationConfig VariableValue Source #
The value assigned to this variation.