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

Description

Synopsis

data AttributeDimension = AttributeDimension' {
- attributeType :: Maybe AttributeType
- values :: [Text]
}
newAttributeDimension :: AttributeDimension
attributeDimension_attributeType :: Lens' AttributeDimension (Maybe AttributeType)
attributeDimension_values :: Lens' AttributeDimension [Text]

Documentation

data AttributeDimension Source #

Specifies attribute-based criteria for including or excluding endpoints from a segment.

See: newAttributeDimension smart constructor.

Constructors

AttributeDimension'

Fields

attributeType :: Maybe AttributeType
The type of segment dimension to use. Valid values are:
INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
values :: [Text]
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

Instances

Instances details

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

newAttributeDimension :: AttributeDimension Source #

Create a value of AttributeDimension 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:attributeType:AttributeDimension', attributeDimension_attributeType - The type of segment dimension to use. Valid values are:

INCLUSIVE - endpoints that have attributes matching the values are included in the segment.

EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.

CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.

BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.

AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.

ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.

BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

$sel:values:AttributeDimension', attributeDimension_values - The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

attributeDimension_attributeType :: Lens' AttributeDimension (Maybe AttributeType) Source #

The type of segment dimension to use. Valid values are: