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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an Evidently feature that you want to launch or test. You can define up to five variations of a feature, and use these variations in your launches and experiments. A feature must be created in a project. For information about creating a project, see CreateProject.

Don't use this operation to update an existing feature. Instead, use UpdateFeature.

Synopsis

data CreateFeature = CreateFeature' {
- defaultVariation :: Maybe Text
- description :: Maybe Text
- entityOverrides :: Maybe (HashMap Text Text)
- evaluationStrategy :: Maybe FeatureEvaluationStrategy
- tags :: Maybe (HashMap Text Text)
- name :: Text
- project :: Text
- variations :: NonEmpty VariationConfig
}
newCreateFeature :: Text -> Text -> NonEmpty VariationConfig -> CreateFeature
createFeature_defaultVariation :: Lens' CreateFeature (Maybe Text)
createFeature_description :: Lens' CreateFeature (Maybe Text)
createFeature_entityOverrides :: Lens' CreateFeature (Maybe (HashMap Text Text))
createFeature_evaluationStrategy :: Lens' CreateFeature (Maybe FeatureEvaluationStrategy)
createFeature_tags :: Lens' CreateFeature (Maybe (HashMap Text Text))
createFeature_name :: Lens' CreateFeature Text
createFeature_project :: Lens' CreateFeature Text
createFeature_variations :: Lens' CreateFeature (NonEmpty VariationConfig)
data CreateFeatureResponse = CreateFeatureResponse' {
- feature :: Maybe Feature
- httpStatus :: Int
}
newCreateFeatureResponse :: Int -> CreateFeatureResponse
createFeatureResponse_feature :: Lens' CreateFeatureResponse (Maybe Feature)
createFeatureResponse_httpStatus :: Lens' CreateFeatureResponse Int

Creating a Request

data CreateFeature Source #

See: newCreateFeature smart constructor.

Constructors

CreateFeature'

Fields

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.
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.
description :: Maybe Text
An optional description of the feature.
entityOverrides :: Maybe (HashMap Text Text)
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.
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.
tags :: Maybe (HashMap Text Text)
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>
```
name :: Text
The name for the new feature.
project :: Text
The name or ARN of the project that is to contain the new feature.
variations :: NonEmpty VariationConfig
An array of structures that contain the configuration of the feature's different variations.

Instances

Instances details

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

newCreateFeature Source #

Arguments

:: Text	`CreateFeature`
-> Text	`CreateFeature`
-> NonEmpty VariationConfig	`CreateFeature`
-> CreateFeature

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.

Request Lenses

createFeature_defaultVariation :: Lens' CreateFeature (Maybe Text) Source #

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

This variation must also be listed in the variations structure.

If you omit defaultVariation, the first variation listed in the variations structure is used as the default variation.

createFeature_description :: Lens' CreateFeature (Maybe Text) Source #

An optional description of the feature.

createFeature_entityOverrides :: Lens' CreateFeature (Maybe (HashMap Text Text)) Source #

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

createFeature_evaluationStrategy :: Lens' CreateFeature (Maybe FeatureEvaluationStrategy) Source #

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

createFeature_tags :: Lens' CreateFeature (Maybe (HashMap Text Text)) Source #

Assigns one or more tags (key-value pairs) to the feature.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

 <p>You can associate as many as 50 tags with a feature.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>

createFeature_name :: Lens' CreateFeature Text Source #

The name for the new feature.

createFeature_project :: Lens' CreateFeature Text Source #

The name or ARN of the project that is to contain the new feature.

createFeature_variations :: Lens' CreateFeature (NonEmpty VariationConfig) Source #

An array of structures that contain the configuration of the feature's different variations.

Destructuring the Response

data CreateFeatureResponse Source #

See: newCreateFeatureResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateFeatureResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateFeatureResponse'`
-> CreateFeatureResponse

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.

Response Lenses

createFeatureResponse_feature :: Lens' CreateFeatureResponse (Maybe Feature) Source #

A structure that contains information about the new feature.

createFeatureResponse_httpStatus :: Lens' CreateFeatureResponse Int Source #

The response's http status code.