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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a launch of a given feature. Before you create a launch, you must create the feature to use for the launch.

You can use a launch 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 more users. This helps you reduce risk and identify unintended consequences before you fully launch the feature.

Don't use this operation to update an existing launch. Instead, use UpdateLaunch.

Synopsis

data CreateLaunch = CreateLaunch' {
- description :: Maybe Text
- metricMonitors :: Maybe [MetricMonitorConfig]
- randomizationSalt :: Maybe Text
- scheduledSplitsConfig :: Maybe ScheduledSplitsLaunchConfig
- tags :: Maybe (HashMap Text Text)
- groups :: NonEmpty LaunchGroupConfig
- name :: Text
- project :: Text
}
newCreateLaunch :: NonEmpty LaunchGroupConfig -> Text -> Text -> CreateLaunch
createLaunch_description :: Lens' CreateLaunch (Maybe Text)
createLaunch_metricMonitors :: Lens' CreateLaunch (Maybe [MetricMonitorConfig])
createLaunch_randomizationSalt :: Lens' CreateLaunch (Maybe Text)
createLaunch_scheduledSplitsConfig :: Lens' CreateLaunch (Maybe ScheduledSplitsLaunchConfig)
createLaunch_tags :: Lens' CreateLaunch (Maybe (HashMap Text Text))
createLaunch_groups :: Lens' CreateLaunch (NonEmpty LaunchGroupConfig)
createLaunch_name :: Lens' CreateLaunch Text
createLaunch_project :: Lens' CreateLaunch Text
data CreateLaunchResponse = CreateLaunchResponse' {
- httpStatus :: Int
- launch :: Launch
}
newCreateLaunchResponse :: Int -> Launch -> CreateLaunchResponse
createLaunchResponse_httpStatus :: Lens' CreateLaunchResponse Int
createLaunchResponse_launch :: Lens' CreateLaunchResponse Launch

Creating a Request

data CreateLaunch Source #

See: newCreateLaunch smart constructor.

Constructors

CreateLaunch'

Fields

description :: Maybe Text
An optional description for the launch.
metricMonitors :: Maybe [MetricMonitorConfig]
An array of structures that define the metrics that will be used to monitor the launch performance.
randomizationSalt :: Maybe Text
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.
scheduledSplitsConfig :: Maybe ScheduledSplitsLaunchConfig
An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
tags :: Maybe (HashMap Text Text)
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>
```
groups :: NonEmpty LaunchGroupConfig
An array of structures that contains the feature and variations that are to be used for the launch.
name :: Text
The name for the new launch.
project :: Text
The name or ARN of the project that you want to create the launch in.

Instances

Instances details

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

newCreateLaunch Source #

Arguments

:: NonEmpty LaunchGroupConfig	`CreateLaunch`
-> Text	`CreateLaunch`
-> Text	`CreateLaunch`
-> CreateLaunch

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.

Request Lenses

createLaunch_description :: Lens' CreateLaunch (Maybe Text) Source #

An optional description for the launch.

createLaunch_metricMonitors :: Lens' CreateLaunch (Maybe [MetricMonitorConfig]) Source #

An array of structures that define the metrics that will be used to monitor the launch performance.

createLaunch_randomizationSalt :: Lens' CreateLaunch (Maybe Text) Source #

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.

createLaunch_scheduledSplitsConfig :: Lens' CreateLaunch (Maybe ScheduledSplitsLaunchConfig) Source #

An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

createLaunch_tags :: Lens' CreateLaunch (Maybe (HashMap Text Text)) Source #

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_groups :: Lens' CreateLaunch (NonEmpty LaunchGroupConfig) Source #

An array of structures that contains the feature and variations that are to be used for the launch.

createLaunch_name :: Lens' CreateLaunch Text Source #

The name for the new launch.

createLaunch_project :: Lens' CreateLaunch Text Source #

The name or ARN of the project that you want to create the launch in.

Destructuring the Response

data CreateLaunchResponse Source #

See: newCreateLaunchResponse smart constructor.

Constructors

CreateLaunchResponse'
Fields httpStatus :: Int The response's http status code. launch :: Launch A structure that contains the configuration of the launch that was created.

Instances

Instances details

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

newCreateLaunchResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateLaunchResponse'`
-> Launch	`$sel:launch:CreateLaunchResponse'`
-> 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.

Response Lenses

createLaunchResponse_httpStatus :: Lens' CreateLaunchResponse Int Source #

The response's http status code.

createLaunchResponse_launch :: Lens' CreateLaunchResponse Launch Source #

A structure that contains the configuration of the launch that was created.