Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Evidently.UpdateExperiment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an Evidently experiment.

Don't use this operation to update an experiment's tag. Instead, use TagResource.

Synopsis

data UpdateExperiment = UpdateExperiment' {
- description :: Maybe Text
- metricGoals :: Maybe (NonEmpty MetricGoalConfig)
- onlineAbConfig :: Maybe OnlineAbConfig
- randomizationSalt :: Maybe Text
- removeSegment :: Maybe Bool
- samplingRate :: Maybe Natural
- segment :: Maybe Text
- treatments :: Maybe [TreatmentConfig]
- experiment :: Text
- project :: Text
}
newUpdateExperiment :: Text -> Text -> UpdateExperiment
updateExperiment_description :: Lens' UpdateExperiment (Maybe Text)
updateExperiment_metricGoals :: Lens' UpdateExperiment (Maybe (NonEmpty MetricGoalConfig))
updateExperiment_onlineAbConfig :: Lens' UpdateExperiment (Maybe OnlineAbConfig)
updateExperiment_randomizationSalt :: Lens' UpdateExperiment (Maybe Text)
updateExperiment_removeSegment :: Lens' UpdateExperiment (Maybe Bool)
updateExperiment_samplingRate :: Lens' UpdateExperiment (Maybe Natural)
updateExperiment_segment :: Lens' UpdateExperiment (Maybe Text)
updateExperiment_treatments :: Lens' UpdateExperiment (Maybe [TreatmentConfig])
updateExperiment_experiment :: Lens' UpdateExperiment Text
updateExperiment_project :: Lens' UpdateExperiment Text
data UpdateExperimentResponse = UpdateExperimentResponse' {
- httpStatus :: Int
- experiment :: Experiment
}
newUpdateExperimentResponse :: Int -> Experiment -> UpdateExperimentResponse
updateExperimentResponse_httpStatus :: Lens' UpdateExperimentResponse Int
updateExperimentResponse_experiment :: Lens' UpdateExperimentResponse Experiment

Creating a Request

data UpdateExperiment Source #

See: newUpdateExperiment smart constructor.

Constructors

UpdateExperiment'

Fields

description :: Maybe Text
An optional description of the experiment.
metricGoals :: Maybe (NonEmpty MetricGoalConfig)
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.
onlineAbConfig :: Maybe 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.
randomizationSalt :: Maybe Text
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.
removeSegment :: Maybe Bool
Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.
samplingRate :: Maybe Natural
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.
segment :: Maybe Text
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.
treatments :: Maybe [TreatmentConfig]
An array of structures that define the variations being tested in the experiment.
experiment :: Text
The name of the experiment to update.
project :: Text
The name or ARN of the project that contains the experiment that you want to update.

Instances

Instances details

