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 |
- Service Configuration
- Errors
- Waiters
- Operations
- BatchEvaluateFeature
- CreateExperiment
- CreateFeature
- CreateLaunch
- CreateProject
- CreateSegment
- DeleteExperiment
- DeleteFeature
- DeleteLaunch
- DeleteProject
- DeleteSegment
- EvaluateFeature
- GetExperiment
- GetExperimentResults
- GetFeature
- GetLaunch
- GetProject
- GetSegment
- ListExperiments (Paginated)
- ListFeatures (Paginated)
- ListLaunches (Paginated)
- ListProjects (Paginated)
- ListSegmentReferences (Paginated)
- ListSegments (Paginated)
- ListTagsForResource
- PutProjectEvents
- StartExperiment
- StartLaunch
- StopExperiment
- StopLaunch
- TagResource
- TestSegmentPattern
- UntagResource
- UpdateExperiment
- UpdateFeature
- UpdateLaunch
- UpdateProject
- UpdateProjectDataDelivery
- Types
- 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
Derived from API version 2021-02-01
of the AWS service descriptions, licensed under Apache 2.0.
You can use Amazon CloudWatch Evidently to safely validate new features by serving them to a specified percentage of your users while you roll out the feature. You can monitor the performance of the new feature to help you decide when to ramp up traffic to your users. This helps you reduce risk and identify unintended consequences before you fully launch the feature.
You can also conduct A/B experiments to make feature design decisions based on evidence and data. An experiment can test as many as five variations at once. Evidently collects experiment data and analyzes it using statistical methods. It also provides clear recommendations about which variations perform better. You can test both user-facing features and backend features.
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
- data BatchEvaluateFeature = BatchEvaluateFeature' Text (NonEmpty EvaluationRequest)
- newBatchEvaluateFeature :: Text -> NonEmpty EvaluationRequest -> BatchEvaluateFeature
- data BatchEvaluateFeatureResponse = BatchEvaluateFeatureResponse' (Maybe [EvaluationResult]) Int
- newBatchEvaluateFeatureResponse :: Int -> BatchEvaluateFeatureResponse
- data CreateExperiment = CreateExperiment' (Maybe Text) (Maybe OnlineAbConfig) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe (HashMap Text Text)) (NonEmpty MetricGoalConfig) Text Text [TreatmentConfig]
- newCreateExperiment :: NonEmpty MetricGoalConfig -> Text -> Text -> CreateExperiment
- data CreateExperimentResponse = CreateExperimentResponse' Int Experiment
- newCreateExperimentResponse :: Int -> Experiment -> CreateExperimentResponse
- data CreateFeature = CreateFeature' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe FeatureEvaluationStrategy) (Maybe (HashMap Text Text)) Text Text (NonEmpty VariationConfig)
- newCreateFeature :: Text -> Text -> NonEmpty VariationConfig -> CreateFeature
- data CreateFeatureResponse = CreateFeatureResponse' (Maybe Feature) Int
- newCreateFeatureResponse :: Int -> CreateFeatureResponse
- data CreateLaunch = CreateLaunch' (Maybe Text) (Maybe [MetricMonitorConfig]) (Maybe Text) (Maybe ScheduledSplitsLaunchConfig) (Maybe (HashMap Text Text)) (NonEmpty LaunchGroupConfig) Text Text
- newCreateLaunch :: NonEmpty LaunchGroupConfig -> Text -> Text -> CreateLaunch
- data CreateLaunchResponse = CreateLaunchResponse' Int Launch
- newCreateLaunchResponse :: Int -> Launch -> CreateLaunchResponse
- data CreateProject = CreateProject' (Maybe ProjectAppConfigResourceConfig) (Maybe ProjectDataDeliveryConfig) (Maybe Text) (Maybe (HashMap Text Text)) Text
- newCreateProject :: Text -> CreateProject
- data CreateProjectResponse = CreateProjectResponse' Int Project
- newCreateProjectResponse :: Int -> Project -> CreateProjectResponse
- data CreateSegment = CreateSegment' (Maybe Text) (Maybe (HashMap Text Text)) Text Text
- newCreateSegment :: Text -> Text -> CreateSegment
- data CreateSegmentResponse = CreateSegmentResponse' Int Segment
- newCreateSegmentResponse :: Int -> Segment -> CreateSegmentResponse
- data DeleteExperiment = DeleteExperiment' Text Text
- newDeleteExperiment :: Text -> Text -> DeleteExperiment
- data DeleteExperimentResponse = DeleteExperimentResponse' Int
- newDeleteExperimentResponse :: Int -> DeleteExperimentResponse
- data DeleteFeature = DeleteFeature' Text Text
- newDeleteFeature :: Text -> Text -> DeleteFeature
- data DeleteFeatureResponse = DeleteFeatureResponse' Int
- newDeleteFeatureResponse :: Int -> DeleteFeatureResponse
- data DeleteLaunch = DeleteLaunch' Text Text
- newDeleteLaunch :: Text -> Text -> DeleteLaunch
- data DeleteLaunchResponse = DeleteLaunchResponse' Int
- newDeleteLaunchResponse :: Int -> DeleteLaunchResponse
- data DeleteProject = DeleteProject' Text
- newDeleteProject :: Text -> DeleteProject
- data DeleteProjectResponse = DeleteProjectResponse' Int
- newDeleteProjectResponse :: Int -> DeleteProjectResponse
- data DeleteSegment = DeleteSegment' Text
- newDeleteSegment :: Text -> DeleteSegment
- data DeleteSegmentResponse = DeleteSegmentResponse' Int
- newDeleteSegmentResponse :: Int -> DeleteSegmentResponse
- data EvaluateFeature = EvaluateFeature' (Maybe Text) Text Text Text
- newEvaluateFeature :: Text -> Text -> Text -> EvaluateFeature
- data EvaluateFeatureResponse = EvaluateFeatureResponse' (Maybe Text) (Maybe Text) (Maybe VariableValue) (Maybe Text) Int
- newEvaluateFeatureResponse :: Int -> EvaluateFeatureResponse
- data GetExperiment = GetExperiment' Text Text
- newGetExperiment :: Text -> Text -> GetExperiment
- data GetExperimentResponse = GetExperimentResponse' (Maybe Experiment) Int
- newGetExperimentResponse :: Int -> GetExperimentResponse
- data GetExperimentResults = GetExperimentResults' (Maybe ExperimentBaseStat) (Maybe POSIX) (Maybe Natural) (Maybe [ExperimentReportName]) (Maybe [ExperimentResultRequestType]) (Maybe POSIX) Text (NonEmpty Text) Text (NonEmpty Text)
- newGetExperimentResults :: Text -> NonEmpty Text -> Text -> NonEmpty Text -> GetExperimentResults
- data GetExperimentResultsResponse = GetExperimentResultsResponse' (Maybe Text) (Maybe [ExperimentReport]) (Maybe [ExperimentResultsData]) (Maybe [POSIX]) Int
- newGetExperimentResultsResponse :: Int -> GetExperimentResultsResponse
- data GetFeature = GetFeature' Text Text
- newGetFeature :: Text -> Text -> GetFeature
- data GetFeatureResponse = GetFeatureResponse' Int Feature
- newGetFeatureResponse :: Int -> Feature -> GetFeatureResponse
- data GetLaunch = GetLaunch' Text Text
- newGetLaunch :: Text -> Text -> GetLaunch
- data GetLaunchResponse = GetLaunchResponse' (Maybe Launch) Int
- newGetLaunchResponse :: Int -> GetLaunchResponse
- data GetProject = GetProject' Text
- newGetProject :: Text -> GetProject
- data GetProjectResponse = GetProjectResponse' Int Project
- newGetProjectResponse :: Int -> Project -> GetProjectResponse
- data GetSegment = GetSegment' Text
- newGetSegment :: Text -> GetSegment
- data GetSegmentResponse = GetSegmentResponse' Int Segment
- newGetSegmentResponse :: Int -> Segment -> GetSegmentResponse
- data ListExperiments = ListExperiments' (Maybe Natural) (Maybe Text) (Maybe ExperimentStatus) Text
- newListExperiments :: Text -> ListExperiments
- data ListExperimentsResponse = ListExperimentsResponse' (Maybe [Experiment]) (Maybe Text) Int
- newListExperimentsResponse :: Int -> ListExperimentsResponse
- data ListFeatures = ListFeatures' (Maybe Natural) (Maybe Text) Text
- newListFeatures :: Text -> ListFeatures
- data ListFeaturesResponse = ListFeaturesResponse' (Maybe [FeatureSummary]) (Maybe Text) Int
- newListFeaturesResponse :: Int -> ListFeaturesResponse
- data ListLaunches = ListLaunches' (Maybe Natural) (Maybe Text) (Maybe LaunchStatus) Text
- newListLaunches :: Text -> ListLaunches
- data ListLaunchesResponse = ListLaunchesResponse' (Maybe [Launch]) (Maybe Text) Int
- newListLaunchesResponse :: Int -> ListLaunchesResponse
- data ListProjects = ListProjects' (Maybe Natural) (Maybe Text)
- newListProjects :: ListProjects
- data ListProjectsResponse = ListProjectsResponse' (Maybe Text) (Maybe [ProjectSummary]) Int
- newListProjectsResponse :: Int -> ListProjectsResponse
- data ListSegmentReferences = ListSegmentReferences' (Maybe Natural) (Maybe Text) Text SegmentReferenceResourceType
- newListSegmentReferences :: Text -> SegmentReferenceResourceType -> ListSegmentReferences
- data ListSegmentReferencesResponse = ListSegmentReferencesResponse' (Maybe Text) (Maybe [RefResource]) Int
- newListSegmentReferencesResponse :: Int -> ListSegmentReferencesResponse
- data ListSegments = ListSegments' (Maybe Natural) (Maybe Text)
- newListSegments :: ListSegments
- data ListSegmentsResponse = ListSegmentsResponse' (Maybe Text) (Maybe [Segment]) Int
- newListSegmentsResponse :: Int -> ListSegmentsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data PutProjectEvents = PutProjectEvents' [Event] Text
- newPutProjectEvents :: Text -> PutProjectEvents
- data PutProjectEventsResponse = PutProjectEventsResponse' (Maybe [PutProjectEventsResultEntry]) (Maybe Int) Int
- newPutProjectEventsResponse :: Int -> PutProjectEventsResponse
- data StartExperiment = StartExperiment' POSIX Text Text
- newStartExperiment :: UTCTime -> Text -> Text -> StartExperiment
- data StartExperimentResponse = StartExperimentResponse' (Maybe POSIX) Int
- newStartExperimentResponse :: Int -> StartExperimentResponse
- data StartLaunch = StartLaunch' Text Text
- newStartLaunch :: Text -> Text -> StartLaunch
- data StartLaunchResponse = StartLaunchResponse' Int Launch
- newStartLaunchResponse :: Int -> Launch -> StartLaunchResponse
- data StopExperiment = StopExperiment' (Maybe ExperimentStopDesiredState) (Maybe Text) Text Text
- newStopExperiment :: Text -> Text -> StopExperiment
- data StopExperimentResponse = StopExperimentResponse' (Maybe POSIX) Int
- newStopExperimentResponse :: Int -> StopExperimentResponse
- data StopLaunch = StopLaunch' (Maybe LaunchStopDesiredState) (Maybe Text) Text Text
- newStopLaunch :: Text -> Text -> StopLaunch
- data StopLaunchResponse = StopLaunchResponse' (Maybe POSIX) Int
- newStopLaunchResponse :: Int -> StopLaunchResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data TestSegmentPattern = TestSegmentPattern' Text Text
- newTestSegmentPattern :: Text -> Text -> TestSegmentPattern
- data TestSegmentPatternResponse = TestSegmentPatternResponse' Int Bool
- newTestSegmentPatternResponse :: Int -> Bool -> TestSegmentPatternResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateExperiment = UpdateExperiment' (Maybe Text) (Maybe (NonEmpty MetricGoalConfig)) (Maybe OnlineAbConfig) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe [TreatmentConfig]) Text Text
- newUpdateExperiment :: Text -> Text -> UpdateExperiment
- data UpdateExperimentResponse = UpdateExperimentResponse' Int Experiment
- newUpdateExperimentResponse :: Int -> Experiment -> UpdateExperimentResponse
- data UpdateFeature = UpdateFeature' (Maybe (NonEmpty VariationConfig)) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe FeatureEvaluationStrategy) (Maybe [Text]) Text Text
- newUpdateFeature :: Text -> Text -> UpdateFeature
- data UpdateFeatureResponse = UpdateFeatureResponse' Int Feature
- newUpdateFeatureResponse :: Int -> Feature -> UpdateFeatureResponse
- data UpdateLaunch = UpdateLaunch' (Maybe Text) (Maybe (NonEmpty LaunchGroupConfig)) (Maybe [MetricMonitorConfig]) (Maybe Text) (Maybe ScheduledSplitsLaunchConfig) Text Text
- newUpdateLaunch :: Text -> Text -> UpdateLaunch
- data UpdateLaunchResponse = UpdateLaunchResponse' Int Launch
- newUpdateLaunchResponse :: Int -> Launch -> UpdateLaunchResponse
- data UpdateProject = UpdateProject' (Maybe ProjectAppConfigResourceConfig) (Maybe Text) Text
- newUpdateProject :: Text -> UpdateProject
- data UpdateProjectResponse = UpdateProjectResponse' Int Project
- newUpdateProjectResponse :: Int -> Project -> UpdateProjectResponse
- data UpdateProjectDataDelivery = UpdateProjectDataDelivery' (Maybe CloudWatchLogsDestinationConfig) (Maybe S3DestinationConfig) Text
- newUpdateProjectDataDelivery :: Text -> UpdateProjectDataDelivery
- data UpdateProjectDataDeliveryResponse = UpdateProjectDataDeliveryResponse' Int Project
- newUpdateProjectDataDeliveryResponse :: Int -> Project -> UpdateProjectDataDeliveryResponse
- 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' (Maybe Text)
- newCloudWatchLogsDestination :: CloudWatchLogsDestination
- data CloudWatchLogsDestinationConfig = CloudWatchLogsDestinationConfig' (Maybe Text)
- newCloudWatchLogsDestinationConfig :: CloudWatchLogsDestinationConfig
- data EvaluationRequest = EvaluationRequest' (Maybe Text) Text Text
- newEvaluationRequest :: Text -> Text -> EvaluationRequest
- data EvaluationResult = EvaluationResult' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe VariableValue) (Maybe Text) Text Text
- newEvaluationResult :: Text -> Text -> EvaluationResult
- data EvaluationRule = EvaluationRule' (Maybe Text) Text
- newEvaluationRule :: Text -> EvaluationRule
- data Event = Event' Text POSIX EventType
- newEvent :: Text -> UTCTime -> EventType -> Event
- data Experiment = Experiment' (Maybe Text) (Maybe ExperimentExecution) (Maybe (NonEmpty MetricGoal)) (Maybe OnlineAbDefinition) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe ExperimentSchedule) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (NonEmpty Treatment)) Text POSIX POSIX Text ExperimentStatus ExperimentType
- newExperiment :: Text -> UTCTime -> UTCTime -> Text -> ExperimentStatus -> ExperimentType -> Experiment
- data ExperimentExecution = ExperimentExecution' (Maybe POSIX) (Maybe POSIX)
- newExperimentExecution :: ExperimentExecution
- data ExperimentReport = ExperimentReport' (Maybe Text) (Maybe Text) (Maybe ExperimentReportName) (Maybe Text)
- newExperimentReport :: ExperimentReport
- data ExperimentResultsData = ExperimentResultsData' (Maybe Text) (Maybe ExperimentResultResponseType) (Maybe Text) (Maybe [Double])
- newExperimentResultsData :: ExperimentResultsData
- data ExperimentSchedule = ExperimentSchedule' (Maybe POSIX)
- newExperimentSchedule :: ExperimentSchedule
- data Feature = Feature' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [EvaluationRule]) (Maybe Text) (Maybe (HashMap Text Text)) Text POSIX FeatureEvaluationStrategy POSIX Text FeatureStatus VariationValueType [Variation]
- newFeature :: Text -> UTCTime -> FeatureEvaluationStrategy -> UTCTime -> Text -> FeatureStatus -> VariationValueType -> Feature
- data FeatureSummary = FeatureSummary' (Maybe Text) (Maybe [EvaluationRule]) (Maybe Text) (Maybe (HashMap Text Text)) Text POSIX FeatureEvaluationStrategy POSIX Text FeatureStatus
- newFeatureSummary :: Text -> UTCTime -> FeatureEvaluationStrategy -> UTCTime -> Text -> FeatureStatus -> FeatureSummary
- data Launch = Launch' (Maybe Text) (Maybe LaunchExecution) (Maybe [LaunchGroup]) (Maybe [MetricMonitor]) (Maybe Text) (Maybe Text) (Maybe ScheduledSplitsLaunchDefinition) (Maybe Text) (Maybe (HashMap Text Text)) Text POSIX POSIX Text LaunchStatus LaunchType
- newLaunch :: Text -> UTCTime -> UTCTime -> Text -> LaunchStatus -> LaunchType -> Launch
- data LaunchExecution = LaunchExecution' (Maybe POSIX) (Maybe POSIX)
- newLaunchExecution :: LaunchExecution
- data LaunchGroup = LaunchGroup' (Maybe Text) (HashMap Text Text) Text
- newLaunchGroup :: Text -> LaunchGroup
- data LaunchGroupConfig = LaunchGroupConfig' (Maybe Text) Text Text Text
- newLaunchGroupConfig :: Text -> Text -> Text -> LaunchGroupConfig
- data MetricDefinition = MetricDefinition' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newMetricDefinition :: MetricDefinition
- data MetricDefinitionConfig = MetricDefinitionConfig' (Maybe Text) (Maybe Text) Text Text Text
- newMetricDefinitionConfig :: Text -> Text -> Text -> MetricDefinitionConfig
- data MetricGoal = MetricGoal' (Maybe ChangeDirectionEnum) MetricDefinition
- newMetricGoal :: MetricDefinition -> MetricGoal
- data MetricGoalConfig = MetricGoalConfig' (Maybe ChangeDirectionEnum) MetricDefinitionConfig
- newMetricGoalConfig :: MetricDefinitionConfig -> MetricGoalConfig
- data MetricMonitor = MetricMonitor' MetricDefinition
- newMetricMonitor :: MetricDefinition -> MetricMonitor
- data MetricMonitorConfig = MetricMonitorConfig' MetricDefinitionConfig
- newMetricMonitorConfig :: MetricDefinitionConfig -> MetricMonitorConfig
- data OnlineAbConfig = OnlineAbConfig' (Maybe Text) (Maybe (HashMap Text Natural))
- newOnlineAbConfig :: OnlineAbConfig
- data OnlineAbDefinition = OnlineAbDefinition' (Maybe Text) (Maybe (HashMap Text Natural))
- newOnlineAbDefinition :: OnlineAbDefinition
- data Project = Project' (Maybe Integer) (Maybe Integer) (Maybe ProjectAppConfigResource) (Maybe ProjectDataDelivery) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe (HashMap Text Text)) Text POSIX POSIX Text ProjectStatus
- newProject :: Text -> UTCTime -> UTCTime -> Text -> ProjectStatus -> Project
- data ProjectAppConfigResource = ProjectAppConfigResource' Text Text Text
- newProjectAppConfigResource :: Text -> Text -> Text -> ProjectAppConfigResource
- data ProjectAppConfigResourceConfig = ProjectAppConfigResourceConfig' (Maybe Text) (Maybe Text)
- newProjectAppConfigResourceConfig :: ProjectAppConfigResourceConfig
- data ProjectDataDelivery = ProjectDataDelivery' (Maybe CloudWatchLogsDestination) (Maybe S3Destination)
- newProjectDataDelivery :: ProjectDataDelivery
- data ProjectDataDeliveryConfig = ProjectDataDeliveryConfig' (Maybe CloudWatchLogsDestinationConfig) (Maybe S3DestinationConfig)
- newProjectDataDeliveryConfig :: ProjectDataDeliveryConfig
- data ProjectSummary = ProjectSummary' (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe (HashMap Text Text)) Text POSIX POSIX Text ProjectStatus
- newProjectSummary :: Text -> UTCTime -> UTCTime -> Text -> ProjectStatus -> ProjectSummary
- data PutProjectEventsResultEntry = PutProjectEventsResultEntry' (Maybe Text) (Maybe Text) (Maybe Text)
- newPutProjectEventsResultEntry :: PutProjectEventsResultEntry
- data RefResource = RefResource' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text
- newRefResource :: Text -> Text -> RefResource
- data S3Destination = S3Destination' (Maybe Text) (Maybe Text)
- newS3Destination :: S3Destination
- data S3DestinationConfig = S3DestinationConfig' (Maybe Text) (Maybe Text)
- newS3DestinationConfig :: S3DestinationConfig
- data ScheduledSplit = ScheduledSplit' (Maybe (HashMap Text Natural)) (Maybe [SegmentOverride]) POSIX
- newScheduledSplit :: UTCTime -> ScheduledSplit
- data ScheduledSplitConfig = ScheduledSplitConfig' (Maybe [SegmentOverride]) (HashMap Text Natural) POSIX
- newScheduledSplitConfig :: UTCTime -> ScheduledSplitConfig
- data ScheduledSplitsLaunchConfig = ScheduledSplitsLaunchConfig' (NonEmpty ScheduledSplitConfig)
- newScheduledSplitsLaunchConfig :: NonEmpty ScheduledSplitConfig -> ScheduledSplitsLaunchConfig
- data ScheduledSplitsLaunchDefinition = ScheduledSplitsLaunchDefinition' (Maybe (NonEmpty ScheduledSplit))
- newScheduledSplitsLaunchDefinition :: ScheduledSplitsLaunchDefinition
- data Segment = Segment' (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe (HashMap Text Text)) Text POSIX POSIX Text Text
- newSegment :: Text -> UTCTime -> UTCTime -> Text -> Text -> Segment
- data SegmentOverride = SegmentOverride' Integer Text (HashMap Text Natural)
- newSegmentOverride :: Integer -> Text -> SegmentOverride
- data Treatment = Treatment' (Maybe Text) (Maybe (HashMap Text Text)) Text
- newTreatment :: Text -> Treatment
- data TreatmentConfig = TreatmentConfig' (Maybe Text) Text Text Text
- newTreatmentConfig :: Text -> Text -> Text -> TreatmentConfig
- data VariableValue = VariableValue' (Maybe Bool) (Maybe Double) (Maybe Integer) (Maybe Text)
- newVariableValue :: VariableValue
- data Variation = Variation' (Maybe Text) (Maybe VariableValue)
- newVariation :: Variation
- data VariationConfig = VariationConfig' Text VariableValue
- newVariationConfig :: Text -> VariableValue -> VariationConfig
Service Configuration
defaultService :: Service Source #
API version 2021-02-01
of the Amazon CloudWatch Evidently SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Evidently
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient permissions to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
A resource was in an inconsistent state during an update or a deletion.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
Unexpected error while processing the request. Retry the request.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The request references a resource that does not exist.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request would cause a service quota to be exceeded.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The service was unavailable. Retry the request.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied because of request throttling. Retry the request.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The value of a parameter in the request caused an error.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchEvaluateFeature
data BatchEvaluateFeature Source #
See: newBatchEvaluateFeature
smart constructor.
Instances
newBatchEvaluateFeature Source #
Create a value of BatchEvaluateFeature
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:
BatchEvaluateFeature
, batchEvaluateFeature_project
- The name or ARN of the project that contains the feature being
evaluated.
$sel:requests:BatchEvaluateFeature'
, batchEvaluateFeature_requests
- An array of structures, where each structure assigns a feature variation
to one user session.
data BatchEvaluateFeatureResponse Source #
See: newBatchEvaluateFeatureResponse
smart constructor.
Instances
newBatchEvaluateFeatureResponse Source #
Create a value of BatchEvaluateFeatureResponse
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:results:BatchEvaluateFeatureResponse'
, batchEvaluateFeatureResponse_results
- An array of structures, where each structure displays the results of one
feature evaluation assignment to one user session.
$sel:httpStatus:BatchEvaluateFeatureResponse'
, batchEvaluateFeatureResponse_httpStatus
- The response's http status code.
CreateExperiment
data CreateExperiment Source #
See: newCreateExperiment
smart constructor.
CreateExperiment' (Maybe Text) (Maybe OnlineAbConfig) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe (HashMap Text Text)) (NonEmpty MetricGoalConfig) Text Text [TreatmentConfig] |
Instances
:: NonEmpty MetricGoalConfig | |
-> Text | |
-> Text | |
-> CreateExperiment |
Create a value of CreateExperiment
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:
CreateExperiment
, createExperiment_description
- An optional description of the experiment.
$sel:onlineAbConfig:CreateExperiment'
, createExperiment_onlineAbConfig
- A structure that contains the configuration of which variation to use as
the "control" version. tThe "control" version is used for comparison
with other variations. This structure also specifies how much experiment
traffic is allocated to each variation.
CreateExperiment
, createExperiment_randomizationSalt
- When Evidently assigns a particular user session to an experiment, it
must use a randomization ID to determine which variation the user
session is served. This randomization ID is a combination of the entity
ID and randomizationSalt
. If you omit randomizationSalt
, Evidently
uses the experiment name as the randomizationSalt
.
CreateExperiment
, createExperiment_samplingRate
- The portion of the available audience that you want to allocate to this
experiment, in thousandths of a percent. The available audience is the
total audience minus the audience that you have allocated to overrides
or current launches of this feature.
This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.
CreateExperiment
, createExperiment_segment
- Specifies an audience segment to use in the experiment. When a segment
is used in an experiment, only user sessions that match the segment
pattern are used in the experiment.
CreateExperiment
, createExperiment_tags
- Assigns one or more tags (key-value pairs) to the experiment.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
<p>You can associate as many as 50 tags with an experiment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
CreateExperiment
, createExperiment_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.
CreateExperiment
, createExperiment_name
- A name for the new experiment.
CreateExperiment
, createExperiment_project
- The name or ARN of the project that you want to create the new
experiment in.
CreateExperiment
, createExperiment_treatments
- An array of structures that describe the configuration of each feature
variation used in the experiment.
data CreateExperimentResponse Source #
See: newCreateExperimentResponse
smart constructor.
Instances
newCreateExperimentResponse Source #
Create a value of CreateExperimentResponse
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:httpStatus:CreateExperimentResponse'
, createExperimentResponse_httpStatus
- The response's http status code.
$sel:experiment:CreateExperimentResponse'
, createExperimentResponse_experiment
- A structure containing the configuration details of the experiment that
you created.
CreateFeature
data CreateFeature Source #
See: newCreateFeature
smart constructor.
CreateFeature' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe FeatureEvaluationStrategy) (Maybe (HashMap Text Text)) Text Text (NonEmpty VariationConfig) |
Instances
Create a value of CreateFeature
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:
CreateFeature
, createFeature_defaultVariation
- The name of the variation to use as the default variation. The default
variation is served to users who are not allocated to any ongoing
launches or experiments of this feature.
This variation must also be listed in the variations
structure.
If you omit defaultVariation
, the first variation listed in the
variations
structure is used as the default variation.
CreateFeature
, createFeature_description
- An optional description of the feature.
CreateFeature
, createFeature_entityOverrides
- Specify users that should always be served a specific variation of a
feature. Each user is specified by a key-value pair . For each key,
specify a user by entering their user ID, account ID, or some other
identifier. For the value, specify the name of the variation that they
are to be served.
CreateFeature
, createFeature_evaluationStrategy
- Specify ALL_RULES
to activate the traffic allocation specified by any
ongoing launches or experiments. Specify DEFAULT_VARIATION
to serve
the default variation to all users instead.
CreateFeature
, createFeature_tags
- Assigns one or more tags (key-value pairs) to the feature.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
<p>You can associate as many as 50 tags with a feature.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
CreateFeature
, createFeature_name
- The name for the new feature.
CreateFeature
, createFeature_project
- The name or ARN of the project that is to contain the new feature.
CreateFeature
, createFeature_variations
- An array of structures that contain the configuration of the feature's
different variations.
data CreateFeatureResponse Source #
See: newCreateFeatureResponse
smart constructor.
Instances
newCreateFeatureResponse Source #
Create a value of CreateFeatureResponse
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:
CreateFeatureResponse
, createFeatureResponse_feature
- A structure that contains information about the new feature.
$sel:httpStatus:CreateFeatureResponse'
, createFeatureResponse_httpStatus
- The response's http status code.
CreateLaunch
data CreateLaunch Source #
See: newCreateLaunch
smart constructor.
CreateLaunch' (Maybe Text) (Maybe [MetricMonitorConfig]) (Maybe Text) (Maybe ScheduledSplitsLaunchConfig) (Maybe (HashMap Text Text)) (NonEmpty LaunchGroupConfig) Text Text |
Instances
Create a value of CreateLaunch
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:
CreateLaunch
, createLaunch_description
- An optional description for the launch.
CreateLaunch
, createLaunch_metricMonitors
- An array of structures that define the metrics that will be used to
monitor the launch performance.
CreateLaunch
, createLaunch_randomizationSalt
- When Evidently assigns a particular user session to a launch, it must
use a randomization ID to determine which variation the user session is
served. This randomization ID is a combination of the entity ID and
randomizationSalt
. If you omit randomizationSalt
, Evidently uses the
launch name as the randomizationSalt
.
$sel:scheduledSplitsConfig:CreateLaunch'
, createLaunch_scheduledSplitsConfig
- An array of structures that define the traffic allocation percentages
among the feature variations during each step of the launch.
CreateLaunch
, createLaunch_tags
- Assigns one or more tags (key-value pairs) to the launch.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
<p>You can associate as many as 50 tags with a launch.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
CreateLaunch
, createLaunch_groups
- An array of structures that contains the feature and variations that are
to be used for the launch.
CreateLaunch
, createLaunch_name
- The name for the new launch.
CreateLaunch
, createLaunch_project
- The name or ARN of the project that you want to create the launch in.
data CreateLaunchResponse Source #
See: newCreateLaunchResponse
smart constructor.
Instances
newCreateLaunchResponse Source #
:: Int | |
-> Launch | |
-> CreateLaunchResponse |
Create a value of CreateLaunchResponse
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:httpStatus:CreateLaunchResponse'
, createLaunchResponse_httpStatus
- The response's http status code.
$sel:launch:CreateLaunchResponse'
, createLaunchResponse_launch
- A structure that contains the configuration of the launch that was
created.
CreateProject
data CreateProject Source #
See: newCreateProject
smart constructor.
CreateProject' (Maybe ProjectAppConfigResourceConfig) (Maybe ProjectDataDeliveryConfig) (Maybe Text) (Maybe (HashMap Text Text)) Text |
Instances
Create a value of CreateProject
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:
CreateProject
, createProject_appConfigResource
- Use this parameter if the project will use /client-side evaluation
powered by AppConfig/. Client-side evaluation allows your application to
assign variations to user sessions locally instead of by calling the
EvaluateFeature
operation. This mitigates the latency and availability risks that come
with an API call. For more information, see
Client-side evaluation - powered by AppConfig.
This parameter is a structure that contains information about the AppConfig application and environment that will be used as for client-side evaluation.
To create a project that uses client-side evaluation, you must have the
evidently:ExportProjectAsConfiguration
permission.
CreateProject
, createProject_dataDelivery
- A structure that contains information about where Evidently is to store
evaluation events for longer term storage, if you choose to do so. If
you choose not to store these events, Evidently deletes them after using
them to produce metrics and other experiment results that you can view.
CreateProject
, createProject_description
- An optional description of the project.
CreateProject
, createProject_tags
- Assigns one or more tags (key-value pairs) to the project.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
<p>You can associate as many as 50 tags with a project.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
CreateProject
, createProject_name
- The name for the project.
data CreateProjectResponse Source #
See: newCreateProjectResponse
smart constructor.
Instances
newCreateProjectResponse Source #
Create a value of CreateProjectResponse
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:httpStatus:CreateProjectResponse'
, createProjectResponse_httpStatus
- The response's http status code.
CreateProjectResponse
, createProjectResponse_project
- A structure that contains information about the created project.
CreateSegment
data CreateSegment Source #
See: newCreateSegment
smart constructor.
Instances
Create a value of CreateSegment
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:
CreateSegment
, createSegment_description
- An optional description for this segment.
CreateSegment
, createSegment_tags
- Assigns one or more tags (key-value pairs) to the segment.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
<p>You can associate as many as 50 tags with a segment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
CreateSegment
, createSegment_name
- A name for the segment.
CreateSegment
, createSegment_pattern
- The pattern to use for the segment. For more information about pattern
syntax, see
Segment rule pattern syntax.
data CreateSegmentResponse Source #
See: newCreateSegmentResponse
smart constructor.
Instances
newCreateSegmentResponse Source #
Create a value of CreateSegmentResponse
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:httpStatus:CreateSegmentResponse'
, createSegmentResponse_httpStatus
- The response's http status code.
CreateSegmentResponse
, createSegmentResponse_segment
- A structure that contains the complete information about the segment
that was just created.
DeleteExperiment
data DeleteExperiment Source #
See: newDeleteExperiment
smart constructor.
Instances
Create a value of DeleteExperiment
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:experiment:DeleteExperiment'
, deleteExperiment_experiment
- The name of the experiment to delete.
DeleteExperiment
, deleteExperiment_project
- The name or ARN of the project that contains the experiment to delete.
data DeleteExperimentResponse Source #
See: newDeleteExperimentResponse
smart constructor.
Instances
newDeleteExperimentResponse Source #
Create a value of DeleteExperimentResponse
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:httpStatus:DeleteExperimentResponse'
, deleteExperimentResponse_httpStatus
- The response's http status code.
DeleteFeature
data DeleteFeature Source #
See: newDeleteFeature
smart constructor.
Instances
Create a value of DeleteFeature
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:
DeleteFeature
, deleteFeature_feature
- The name of the feature to delete.
DeleteFeature
, deleteFeature_project
- The name or ARN of the project that contains the feature to delete.
data DeleteFeatureResponse Source #
See: newDeleteFeatureResponse
smart constructor.
Instances
newDeleteFeatureResponse Source #
Create a value of DeleteFeatureResponse
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:httpStatus:DeleteFeatureResponse'
, deleteFeatureResponse_httpStatus
- The response's http status code.
DeleteLaunch
data DeleteLaunch Source #
See: newDeleteLaunch
smart constructor.
Instances
Create a value of DeleteLaunch
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:launch:DeleteLaunch'
, deleteLaunch_launch
- The name of the launch to delete.
DeleteLaunch
, deleteLaunch_project
- The name or ARN of the project that contains the launch to delete.
data DeleteLaunchResponse Source #
See: newDeleteLaunchResponse
smart constructor.
Instances
newDeleteLaunchResponse Source #
Create a value of DeleteLaunchResponse
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:httpStatus:DeleteLaunchResponse'
, deleteLaunchResponse_httpStatus
- The response's http status code.
DeleteProject
data DeleteProject Source #
See: newDeleteProject
smart constructor.
Instances
Create a value of DeleteProject
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:
DeleteProject
, deleteProject_project
- The name or ARN of the project to delete.
data DeleteProjectResponse Source #
See: newDeleteProjectResponse
smart constructor.
Instances
newDeleteProjectResponse Source #
Create a value of DeleteProjectResponse
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:httpStatus:DeleteProjectResponse'
, deleteProjectResponse_httpStatus
- The response's http status code.
DeleteSegment
data DeleteSegment Source #
See: newDeleteSegment
smart constructor.
Instances
Create a value of DeleteSegment
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:
DeleteSegment
, deleteSegment_segment
- Specifies the segment to delete.
data DeleteSegmentResponse Source #
See: newDeleteSegmentResponse
smart constructor.
Instances
newDeleteSegmentResponse Source #
Create a value of DeleteSegmentResponse
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:httpStatus:DeleteSegmentResponse'
, deleteSegmentResponse_httpStatus
- The response's http status code.
EvaluateFeature
data EvaluateFeature Source #
See: newEvaluateFeature
smart constructor.
Instances
Create a value of EvaluateFeature
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:
EvaluateFeature
, evaluateFeature_evaluationContext
- A JSON object of attributes that you can optionally pass in as part of
the evaluation event sent to Evidently from the user session. Evidently
can use this value to match user sessions with defined audience
segments. For more information, see
Use segments to focus your audience.
<p>If you include this parameter, the value must be a JSON object. A JSON array is not supported.</p>
EvaluateFeature
, evaluateFeature_entityId
- An internal ID that represents a unique user of the application. This
entityID
is checked against any override rules assigned for this
feature.
EvaluateFeature
, evaluateFeature_feature
- The name of the feature being evaluated.
EvaluateFeature
, evaluateFeature_project
- The name or ARN of the project that contains this feature.
data EvaluateFeatureResponse Source #
See: newEvaluateFeatureResponse
smart constructor.
Instances
newEvaluateFeatureResponse Source #
Create a value of EvaluateFeatureResponse
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:
EvaluateFeatureResponse
, evaluateFeatureResponse_details
- If this user was assigned to a launch or experiment, this field lists
the launch or experiment name.
EvaluateFeatureResponse
, evaluateFeatureResponse_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; EXPERIMENT_RULE_MATCH
, if the user session was enrolled
in an experiment; or ENTITY_OVERRIDES_MATCH
, if the user's entityId
matches an override rule.
EvaluateFeatureResponse
, evaluateFeatureResponse_value
- The value assigned to this variation to differentiate it from the other
variations of this feature.
EvaluateFeatureResponse
, evaluateFeatureResponse_variation
- The name of the variation that was served to the user session.
$sel:httpStatus:EvaluateFeatureResponse'
, evaluateFeatureResponse_httpStatus
- The response's http status code.
GetExperiment
data GetExperiment Source #
See: newGetExperiment
smart constructor.
Instances
Create a value of GetExperiment
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:
GetExperiment
, getExperiment_experiment
- The name of the experiment that you want to see the details of.
GetExperiment
, getExperiment_project
- The name or ARN of the project that contains the experiment.
data GetExperimentResponse Source #
See: newGetExperimentResponse
smart constructor.
Instances
newGetExperimentResponse Source #
Create a value of GetExperimentResponse
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:
GetExperiment
, getExperimentResponse_experiment
- A structure containing the configuration details of the experiment.
$sel:httpStatus:GetExperimentResponse'
, getExperimentResponse_httpStatus
- The response's http status code.
GetExperimentResults
data GetExperimentResults Source #
See: newGetExperimentResults
smart constructor.
Instances
newGetExperimentResults Source #
Create a value of GetExperimentResults
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:baseStat:GetExperimentResults'
, getExperimentResults_baseStat
- The statistic used to calculate experiment results. Currently the only
valid value is mean
, which uses the mean of the collected values as
the statistic.
GetExperimentResults
, getExperimentResults_endTime
- The date and time that the experiment ended, if it is completed. This
must be no longer than 30 days after the experiment start time.
$sel:period:GetExperimentResults'
, getExperimentResults_period
- In seconds, the amount of time to aggregate results together.
$sel:reportNames:GetExperimentResults'
, getExperimentResults_reportNames
- The names of the report types that you want to see. Currently,
BayesianInference
is the only valid value.
$sel:resultStats:GetExperimentResults'
, getExperimentResults_resultStats
- The statistics that you want to see in the returned results.
PValue
specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.ConfidenceInterval
specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between thebaseStat
of a variation and the baseline. Evidently returns the 95% confidence interval.TreatmentEffect
is the difference in the statistic specified by thebaseStat
parameter between each variation and the default variation.BaseStat
returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in thebaseStat
parameter. Therefore, ifbaseStat
ismean
, this returns the mean of the values collected for each variation.
GetExperimentResults
, getExperimentResults_startTime
- The date and time that the experiment started.
$sel:experiment:GetExperimentResults'
, getExperimentResults_experiment
- The name of the experiment to retrieve the results of.
$sel:metricNames:GetExperimentResults'
, getExperimentResults_metricNames
- The names of the experiment metrics that you want to see the results of.
GetExperimentResults
, getExperimentResults_project
- The name or ARN of the project that contains the experiment that you
want to see the results of.
$sel:treatmentNames:GetExperimentResults'
, getExperimentResults_treatmentNames
- The names of the experiment treatments that you want to see the results
for.
data GetExperimentResultsResponse Source #
See: newGetExperimentResultsResponse
smart constructor.
GetExperimentResultsResponse' (Maybe Text) (Maybe [ExperimentReport]) (Maybe [ExperimentResultsData]) (Maybe [POSIX]) Int |
Instances
newGetExperimentResultsResponse Source #
Create a value of GetExperimentResultsResponse
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:
GetExperimentResultsResponse
, getExperimentResultsResponse_details
- If the experiment doesn't yet have enough events to provide valid
results, this field is returned with the message
Not enough events to generate results
. If there are enough events to
provide valid results, this field is not returned.
$sel:reports:GetExperimentResultsResponse'
, getExperimentResultsResponse_reports
- An array of structures that include the reports that you requested.
$sel:resultsData:GetExperimentResultsResponse'
, getExperimentResultsResponse_resultsData
- An array of structures that include experiment results including metric
names and values.
$sel:timestamps:GetExperimentResultsResponse'
, getExperimentResultsResponse_timestamps
- The timestamps of each result returned.
$sel:httpStatus:GetExperimentResultsResponse'
, getExperimentResultsResponse_httpStatus
- The response's http status code.
GetFeature
data GetFeature Source #
See: newGetFeature
smart constructor.
Instances
Create a value of GetFeature
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:
GetFeature
, getFeature_feature
- The name of the feature that you want to retrieve information for.
GetFeature
, getFeature_project
- The name or ARN of the project that contains the feature.
data GetFeatureResponse Source #
See: newGetFeatureResponse
smart constructor.
Instances
newGetFeatureResponse Source #
Create a value of GetFeatureResponse
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:httpStatus:GetFeatureResponse'
, getFeatureResponse_httpStatus
- The response's http status code.
GetFeature
, getFeatureResponse_feature
- A structure containing the configuration details of the feature.
GetLaunch
See: newGetLaunch
smart constructor.
Instances
Create a value of GetLaunch
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:
GetLaunch
, getLaunch_launch
- The name of the launch that you want to see the details of.
GetLaunch
, getLaunch_project
- The name or ARN of the project that contains the launch.
data GetLaunchResponse Source #
See: newGetLaunchResponse
smart constructor.
Instances
Create a value of GetLaunchResponse
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:
GetLaunch
, getLaunchResponse_launch
- A structure containing the configuration details of the launch.
$sel:httpStatus:GetLaunchResponse'
, getLaunchResponse_httpStatus
- The response's http status code.
GetProject
data GetProject Source #
See: newGetProject
smart constructor.
Instances
:: Text | |
-> GetProject |
Create a value of GetProject
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:
GetProject
, getProject_project
- The name or ARN of the project that you want to see the details of.
data GetProjectResponse Source #
See: newGetProjectResponse
smart constructor.
Instances
newGetProjectResponse Source #
Create a value of GetProjectResponse
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:httpStatus:GetProjectResponse'
, getProjectResponse_httpStatus
- The response's http status code.
GetProject
, getProjectResponse_project
- A structure containing the configuration details of the project.
GetSegment
data GetSegment Source #
See: newGetSegment
smart constructor.
Instances
:: Text | |
-> GetSegment |
Create a value of GetSegment
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:
GetSegment
, getSegment_segment
- The ARN of the segment to return information for.
data GetSegmentResponse Source #
See: newGetSegmentResponse
smart constructor.
Instances
newGetSegmentResponse Source #
Create a value of GetSegmentResponse
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:httpStatus:GetSegmentResponse'
, getSegmentResponse_httpStatus
- The response's http status code.
GetSegment
, getSegmentResponse_segment
- A structure that contains the complete information about the segment.
ListExperiments (Paginated)
data ListExperiments Source #
See: newListExperiments
smart constructor.
Instances
Create a value of ListExperiments
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:maxResults:ListExperiments'
, listExperiments_maxResults
- The maximum number of results to include in the response.
ListExperiments
, listExperiments_nextToken
- The token to use when requesting the next set of results. You received
this token from a previous ListExperiments
operation.
ListExperiments
, listExperiments_status
- Use this optional parameter to limit the returned results to only the
experiments with the status that you specify here.
ListExperiments
, listExperiments_project
- The name or ARN of the project to return the experiment list from.
data ListExperimentsResponse Source #
See: newListExperimentsResponse
smart constructor.
Instances
newListExperimentsResponse Source #
Create a value of ListExperimentsResponse
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:experiments:ListExperimentsResponse'
, listExperimentsResponse_experiments
- An array of structures that contain the configuration details of the
experiments in the specified project.
ListExperiments
, listExperimentsResponse_nextToken
- The token to use in a subsequent ListExperiments
operation to return
the next set of results.
$sel:httpStatus:ListExperimentsResponse'
, listExperimentsResponse_httpStatus
- The response's http status code.
ListFeatures (Paginated)
data ListFeatures Source #
See: newListFeatures
smart constructor.
Instances
Create a value of ListFeatures
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:maxResults:ListFeatures'
, listFeatures_maxResults
- The maximum number of results to include in the response.
ListFeatures
, listFeatures_nextToken
- The token to use when requesting the next set of results. You received
this token from a previous ListFeatures
operation.
ListFeatures
, listFeatures_project
- The name or ARN of the project to return the feature list from.
data ListFeaturesResponse Source #
See: newListFeaturesResponse
smart constructor.
Instances
newListFeaturesResponse Source #
Create a value of ListFeaturesResponse
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:features:ListFeaturesResponse'
, listFeaturesResponse_features
- An array of structures that contain the configuration details of the
features in the specified project.
ListFeatures
, listFeaturesResponse_nextToken
- The token to use in a subsequent ListFeatures
operation to return the
next set of results.
$sel:httpStatus:ListFeaturesResponse'
, listFeaturesResponse_httpStatus
- The response's http status code.
ListLaunches (Paginated)
data ListLaunches Source #
See: newListLaunches
smart constructor.
Instances
Create a value of ListLaunches
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:maxResults:ListLaunches'
, listLaunches_maxResults
- The maximum number of results to include in the response.
ListLaunches
, listLaunches_nextToken
- The token to use when requesting the next set of results. You received
this token from a previous ListLaunches
operation.
ListLaunches
, listLaunches_status
- Use this optional parameter to limit the returned results to only the
launches with the status that you specify here.
ListLaunches
, listLaunches_project
- The name or ARN of the project to return the launch list from.
data ListLaunchesResponse Source #
See: newListLaunchesResponse
smart constructor.
Instances
newListLaunchesResponse Source #
Create a value of ListLaunchesResponse
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:launches:ListLaunchesResponse'
, listLaunchesResponse_launches
- An array of structures that contain the configuration details of the
launches in the specified project.
ListLaunches
, listLaunchesResponse_nextToken
- The token to use in a subsequent ListLaunches
operation to return the
next set of results.
$sel:httpStatus:ListLaunchesResponse'
, listLaunchesResponse_httpStatus
- The response's http status code.
ListProjects (Paginated)
data ListProjects Source #
See: newListProjects
smart constructor.
Instances
newListProjects :: ListProjects Source #
Create a value of ListProjects
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:maxResults:ListProjects'
, listProjects_maxResults
- The maximum number of results to include in the response.
ListProjects
, listProjects_nextToken
- The token to use when requesting the next set of results. You received
this token from a previous ListProjects
operation.
data ListProjectsResponse Source #
See: newListProjectsResponse
smart constructor.
Instances
newListProjectsResponse Source #
Create a value of ListProjectsResponse
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:
ListProjects
, listProjectsResponse_nextToken
- The token to use in a subsequent ListProjects
operation to return the
next set of results.
$sel:projects:ListProjectsResponse'
, listProjectsResponse_projects
- An array of structures that contain the configuration details of the
projects in the Region.
$sel:httpStatus:ListProjectsResponse'
, listProjectsResponse_httpStatus
- The response's http status code.
ListSegmentReferences (Paginated)
data ListSegmentReferences Source #
See: newListSegmentReferences
smart constructor.
Instances
newListSegmentReferences Source #
Create a value of ListSegmentReferences
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:maxResults:ListSegmentReferences'
, listSegmentReferences_maxResults
- The maximum number of results to include in the response. If you omit
this, the default of 50 is used.
ListSegmentReferences
, listSegmentReferences_nextToken
- The token to use when requesting the next set of results. You received
this token from a previous ListSegmentReferences
operation.
ListSegmentReferences
, listSegmentReferences_segment
- The ARN of the segment that you want to view information for.
ListSegmentReferences
, listSegmentReferences_type
- Specifies whether to return information about launches or experiments
that use this segment.
data ListSegmentReferencesResponse Source #
See: newListSegmentReferencesResponse
smart constructor.
Instances
newListSegmentReferencesResponse Source #
Create a value of ListSegmentReferencesResponse
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:
ListSegmentReferences
, listSegmentReferencesResponse_nextToken
- The token to use in a subsequent ListSegmentReferences
operation to
return the next set of results.
$sel:referencedBy:ListSegmentReferencesResponse'
, listSegmentReferencesResponse_referencedBy
- An array of structures, where each structure contains information about
one experiment or launch that uses this segment.
$sel:httpStatus:ListSegmentReferencesResponse'
, listSegmentReferencesResponse_httpStatus
- The response's http status code.
ListSegments (Paginated)
data ListSegments Source #
See: newListSegments
smart constructor.
Instances
newListSegments :: ListSegments Source #
Create a value of ListSegments
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:maxResults:ListSegments'
, listSegments_maxResults
- The maximum number of results to include in the response. If you omit
this, the default of 50 is used.
ListSegments
, listSegments_nextToken
- The token to use when requesting the next set of results. You received
this token from a previous ListSegments
operation.
data ListSegmentsResponse Source #
See: newListSegmentsResponse
smart constructor.
Instances
newListSegmentsResponse Source #
Create a value of ListSegmentsResponse
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:
ListSegments
, listSegmentsResponse_nextToken
- The token to use in a subsequent ListSegments
operation to return the
next set of results.
$sel:segments:ListSegmentsResponse'
, listSegmentsResponse_segments
- An array of structures that contain information about the segments in
this Region.
$sel:httpStatus:ListSegmentsResponse'
, listSegmentsResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The ARN of the resource that you want to see the tags of.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:
ListTagsForResourceResponse
, listTagsForResourceResponse_tags
- The list of tag keys and values associated with the resource you
specified.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
PutProjectEvents
data PutProjectEvents Source #
See: newPutProjectEvents
smart constructor.
Instances
Create a value of PutProjectEvents
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:events:PutProjectEvents'
, putProjectEvents_events
- An array of event structures that contain the performance data that is
being sent to Evidently.
PutProjectEvents
, putProjectEvents_project
- The name or ARN of the project to write the events to.
data PutProjectEventsResponse Source #
See: newPutProjectEventsResponse
smart constructor.
Instances
newPutProjectEventsResponse Source #
Create a value of PutProjectEventsResponse
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:eventResults:PutProjectEventsResponse'
, putProjectEventsResponse_eventResults
- A structure that contains Evidently's response to the sent events,
including an event ID and error codes, if any.
$sel:failedEventCount:PutProjectEventsResponse'
, putProjectEventsResponse_failedEventCount
- The number of events in the operation that could not be used by
Evidently.
$sel:httpStatus:PutProjectEventsResponse'
, putProjectEventsResponse_httpStatus
- The response's http status code.
StartExperiment
data StartExperiment Source #
See: newStartExperiment
smart constructor.
Instances
:: UTCTime | |
-> Text | |
-> Text | |
-> StartExperiment |
Create a value of StartExperiment
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:
StartExperiment
, startExperiment_analysisCompleteTime
- The date and time to end the experiment. This must be no more than 30
days after the experiment starts.
$sel:experiment:StartExperiment'
, startExperiment_experiment
- The name of the experiment to start.
StartExperiment
, startExperiment_project
- The name or ARN of the project that contains the experiment to start.
data StartExperimentResponse Source #
See: newStartExperimentResponse
smart constructor.
Instances
newStartExperimentResponse Source #
Create a value of StartExperimentResponse
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:
StartExperimentResponse
, startExperimentResponse_startedTime
- A timestamp that indicates when the experiment started.
$sel:httpStatus:StartExperimentResponse'
, startExperimentResponse_httpStatus
- The response's http status code.
StartLaunch
data StartLaunch Source #
See: newStartLaunch
smart constructor.
Instances
Create a value of StartLaunch
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:
StartLaunch
, startLaunch_launch
- The name of the launch to start.
StartLaunch
, startLaunch_project
- The name or ARN of the project that contains the launch to start.
data StartLaunchResponse Source #
See: newStartLaunchResponse
smart constructor.
Instances
newStartLaunchResponse Source #
Create a value of StartLaunchResponse
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:httpStatus:StartLaunchResponse'
, startLaunchResponse_httpStatus
- The response's http status code.
StartLaunch
, startLaunchResponse_launch
- A structure that contains information about the launch that was started.
StopExperiment
data StopExperiment Source #
See: newStopExperiment
smart constructor.
Instances
Create a value of StopExperiment
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:desiredState:StopExperiment'
, stopExperiment_desiredState
- Specify whether the experiment is to be considered COMPLETED
or
CANCELLED
after it stops.
StopExperiment
, stopExperiment_reason
- A string that describes why you are stopping the experiment.
$sel:experiment:StopExperiment'
, stopExperiment_experiment
- The name of the experiment to stop.
StopExperiment
, stopExperiment_project
- The name or ARN of the project that contains the experiment to stop.
data StopExperimentResponse Source #
See: newStopExperimentResponse
smart constructor.
Instances
newStopExperimentResponse Source #
Create a value of StopExperimentResponse
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:
StopExperimentResponse
, stopExperimentResponse_endedTime
- The date and time that the experiment stopped.
$sel:httpStatus:StopExperimentResponse'
, stopExperimentResponse_httpStatus
- The response's http status code.
StopLaunch
data StopLaunch Source #
See: newStopLaunch
smart constructor.
Instances
Create a value of StopLaunch
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:desiredState:StopLaunch'
, stopLaunch_desiredState
- Specify whether to consider the launch as COMPLETED
or CANCELLED
after it stops.
StopLaunch
, stopLaunch_reason
- A string that describes why you are stopping the launch.
$sel:launch:StopLaunch'
, stopLaunch_launch
- The name of the launch to stop.
StopLaunch
, stopLaunch_project
- The name or ARN of the project that contains the launch that you want to
stop.
data StopLaunchResponse Source #
See: newStopLaunchResponse
smart constructor.
Instances
newStopLaunchResponse Source #
Create a value of StopLaunchResponse
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:
StopLaunchResponse
, stopLaunchResponse_endedTime
- The date and time that the launch stopped.
$sel:httpStatus:StopLaunchResponse'
, stopLaunchResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceArn:TagResource'
, tagResource_resourceArn
- The ARN of the CloudWatch Evidently resource that you're adding tags
to.
TagResource
, tagResource_tags
- The list of key-value pairs to associate with the resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
TestSegmentPattern
data TestSegmentPattern Source #
See: newTestSegmentPattern
smart constructor.
Instances
newTestSegmentPattern Source #
Create a value of TestSegmentPattern
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:
TestSegmentPattern
, testSegmentPattern_pattern
- The pattern to test.
$sel:payload:TestSegmentPattern'
, testSegmentPattern_payload
- A sample evaluationContext
JSON block to test against the specified
pattern.
data TestSegmentPatternResponse Source #
See: newTestSegmentPatternResponse
smart constructor.
Instances
newTestSegmentPatternResponse Source #
:: Int | |
-> Bool | |
-> TestSegmentPatternResponse |
Create a value of TestSegmentPatternResponse
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:httpStatus:TestSegmentPatternResponse'
, testSegmentPatternResponse_httpStatus
- The response's http status code.
$sel:match:TestSegmentPatternResponse'
, testSegmentPatternResponse_match
- Returns true
if the pattern matches the payload.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceArn:UntagResource'
, untagResource_resourceArn
- The ARN of the CloudWatch Evidently resource that you're removing tags
from.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The list of tag keys to remove from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateExperiment
data UpdateExperiment Source #
See: newUpdateExperiment
smart constructor.
UpdateExperiment' (Maybe Text) (Maybe (NonEmpty MetricGoalConfig)) (Maybe OnlineAbConfig) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe [TreatmentConfig]) Text Text |
Instances
Create a value of UpdateExperiment
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:
UpdateExperiment
, updateExperiment_description
- An optional description of the experiment.
UpdateExperiment
, updateExperiment_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:onlineAbConfig:UpdateExperiment'
, updateExperiment_onlineAbConfig
- A structure that contains the configuration of which variation o use as
the "control" version. The "control" version is used for comparison
with other variations. This structure also specifies how much experiment
traffic is allocated to each variation.
UpdateExperiment
, updateExperiment_randomizationSalt
- When Evidently assigns a particular user session to an experiment, it
must use a randomization ID to determine which variation the user
session is served. This randomization ID is a combination of the entity
ID and randomizationSalt
. If you omit randomizationSalt
, Evidently
uses the experiment name as the randomizationSalt
.
$sel:removeSegment:UpdateExperiment'
, updateExperiment_removeSegment
- Removes a segment from being used in an experiment. You can't use this
parameter if the experiment is currently running.
UpdateExperiment
, updateExperiment_samplingRate
- The portion of the available audience that you want to allocate to this
experiment, in thousandths of a percent. The available audience is the
total audience minus the audience that you have allocated to overrides
or current launches of this feature.
This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.
UpdateExperiment
, updateExperiment_segment
- Adds an audience segment to an experiment. When a segment is used in
an experiment, only user sessions that match the segment pattern are
used in the experiment. You can't use this parameter if the experiment
is currently running.
UpdateExperiment
, updateExperiment_treatments
- An array of structures that define the variations being tested in the
experiment.
UpdateExperiment
, updateExperiment_experiment
- The name of the experiment to update.
UpdateExperiment
, updateExperiment_project
- The name or ARN of the project that contains the experiment that you
want to update.
data UpdateExperimentResponse Source #
See: newUpdateExperimentResponse
smart constructor.
Instances
newUpdateExperimentResponse Source #
Create a value of UpdateExperimentResponse
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:httpStatus:UpdateExperimentResponse'
, updateExperimentResponse_httpStatus
- The response's http status code.
UpdateExperiment
, updateExperimentResponse_experiment
- A structure containing the configuration details of the experiment that
was updated.
UpdateFeature
data UpdateFeature Source #
See: newUpdateFeature
smart constructor.
UpdateFeature' (Maybe (NonEmpty VariationConfig)) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe FeatureEvaluationStrategy) (Maybe [Text]) Text Text |
Instances
Create a value of UpdateFeature
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:addOrUpdateVariations:UpdateFeature'
, updateFeature_addOrUpdateVariations
- To update variation configurations for this feature, or add new ones,
specify this structure. In this array, include any variations that you
want to add or update. If the array includes a variation name that
already exists for this feature, it is updated. If it includes a new
variation name, it is added as a new variation.
UpdateFeature
, updateFeature_defaultVariation
- The name of the variation to use as the default variation. The default
variation is served to users who are not allocated to any ongoing
launches or experiments of this feature.
UpdateFeature
, updateFeature_description
- An optional description of the feature.
UpdateFeature
, updateFeature_entityOverrides
- Specified users that should always be served a specific variation of a
feature. Each user is specified by a key-value pair . For each key,
specify a user by entering their user ID, account ID, or some other
identifier. For the value, specify the name of the variation that they
are to be served.
UpdateFeature
, updateFeature_evaluationStrategy
- Specify ALL_RULES
to activate the traffic allocation specified by any
ongoing launches or experiments. Specify DEFAULT_VARIATION
to serve
the default variation to all users instead.
$sel:removeVariations:UpdateFeature'
, updateFeature_removeVariations
- Removes a variation from the feature. If the variation you specify
doesn't exist, then this makes no change and does not report an error.
This operation fails if you try to remove a variation that is part of an ongoing launch or experiment.
UpdateFeature
, updateFeature_feature
- The name of the feature to be updated.
UpdateFeature
, updateFeature_project
- The name or ARN of the project that contains the feature to be updated.
data UpdateFeatureResponse Source #
See: newUpdateFeatureResponse
smart constructor.
Instances
newUpdateFeatureResponse Source #
Create a value of UpdateFeatureResponse
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:httpStatus:UpdateFeatureResponse'
, updateFeatureResponse_httpStatus
- The response's http status code.
UpdateFeature
, updateFeatureResponse_feature
- A structure that contains information about the updated feature.
UpdateLaunch
data UpdateLaunch Source #
See: newUpdateLaunch
smart constructor.
UpdateLaunch' (Maybe Text) (Maybe (NonEmpty LaunchGroupConfig)) (Maybe [MetricMonitorConfig]) (Maybe Text) (Maybe ScheduledSplitsLaunchConfig) Text Text |
Instances
Create a value of UpdateLaunch
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:
UpdateLaunch
, updateLaunch_description
- An optional description for the launch.
UpdateLaunch
, updateLaunch_groups
- An array of structures that contains the feature and variations that are
to be used for the launch.
UpdateLaunch
, updateLaunch_metricMonitors
- An array of structures that define the metrics that will be used to
monitor the launch performance.
UpdateLaunch
, updateLaunch_randomizationSalt
- When Evidently assigns a particular user session to a launch, it must
use a randomization ID to determine which variation the user session is
served. This randomization ID is a combination of the entity ID and
randomizationSalt
. If you omit randomizationSalt
, Evidently uses the
launch name as the randomizationSalt
.
$sel:scheduledSplitsConfig:UpdateLaunch'
, updateLaunch_scheduledSplitsConfig
- An array of structures that define the traffic allocation percentages
among the feature variations during each step of the launch.
UpdateLaunch
, updateLaunch_launch
- The name of the launch that is to be updated.
UpdateLaunch
, updateLaunch_project
- The name or ARN of the project that contains the launch that you want to
update.
data UpdateLaunchResponse Source #
See: newUpdateLaunchResponse
smart constructor.
Instances
newUpdateLaunchResponse Source #
Create a value of UpdateLaunchResponse
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:httpStatus:UpdateLaunchResponse'
, updateLaunchResponse_httpStatus
- The response's http status code.
UpdateLaunch
, updateLaunchResponse_launch
- A structure that contains the new configuration of the launch that was
updated.
UpdateProject
data UpdateProject Source #
See: newUpdateProject
smart constructor.
Instances
Create a value of UpdateProject
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:
UpdateProject
, updateProject_appConfigResource
- Use this parameter if the project will use client-side evaluation
powered by AppConfig. Client-side evaluation allows your application to
assign variations to user sessions locally instead of by calling the
EvaluateFeature
operation. This mitigates the latency and availability risks that come
with an API call. allows you to
This parameter is a structure that contains information about the AppConfig application that will be used for client-side evaluation.
UpdateProject
, updateProject_description
- An optional description of the project.
UpdateProject
, updateProject_project
- The name or ARN of the project to update.
data UpdateProjectResponse Source #
See: newUpdateProjectResponse
smart constructor.
Instances
newUpdateProjectResponse Source #
Create a value of UpdateProjectResponse
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:httpStatus:UpdateProjectResponse'
, updateProjectResponse_httpStatus
- The response's http status code.
UpdateProject
, updateProjectResponse_project
- A structure containing information about the updated project.
UpdateProjectDataDelivery
data UpdateProjectDataDelivery Source #
See: newUpdateProjectDataDelivery
smart constructor.
Instances
newUpdateProjectDataDelivery Source #
Create a value of UpdateProjectDataDelivery
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:
UpdateProjectDataDelivery
, updateProjectDataDelivery_cloudWatchLogs
- A structure containing the CloudWatch Logs log group where you want to
store evaluation events.
UpdateProjectDataDelivery
, updateProjectDataDelivery_s3Destination
- A structure containing the S3 bucket name and bucket prefix where you
want to store evaluation events.
UpdateProjectDataDelivery
, updateProjectDataDelivery_project
- The name or ARN of the project that you want to modify the data storage
options for.
data UpdateProjectDataDeliveryResponse Source #
See: newUpdateProjectDataDeliveryResponse
smart constructor.
Instances
Generic UpdateProjectDataDeliveryResponse Source # | |
Read UpdateProjectDataDeliveryResponse Source # | |
Show UpdateProjectDataDeliveryResponse Source # | |
NFData UpdateProjectDataDeliveryResponse Source # | |
Defined in Amazonka.Evidently.UpdateProjectDataDelivery rnf :: UpdateProjectDataDeliveryResponse -> () # | |
Eq UpdateProjectDataDeliveryResponse Source # | |
type Rep UpdateProjectDataDeliveryResponse Source # | |
Defined in Amazonka.Evidently.UpdateProjectDataDelivery type Rep UpdateProjectDataDeliveryResponse = D1 ('MetaData "UpdateProjectDataDeliveryResponse" "Amazonka.Evidently.UpdateProjectDataDelivery" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "UpdateProjectDataDeliveryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "project") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Project))) |
newUpdateProjectDataDeliveryResponse Source #
Create a value of UpdateProjectDataDeliveryResponse
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:httpStatus:UpdateProjectDataDeliveryResponse'
, updateProjectDataDeliveryResponse_httpStatus
- The response's http status code.
UpdateProjectDataDelivery
, updateProjectDataDeliveryResponse_project
- A structure containing details about the project that you updated.
Types
ChangeDirectionEnum
newtype ChangeDirectionEnum Source #
pattern ChangeDirectionEnum_DECREASE :: ChangeDirectionEnum | |
pattern ChangeDirectionEnum_INCREASE :: ChangeDirectionEnum |
Instances
EventType
pattern EventType_Aws_evidently_custom :: EventType | |
pattern EventType_Aws_evidently_evaluation :: EventType |
Instances
ExperimentBaseStat
newtype ExperimentBaseStat Source #
pattern ExperimentBaseStat_Mean :: ExperimentBaseStat |
Instances
ExperimentReportName
newtype ExperimentReportName Source #
Instances
ExperimentResultRequestType
newtype ExperimentResultRequestType Source #
Instances
ExperimentResultResponseType
newtype ExperimentResultResponseType Source #
Instances
ExperimentStatus
newtype ExperimentStatus Source #
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 #
pattern ExperimentStopDesiredState_CANCELLED :: ExperimentStopDesiredState | |
pattern ExperimentStopDesiredState_COMPLETED :: ExperimentStopDesiredState |
Instances
ExperimentType
newtype ExperimentType Source #
Instances
FeatureEvaluationStrategy
newtype FeatureEvaluationStrategy Source #
pattern FeatureEvaluationStrategy_ALL_RULES :: FeatureEvaluationStrategy | |
pattern FeatureEvaluationStrategy_DEFAULT_VARIATION :: FeatureEvaluationStrategy |
Instances
FeatureStatus
newtype FeatureStatus Source #
pattern FeatureStatus_AVAILABLE :: FeatureStatus | |
pattern FeatureStatus_UPDATING :: FeatureStatus |
Instances
LaunchStatus
newtype LaunchStatus Source #
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 #
pattern LaunchStopDesiredState_CANCELLED :: LaunchStopDesiredState | |
pattern LaunchStopDesiredState_COMPLETED :: LaunchStopDesiredState |
Instances
LaunchType
newtype LaunchType Source #
pattern LaunchType_Aws_evidently_splits :: LaunchType |
Instances
ProjectStatus
newtype ProjectStatus Source #
pattern ProjectStatus_AVAILABLE :: ProjectStatus | |
pattern ProjectStatus_UPDATING :: ProjectStatus |
Instances
SegmentReferenceResourceType
newtype SegmentReferenceResourceType Source #
pattern SegmentReferenceResourceType_EXPERIMENT :: SegmentReferenceResourceType | |
pattern SegmentReferenceResourceType_LAUNCH :: SegmentReferenceResourceType |
Instances
VariationValueType
newtype VariationValueType Source #
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.
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.
CloudWatchLogsDestinationConfig
data CloudWatchLogsDestinationConfig Source #
A structure containing the CloudWatch Logs log group where the project stores evaluation events.
See: newCloudWatchLogsDestinationConfig
smart constructor.
Instances
ToJSON CloudWatchLogsDestinationConfig Source # | |
Generic CloudWatchLogsDestinationConfig Source # | |
Read CloudWatchLogsDestinationConfig Source # | |
Show CloudWatchLogsDestinationConfig Source # | |
NFData CloudWatchLogsDestinationConfig Source # | |
Defined in Amazonka.Evidently.Types.CloudWatchLogsDestinationConfig rnf :: CloudWatchLogsDestinationConfig -> () # | |
Eq CloudWatchLogsDestinationConfig Source # | |
Hashable CloudWatchLogsDestinationConfig Source # | |
type Rep CloudWatchLogsDestinationConfig Source # | |
Defined in Amazonka.Evidently.Types.CloudWatchLogsDestinationConfig type Rep CloudWatchLogsDestinationConfig = D1 ('MetaData "CloudWatchLogsDestinationConfig" "Amazonka.Evidently.Types.CloudWatchLogsDestinationConfig" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "CloudWatchLogsDestinationConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "logGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
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.
EvaluationRequest
data EvaluationRequest Source #
This structure assigns a feature variation to one user session.
See: newEvaluationRequest
smart constructor.
Instances
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.
EvaluationResult
data EvaluationResult Source #
This structure displays the results of one feature evaluation assignment to one user session.
See: newEvaluationResult
smart constructor.
EvaluationResult' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe VariableValue) (Maybe Text) Text Text |
Instances
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.
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.
Instances
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.
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.
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.
Experiment
data Experiment Source #
A structure containing the configuration details of an experiment.
See: newExperiment
smart constructor.
Experiment' (Maybe Text) (Maybe ExperimentExecution) (Maybe (NonEmpty MetricGoal)) (Maybe OnlineAbDefinition) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe ExperimentSchedule) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (NonEmpty Treatment)) Text POSIX POSIX Text ExperimentStatus ExperimentType |
Instances
:: 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
.
ExperimentExecution
data ExperimentExecution Source #
This structure contains the date and time that the experiment started and ended.
See: newExperimentExecution
smart constructor.
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.
ExperimentReport
data ExperimentReport Source #
A structure that contains results of an experiment.
See: newExperimentReport
smart constructor.
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.
ExperimentResultsData
data ExperimentResultsData Source #
A structure that contains experiment results for one metric that is monitored in the experiment.
See: newExperimentResultsData
smart constructor.
ExperimentResultsData' (Maybe Text) (Maybe ExperimentResultResponseType) (Maybe Text) (Maybe [Double]) |
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.
ExperimentSchedule
data ExperimentSchedule Source #
This structure contains the time and date that Evidently completed the analysis of the experiment.
See: newExperimentSchedule
smart constructor.
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.
Feature
This structure contains information about one Evidently feature in your account.
See: newFeature
smart constructor.
Instances
:: 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.
FeatureSummary
data FeatureSummary Source #
This structure contains information about one Evidently feature in your account.
See: newFeatureSummary
smart constructor.
FeatureSummary' (Maybe Text) (Maybe [EvaluationRule]) (Maybe Text) (Maybe (HashMap Text Text)) Text POSIX FeatureEvaluationStrategy POSIX Text FeatureStatus |
Instances
:: 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.
Launch
This structure contains the configuration details of one Evidently launch.
See: newLaunch
smart constructor.
Launch' (Maybe Text) (Maybe LaunchExecution) (Maybe [LaunchGroup]) (Maybe [MetricMonitor]) (Maybe Text) (Maybe Text) (Maybe ScheduledSplitsLaunchDefinition) (Maybe Text) (Maybe (HashMap Text Text)) Text POSIX POSIX Text LaunchStatus LaunchType |
Instances
:: 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.
LaunchExecution
data LaunchExecution Source #
This structure contains information about the start and end times of the launch.
See: newLaunchExecution
smart constructor.
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.
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.
Instances
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.
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.
Instances
:: 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.
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.
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.
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.
Instances
newMetricDefinitionConfig Source #
:: 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.
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.
Instances
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Instances
newProjectAppConfigResource Source #
:: 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
.
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.
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
.
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.
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.
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.
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.
ProjectSummary
data ProjectSummary Source #
A structure that contains configuration information about an Evidently project.
See: newProjectSummary
smart constructor.
ProjectSummary' (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe (HashMap Text Text)) Text POSIX POSIX Text ProjectStatus |
Instances
:: 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.
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.
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.
RefResource
data RefResource Source #
A structure that contains information about one experiment or launch that uses the specified segment.
See: newRefResource
smart constructor.
Instances
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.
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.
S3Destination' (Maybe Text) (Maybe Text) |
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.
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.
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.
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.
Instances
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.
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.
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.
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.
Instances
newScheduledSplitsLaunchConfig Source #
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.
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.
Instances
FromJSON ScheduledSplitsLaunchDefinition Source # | |
Generic ScheduledSplitsLaunchDefinition Source # | |
Read ScheduledSplitsLaunchDefinition Source # | |
Show ScheduledSplitsLaunchDefinition Source # | |
NFData ScheduledSplitsLaunchDefinition Source # | |
Defined in Amazonka.Evidently.Types.ScheduledSplitsLaunchDefinition rnf :: ScheduledSplitsLaunchDefinition -> () # | |
Eq ScheduledSplitsLaunchDefinition Source # | |
Hashable ScheduledSplitsLaunchDefinition Source # | |
type Rep ScheduledSplitsLaunchDefinition Source # | |
Defined in Amazonka.Evidently.Types.ScheduledSplitsLaunchDefinition type Rep ScheduledSplitsLaunchDefinition = D1 ('MetaData "ScheduledSplitsLaunchDefinition" "Amazonka.Evidently.Types.ScheduledSplitsLaunchDefinition" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "ScheduledSplitsLaunchDefinition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "steps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ScheduledSplit))))) |
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.
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.
Segment' (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe (HashMap Text Text)) Text POSIX POSIX Text Text |
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.
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.
Instances
:: 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.
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.
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.
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.
Instances
:: 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.
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.
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.
Variation
This structure contains the name and variation value of one variation of a feature.
See: newVariation
smart constructor.
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.
VariationConfig
data VariationConfig Source #
This structure contains the name and variation value of one variation of a feature.
See: newVariationConfig
smart constructor.
Instances
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.