Amazonka.Pinpoint.Types.WriteSegmentRequest

Documentation

data WriteSegmentRequest

Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.

See: newWriteSegmentRequest smart constructor.

Constructors

WriteSegmentRequest'

Fields

• dimensions :: Maybe SegmentDimensions

  The criteria that define the dimensions for the segment.

• name :: Maybe Text

  The name of the segment.

• segmentGroups :: Maybe SegmentGroupList

  The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

• tags :: Maybe (HashMap Text Text)

  A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.

Instances

ToJSON WriteSegmentRequest

Defined in Amazonka.Pinpoint.Types.WriteSegmentRequest

Methods

toJSON :: WriteSegmentRequest -> Value

toEncoding :: WriteSegmentRequest -> Encoding

toJSONList :: [WriteSegmentRequest] -> Value

toEncodingList :: [WriteSegmentRequest] -> Encoding

Generic WriteSegmentRequest

Defined in Amazonka.Pinpoint.Types.WriteSegmentRequest

Associated Types

type Rep WriteSegmentRequest :: Type -> Type

Methods

from :: WriteSegmentRequest -> Rep WriteSegmentRequest x

to :: Rep WriteSegmentRequest x -> WriteSegmentRequest

Read WriteSegmentRequest

Defined in Amazonka.Pinpoint.Types.WriteSegmentRequest

Methods

readsPrec :: Int -> ReadS WriteSegmentRequest

readList :: ReadS [WriteSegmentRequest]

readPrec :: ReadPrec WriteSegmentRequest

readListPrec :: ReadPrec [WriteSegmentRequest]

Show WriteSegmentRequest

Defined in Amazonka.Pinpoint.Types.WriteSegmentRequest

Methods

showsPrec :: Int -> WriteSegmentRequest -> ShowS

show :: WriteSegmentRequest -> String

showList :: [WriteSegmentRequest] -> ShowS

NFData WriteSegmentRequest

Defined in Amazonka.Pinpoint.Types.WriteSegmentRequest

Methods

rnf :: WriteSegmentRequest -> ()

Eq WriteSegmentRequest

Defined in Amazonka.Pinpoint.Types.WriteSegmentRequest

Methods

(==) :: WriteSegmentRequest -> WriteSegmentRequest -> Bool

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

Hashable WriteSegmentRequest

Defined in Amazonka.Pinpoint.Types.WriteSegmentRequest

Methods

hashWithSalt :: Int -> WriteSegmentRequest -> Int

hash :: WriteSegmentRequest -> Int

type Rep WriteSegmentRequest

Defined in Amazonka.Pinpoint.Types.WriteSegmentRequest

type Rep WriteSegmentRequest = D1 ('MetaData "WriteSegmentRequest" "Amazonka.Pinpoint.Types.WriteSegmentRequest" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "WriteSegmentRequest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SegmentDimensions)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "segmentGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SegmentGroupList)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))

newWriteSegmentRequest :: WriteSegmentRequest

Create a value of WriteSegmentRequest 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:WriteSegmentRequest', writeSegmentRequest_dimensions - The criteria that define the dimensions for the segment.

$sel:name:WriteSegmentRequest', writeSegmentRequest_name - The name of the segment.

$sel:segmentGroups:WriteSegmentRequest', writeSegmentRequest_segmentGroups - The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

$sel:tags:WriteSegmentRequest', writeSegmentRequest_tags - A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.

writeSegmentRequest_dimensions :: Lens' WriteSegmentRequest (Maybe SegmentDimensions)

The criteria that define the dimensions for the segment.

writeSegmentRequest_name :: Lens' WriteSegmentRequest (Maybe Text)

The name of the segment.

writeSegmentRequest_segmentGroups :: Lens' WriteSegmentRequest (Maybe SegmentGroupList)

The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

writeSegmentRequest_tags :: Lens' WriteSegmentRequest (Maybe (HashMap Text Text))

A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.