amazonka-evidently-2.0: Amazon CloudWatch Evidently SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Evidently.Types.ScheduledSplitConfig

Description

 
Synopsis

Documentation

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.

Constructors

ScheduledSplitConfig' 

Fields

  • segmentOverrides :: Maybe [SegmentOverride]

    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.

  • groupWeights :: HashMap Text Natural

    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>
  • startTime :: POSIX

    The date and time that this step of the launch starts.

Instances

Instances details
ToJSON ScheduledSplitConfig Source # 
Instance details

Defined in Amazonka.Evidently.Types.ScheduledSplitConfig

Generic ScheduledSplitConfig Source # 
Instance details

Defined in Amazonka.Evidently.Types.ScheduledSplitConfig

Associated Types

type Rep ScheduledSplitConfig :: Type -> Type #

Read ScheduledSplitConfig Source # 
Instance details

Defined in Amazonka.Evidently.Types.ScheduledSplitConfig

Show ScheduledSplitConfig Source # 
Instance details

Defined in Amazonka.Evidently.Types.ScheduledSplitConfig

NFData ScheduledSplitConfig Source # 
Instance details

Defined in Amazonka.Evidently.Types.ScheduledSplitConfig

Methods

rnf :: ScheduledSplitConfig -> () #

Eq ScheduledSplitConfig Source # 
Instance details

Defined in Amazonka.Evidently.Types.ScheduledSplitConfig

Hashable ScheduledSplitConfig Source # 
Instance details

Defined in Amazonka.Evidently.Types.ScheduledSplitConfig

type Rep ScheduledSplitConfig Source # 
Instance details

Defined in Amazonka.Evidently.Types.ScheduledSplitConfig

type Rep ScheduledSplitConfig = D1 ('MetaData "ScheduledSplitConfig" "Amazonka.Evidently.Types.ScheduledSplitConfig" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "ScheduledSplitConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "segmentOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SegmentOverride])) :*: (S1 ('MetaSel ('Just "groupWeights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Natural)) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))

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.

scheduledSplitConfig_segmentOverrides :: Lens' ScheduledSplitConfig (Maybe [SegmentOverride]) Source #

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.

scheduledSplitConfig_groupWeights :: Lens' ScheduledSplitConfig (HashMap Text Natural) Source #

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>

scheduledSplitConfig_startTime :: Lens' ScheduledSplitConfig UTCTime Source #

The date and time that this step of the launch starts.