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.Types.Segment

Description

Synopsis

data Segment = Segment' {
- description :: Maybe Text
- experimentCount :: Maybe Integer
- launchCount :: Maybe Integer
- tags :: Maybe (HashMap Text Text)
- arn :: Text
- createdTime :: POSIX
- lastUpdatedTime :: POSIX
- name :: Text
- pattern' :: Text
}
newSegment :: Text -> UTCTime -> UTCTime -> Text -> Text -> Segment
segment_description :: Lens' Segment (Maybe Text)
segment_experimentCount :: Lens' Segment (Maybe Integer)
segment_launchCount :: Lens' Segment (Maybe Integer)
segment_tags :: Lens' Segment (Maybe (HashMap Text Text))
segment_arn :: Lens' Segment Text
segment_createdTime :: Lens' Segment UTCTime
segment_lastUpdatedTime :: Lens' Segment UTCTime
segment_name :: Lens' Segment Text
segment_pattern :: Lens' Segment Text

Documentation

data Segment Source #

This structure contains information about one audience segment. You can use segments in your experiments and launches to narrow the user sessions used for experiment or launch to only the user sessions that match one or more criteria.

See: newSegment smart constructor.

Constructors

Segment'

Fields

description :: Maybe Text
The customer-created description for this segment.
experimentCount :: Maybe Integer
The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.
launchCount :: Maybe Integer
The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.
tags :: Maybe (HashMap Text Text)
The list of tag keys and values associated with this launch.
arn :: Text
The ARN of the segment.
createdTime :: POSIX
The date and time that this segment was created.
lastUpdatedTime :: POSIX
The date and time that this segment was most recently updated.
name :: Text
The name of the segment.
pattern' :: Text
The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see Segment rule pattern syntax.

Instances

Instances details

FromJSON Segment Source #
Instance details Defined in Amazonka.Evidently.Types.Segment Methods parseJSON :: Value -> Parser Segment # parseJSONList :: Value -> Parser [Segment] #
Generic Segment Source #
Instance details Defined in Amazonka.Evidently.Types.Segment Associated Types type Rep Segment :: Type -> Type # Methods from :: Segment -> Rep Segment x # to :: Rep Segment x -> Segment #
Read Segment Source #
Instance details Defined in Amazonka.Evidently.Types.Segment Methods readsPrec :: Int -> ReadS Segment # readList :: ReadS [Segment] # readPrec :: ReadPrec Segment # readListPrec :: ReadPrec [Segment] #
Show Segment Source #
Instance details Defined in Amazonka.Evidently.Types.Segment Methods showsPrec :: Int -> Segment -> ShowS # show :: Segment -> String # showList :: [Segment] -> ShowS #
NFData Segment Source #
Instance details Defined in Amazonka.Evidently.Types.Segment Methods rnf :: Segment -> () #
Eq Segment Source #
Instance details Defined in Amazonka.Evidently.Types.Segment Methods (==) :: Segment -> Segment -> Bool # (/=) :: Segment -> Segment -> Bool #
Hashable Segment Source #
Instance details Defined in Amazonka.Evidently.Types.Segment Methods hashWithSalt :: Int -> Segment -> Int # hash :: Segment -> Int #
type Rep Segment Source #
Instance details Defined in Amazonka.Evidently.Types.Segment type Rep Segment = D1 ('MetaData "Segment" "Amazonka.Evidently.Types.Segment" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "Segment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "experimentCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "launchCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "createdTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :: (S1 ('MetaSel ('Just "lastUpdatedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "pattern'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newSegment Source #

Arguments

:: Text	`$sel:arn:Segment'`
-> UTCTime	`$sel:createdTime:Segment'`
-> UTCTime	`$sel:lastUpdatedTime:Segment'`
-> Text	`$sel:name:Segment'`
-> Text	`$sel:pattern':Segment'`
-> Segment

Create a value of Segment 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:description:Segment', segment_description - The customer-created description for this segment.

$sel:experimentCount:Segment', segment_experimentCount - The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.

$sel:launchCount:Segment', segment_launchCount - The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.

$sel:tags:Segment', segment_tags - The list of tag keys and values associated with this launch.

$sel:arn:Segment', segment_arn - The ARN of the segment.

$sel:createdTime:Segment', segment_createdTime - The date and time that this segment was created.

$sel:lastUpdatedTime:Segment', segment_lastUpdatedTime - The date and time that this segment was most recently updated.

$sel:name:Segment', segment_name - The name of the segment.

$sel:pattern':Segment', segment_pattern - The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see Segment rule pattern syntax.

segment_description :: Lens' Segment (Maybe Text) Source #

The customer-created description for this segment.

segment_experimentCount :: Lens' Segment (Maybe Integer) Source #

The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.

segment_launchCount :: Lens' Segment (Maybe Integer) Source #

The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.

segment_tags :: Lens' Segment (Maybe (HashMap Text Text)) Source #

The list of tag keys and values associated with this launch.

segment_arn :: Lens' Segment Text Source #

The ARN of the segment.

segment_createdTime :: Lens' Segment UTCTime Source #

The date and time that this segment was created.

segment_lastUpdatedTime :: Lens' Segment UTCTime Source #

The date and time that this segment was most recently updated.

segment_name :: Lens' Segment Text Source #

The name of the segment.

segment_pattern :: Lens' Segment Text Source #

The pattern that defines the attributes to use to evalute whether a user session will be in the segment. For more information about the pattern syntax, see Segment rule pattern syntax.