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.Pinpoint.Types.SegmentGroup

Description

Synopsis

Documentation

data SegmentGroup Source #

Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.

See: newSegmentGroup smart constructor.

Constructors

SegmentGroup'

Fields

dimensions :: Maybe [SegmentDimensions]
An array that defines the dimensions for the segment.
sourceSegments :: Maybe [SegmentReference]
The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
sourceType :: Maybe SourceType
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
type' :: Maybe Type
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

Instances

Instances details

FromJSON SegmentGroup Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentGroup Methods parseJSON :: Value -> Parser SegmentGroup # parseJSONList :: Value -> Parser [SegmentGroup] #
ToJSON SegmentGroup Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentGroup Methods toJSON :: SegmentGroup -> Value # toEncoding :: SegmentGroup -> Encoding # toJSONList :: [SegmentGroup] -> Value # toEncodingList :: [SegmentGroup] -> Encoding #
Generic SegmentGroup Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentGroup Associated Types type Rep SegmentGroup :: Type -> Type # Methods from :: SegmentGroup -> Rep SegmentGroup x # to :: Rep SegmentGroup x -> SegmentGroup #
Read SegmentGroup Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentGroup Methods readsPrec :: Int -> ReadS SegmentGroup # readList :: ReadS [SegmentGroup] # readPrec :: ReadPrec SegmentGroup # readListPrec :: ReadPrec [SegmentGroup] #
Show SegmentGroup Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentGroup Methods showsPrec :: Int -> SegmentGroup -> ShowS # show :: SegmentGroup -> String # showList :: [SegmentGroup] -> ShowS #
NFData SegmentGroup Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentGroup Methods rnf :: SegmentGroup -> () #
Eq SegmentGroup Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentGroup Methods (==) :: SegmentGroup -> SegmentGroup -> Bool # (/=) :: SegmentGroup -> SegmentGroup -> Bool #
Hashable SegmentGroup Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentGroup Methods hashWithSalt :: Int -> SegmentGroup -> Int # hash :: SegmentGroup -> Int #
type Rep SegmentGroup Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentGroup type Rep SegmentGroup = D1 ('MetaData "SegmentGroup" "Amazonka.Pinpoint.Types.SegmentGroup" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "SegmentGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SegmentDimensions])) :: S1 ('MetaSel ('Just "sourceSegments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SegmentReference]))) :: (S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceType)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Type)))))

newSegmentGroup :: SegmentGroup Source #

Create a value of SegmentGroup 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:dimensions:SegmentGroup', segmentGroup_dimensions - An array that defines the dimensions for the segment.

$sel:sourceSegments:SegmentGroup', segmentGroup_sourceSegments - The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

$sel:sourceType:SegmentGroup', segmentGroup_sourceType - Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

$sel:type':SegmentGroup', segmentGroup_type - Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

segmentGroup_dimensions :: Lens' SegmentGroup (Maybe [SegmentDimensions]) Source #

An array that defines the dimensions for the segment.

segmentGroup_sourceSegments :: Lens' SegmentGroup (Maybe [SegmentReference]) Source #

The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

segmentGroup_sourceType :: Lens' SegmentGroup (Maybe SourceType) Source #

Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

segmentGroup_type :: Lens' SegmentGroup (Maybe Type) Source #

Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.