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.UpdateFeature

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an existing feature.

You can't use this operation to update the tags of an existing feature. Instead, use TagResource.

Synopsis

data UpdateFeature = UpdateFeature' {
- addOrUpdateVariations :: Maybe (NonEmpty VariationConfig)
- defaultVariation :: Maybe Text
- description :: Maybe Text
- entityOverrides :: Maybe (HashMap Text Text)
- evaluationStrategy :: Maybe FeatureEvaluationStrategy
- removeVariations :: Maybe [Text]
- feature :: Text
- project :: Text
}
newUpdateFeature :: Text -> Text -> UpdateFeature
updateFeature_addOrUpdateVariations :: Lens' UpdateFeature (Maybe (NonEmpty VariationConfig))
updateFeature_defaultVariation :: Lens' UpdateFeature (Maybe Text)
updateFeature_description :: Lens' UpdateFeature (Maybe Text)
updateFeature_entityOverrides :: Lens' UpdateFeature (Maybe (HashMap Text Text))
updateFeature_evaluationStrategy :: Lens' UpdateFeature (Maybe FeatureEvaluationStrategy)
updateFeature_removeVariations :: Lens' UpdateFeature (Maybe [Text])
updateFeature_feature :: Lens' UpdateFeature Text
updateFeature_project :: Lens' UpdateFeature Text
data UpdateFeatureResponse = UpdateFeatureResponse' {
- httpStatus :: Int
- feature :: Feature
}
newUpdateFeatureResponse :: Int -> Feature -> UpdateFeatureResponse
updateFeatureResponse_httpStatus :: Lens' UpdateFeatureResponse Int
updateFeatureResponse_feature :: Lens' UpdateFeatureResponse Feature

Creating a Request

data UpdateFeature Source #

See: newUpdateFeature smart constructor.

Constructors

UpdateFeature'

Fields

addOrUpdateVariations :: Maybe (NonEmpty VariationConfig)
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.
defaultVariation :: Maybe Text
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.
description :: Maybe Text
An optional description of the feature.
entityOverrides :: Maybe (HashMap Text Text)
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.
evaluationStrategy :: Maybe FeatureEvaluationStrategy
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.
removeVariations :: Maybe [Text]
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.
feature :: Text
The name of the feature to be updated.
project :: Text
The name or ARN of the project that contains the feature to be updated.

Instances

Instances details

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

newUpdateFeature Source #

Arguments

:: Text	`UpdateFeature`
-> Text	`UpdateFeature`
-> UpdateFeature

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.

Request Lenses

updateFeature_addOrUpdateVariations :: Lens' UpdateFeature (Maybe (NonEmpty VariationConfig)) Source #

To update variation configurations for this feature, or add new ones, specify this structure. In this array, include any variations that you want to add or update. If the array includes a variation name that already exists for this feature, it is updated. If it includes a new variation name, it is added as a new variation.

updateFeature_defaultVariation :: Lens' UpdateFeature (Maybe Text) Source #

The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

updateFeature_description :: Lens' UpdateFeature (Maybe Text) Source #

An optional description of the feature.

updateFeature_entityOverrides :: Lens' UpdateFeature (Maybe (HashMap Text Text)) Source #

Specified users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.

updateFeature_evaluationStrategy :: Lens' UpdateFeature (Maybe FeatureEvaluationStrategy) Source #

Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or experiments. Specify DEFAULT_VARIATION to serve the default variation to all users instead.

updateFeature_removeVariations :: Lens' UpdateFeature (Maybe [Text]) Source #

Removes a variation from the feature. If the variation you specify doesn't exist, then this makes no change and does not report an error.

This operation fails if you try to remove a variation that is part of an ongoing launch or experiment.

updateFeature_feature :: Lens' UpdateFeature Text Source #

The name of the feature to be updated.

updateFeature_project :: Lens' UpdateFeature Text Source #

The name or ARN of the project that contains the feature to be updated.

Destructuring the Response

data UpdateFeatureResponse Source #

See: newUpdateFeatureResponse smart constructor.

Constructors

UpdateFeatureResponse'
Fields httpStatus :: Int The response's http status code. feature :: Feature A structure that contains information about the updated feature.

Instances

Instances details

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

newUpdateFeatureResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateFeatureResponse'`
-> Feature	`UpdateFeature`
-> UpdateFeatureResponse

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.

Response Lenses

updateFeatureResponse_httpStatus :: Lens' UpdateFeatureResponse Int Source #

The response's http status code.

updateFeatureResponse_feature :: Lens' UpdateFeatureResponse Feature Source #

A structure that contains information about the updated feature.