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

Description

 
Synopsis

Documentation

data ScheduledSplit 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: newScheduledSplit smart constructor.

Constructors

ScheduledSplit' 

Fields

  • groupWeights :: Maybe (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.

    The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.

    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.

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

  • startTime :: POSIX

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

Instances

Instances details
FromJSON ScheduledSplit Source # 
Instance details

Defined in Amazonka.Evidently.Types.ScheduledSplit

Generic ScheduledSplit Source # 
Instance details

Defined in Amazonka.Evidently.Types.ScheduledSplit

Associated Types

type Rep ScheduledSplit :: Type -> Type #

Read ScheduledSplit Source # 
Instance details

Defined in Amazonka.Evidently.Types.ScheduledSplit

Show ScheduledSplit Source # 
Instance details

Defined in Amazonka.Evidently.Types.ScheduledSplit

NFData ScheduledSplit Source # 
Instance details

Defined in Amazonka.Evidently.Types.ScheduledSplit

Methods

rnf :: ScheduledSplit -> () #

Eq ScheduledSplit Source # 
Instance details

Defined in Amazonka.Evidently.Types.ScheduledSplit

Hashable ScheduledSplit Source # 
Instance details

Defined in Amazonka.Evidently.Types.ScheduledSplit

type Rep ScheduledSplit Source # 
Instance details

Defined in Amazonka.Evidently.Types.ScheduledSplit

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

newScheduledSplit Source #

Create a value of ScheduledSplit 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:groupWeights:ScheduledSplit', scheduledSplit_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.

The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.

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.

$sel:segmentOverrides:ScheduledSplit', scheduledSplit_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:startTime:ScheduledSplit', scheduledSplit_startTime - The date and time that this step of the launch starts.

scheduledSplit_groupWeights :: Lens' ScheduledSplit (Maybe (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.

The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.

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.

scheduledSplit_segmentOverrides :: Lens' ScheduledSplit (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.

scheduledSplit_startTime :: Lens' ScheduledSplit UTCTime Source #

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