ToJSON UpdateExperiment Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment Methods toJSON :: UpdateExperiment -> Value # toEncoding :: UpdateExperiment -> Encoding # toJSONList :: [UpdateExperiment] -> Value # toEncodingList :: [UpdateExperiment] -> Encoding #
ToHeaders UpdateExperiment Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment Methods toHeaders :: UpdateExperiment -> [Header] #
ToPath UpdateExperiment Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment Methods toPath :: UpdateExperiment -> ByteString #
ToQuery UpdateExperiment Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment Methods toQuery :: UpdateExperiment -> QueryString #
AWSRequest UpdateExperiment Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment Associated Types type AWSResponse UpdateExperiment # Methods request :: (Service -> Service) -> UpdateExperiment -> Request UpdateExperiment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateExperiment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateExperiment))) #
Generic UpdateExperiment Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment Associated Types type Rep UpdateExperiment :: Type -> Type # Methods from :: UpdateExperiment -> Rep UpdateExperiment x # to :: Rep UpdateExperiment x -> UpdateExperiment #
Read UpdateExperiment Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment Methods readsPrec :: Int -> ReadS UpdateExperiment # readList :: ReadS [UpdateExperiment] # readPrec :: ReadPrec UpdateExperiment # readListPrec :: ReadPrec [UpdateExperiment] #
Show UpdateExperiment Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment Methods showsPrec :: Int -> UpdateExperiment -> ShowS # show :: UpdateExperiment -> String # showList :: [UpdateExperiment] -> ShowS #
NFData UpdateExperiment Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment Methods rnf :: UpdateExperiment -> () #
Eq UpdateExperiment Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment Methods (==) :: UpdateExperiment -> UpdateExperiment -> Bool # (/=) :: UpdateExperiment -> UpdateExperiment -> Bool #
Hashable UpdateExperiment Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment Methods hashWithSalt :: Int -> UpdateExperiment -> Int # hash :: UpdateExperiment -> Int #
type AWSResponse UpdateExperiment Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment type AWSResponse UpdateExperiment = UpdateExperimentResponse
type Rep UpdateExperiment Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment type Rep UpdateExperiment = D1 ('MetaData "UpdateExperiment" "Amazonka.Evidently.UpdateExperiment" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "UpdateExperiment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "metricGoals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty MetricGoalConfig)))) :: (S1 ('MetaSel ('Just "onlineAbConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OnlineAbConfig)) :: (S1 ('MetaSel ('Just "randomizationSalt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "removeSegment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "samplingRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "segment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "treatments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TreatmentConfig])) :: (S1 ('MetaSel ('Just "experiment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "project") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateExperiment Source #

Arguments

:: Text	`UpdateExperiment`
-> Text	`UpdateExperiment`
-> UpdateExperiment

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.

Request Lenses

updateExperiment_description :: Lens' UpdateExperiment (Maybe Text) Source #

An optional description of the experiment.

updateExperiment_metricGoals :: Lens' UpdateExperiment (Maybe (NonEmpty MetricGoalConfig)) Source #

An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.

updateExperiment_onlineAbConfig :: Lens' UpdateExperiment (Maybe OnlineAbConfig) Source #

A structure that contains the configuration of which variation o use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

updateExperiment_randomizationSalt :: Lens' UpdateExperiment (Maybe Text) Source #

When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the experiment name as the randomizationSalt.

updateExperiment_removeSegment :: Lens' UpdateExperiment (Maybe Bool) Source #

Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.

updateExperiment_samplingRate :: Lens' UpdateExperiment (Maybe Natural) Source #

The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.

This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.

updateExperiment_segment :: Lens' UpdateExperiment (Maybe Text) Source #

Adds an audience segment to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.

updateExperiment_treatments :: Lens' UpdateExperiment (Maybe [TreatmentConfig]) Source #

An array of structures that define the variations being tested in the experiment.

updateExperiment_experiment :: Lens' UpdateExperiment Text Source #

The name of the experiment to update.

updateExperiment_project :: Lens' UpdateExperiment Text Source #

The name or ARN of the project that contains the experiment that you want to update.

Destructuring the Response

data UpdateExperimentResponse Source #

See: newUpdateExperimentResponse smart constructor.

Constructors

UpdateExperimentResponse'
Fields httpStatus :: Int The response's http status code. experiment :: Experiment A structure containing the configuration details of the experiment that was updated.

Instances

Instances details

Generic UpdateExperimentResponse Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment Associated Types type Rep UpdateExperimentResponse :: Type -> Type # Methods from :: UpdateExperimentResponse -> Rep UpdateExperimentResponse x # to :: Rep UpdateExperimentResponse x -> UpdateExperimentResponse #
Read UpdateExperimentResponse Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment Methods readsPrec :: Int -> ReadS UpdateExperimentResponse # readList :: ReadS [UpdateExperimentResponse] # readPrec :: ReadPrec UpdateExperimentResponse # readListPrec :: ReadPrec [UpdateExperimentResponse] #
Show UpdateExperimentResponse Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment Methods showsPrec :: Int -> UpdateExperimentResponse -> ShowS # show :: UpdateExperimentResponse -> String # showList :: [UpdateExperimentResponse] -> ShowS #
NFData UpdateExperimentResponse Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment Methods rnf :: UpdateExperimentResponse -> () #
Eq UpdateExperimentResponse Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment Methods (==) :: UpdateExperimentResponse -> UpdateExperimentResponse -> Bool # (/=) :: UpdateExperimentResponse -> UpdateExperimentResponse -> Bool #
type Rep UpdateExperimentResponse Source #
Instance details Defined in Amazonka.Evidently.UpdateExperiment type Rep UpdateExperimentResponse = D1 ('MetaData "UpdateExperimentResponse" "Amazonka.Evidently.UpdateExperiment" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "UpdateExperimentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "experiment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Experiment)))

newUpdateExperimentResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateExperimentResponse'`
-> Experiment	`UpdateExperiment`
-> UpdateExperimentResponse

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.

Response Lenses

updateExperimentResponse_httpStatus :: Lens' UpdateExperimentResponse Int Source #

The response's http status code.

updateExperimentResponse_experiment :: Lens' UpdateExperimentResponse Experiment Source #

A structure containing the configuration details of the experiment that was updated.