Amazonka.Pinpoint.Types.SetDimension

Documentation

data SetDimension

Specifies the dimension type and values for a segment dimension.

See: newSetDimension smart constructor.

Constructors

SetDimension'

Fields

• dimensionType :: Maybe DimensionType

  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

• values :: [Text]

  The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

Instances

FromJSON SetDimension

Defined in Amazonka.Pinpoint.Types.SetDimension

Methods

parseJSON :: Value -> Parser SetDimension

parseJSONList :: Value -> Parser [SetDimension]

ToJSON SetDimension

Defined in Amazonka.Pinpoint.Types.SetDimension

Methods

toJSON :: SetDimension -> Value

toEncoding :: SetDimension -> Encoding

toJSONList :: [SetDimension] -> Value

toEncodingList :: [SetDimension] -> Encoding

Generic SetDimension

Defined in Amazonka.Pinpoint.Types.SetDimension

Associated Types

type Rep SetDimension :: Type -> Type

Methods

from :: SetDimension -> Rep SetDimension x

to :: Rep SetDimension x -> SetDimension

Read SetDimension

Defined in Amazonka.Pinpoint.Types.SetDimension

Methods

readsPrec :: Int -> ReadS SetDimension

readList :: ReadS [SetDimension]

readPrec :: ReadPrec SetDimension

readListPrec :: ReadPrec [SetDimension]

Show SetDimension

Defined in Amazonka.Pinpoint.Types.SetDimension

Methods

showsPrec :: Int -> SetDimension -> ShowS

show :: SetDimension -> String

showList :: [SetDimension] -> ShowS

NFData SetDimension

Defined in Amazonka.Pinpoint.Types.SetDimension

Methods

rnf :: SetDimension -> ()

Eq SetDimension

Defined in Amazonka.Pinpoint.Types.SetDimension

Methods

(==) :: SetDimension -> SetDimension -> Bool

(/=) :: SetDimension -> SetDimension -> Bool

Hashable SetDimension

Defined in Amazonka.Pinpoint.Types.SetDimension

Methods

hashWithSalt :: Int -> SetDimension -> Int

hash :: SetDimension -> Int

type Rep SetDimension

Defined in Amazonka.Pinpoint.Types.SetDimension

type Rep SetDimension = D1 ('MetaData "SetDimension" "Amazonka.Pinpoint.Types.SetDimension" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "SetDimension'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dimensionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DimensionType)) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newSetDimension :: SetDimension

Create a value of SetDimension 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:dimensionType:SetDimension', setDimension_dimensionType - The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

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

setDimension_dimensionType :: Lens' SetDimension (Maybe DimensionType)

The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

setDimension_values :: Lens' SetDimension [Text]

The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.