libZSservicesZSamazonka-pinpointZSamazonka-pinpoint
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Pinpoint.Types

Contents

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

API version 2016-12-01 of the Amazon Pinpoint SDK configuration.

Errors

_PayloadTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Provides information about an API request or response.

_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Provides information about an API request or response.

_ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Provides information about an API request or response.

_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Provides information about an API request or response.

_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Provides information about an API request or response.

_InternalServerErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Provides information about an API request or response.

_MethodNotAllowedException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Provides information about an API request or response.

_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Provides information about an API request or response.

Action

newtype Action Source #

Constructors

Action' 

Fields

Bundled Patterns

pattern Action_DEEP_LINK :: Action 
pattern Action_OPEN_APP :: Action 
pattern Action_URL :: Action 

Instances

Instances details
Eq Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

Methods

(==) :: Action -> Action -> Bool #

(/=) :: Action -> Action -> Bool #

Ord Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

Read Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

Show Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

Generic Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

Associated Types

type Rep Action :: Type -> Type #

Methods

from :: Action -> Rep Action x #

to :: Rep Action x -> Action #

NFData Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

Methods

rnf :: Action -> () #

Hashable Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

Methods

hashWithSalt :: Int -> Action -> Int #

hash :: Action -> Int #

ToJSON Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

ToJSONKey Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

FromJSON Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

FromJSONKey Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

ToLog Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

ToHeader Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

Methods

toHeader :: HeaderName -> Action -> [Header] #

ToQuery Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

FromXML Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

ToXML Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

Methods

toXML :: Action -> XML #

ToByteString Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

Methods

toBS :: Action -> ByteString #

FromText Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

ToText Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

Methods

toText :: Action -> Text #

type Rep Action Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Action

type Rep Action = D1 ('MetaData "Action" "Amazonka.Pinpoint.Types.Action" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "Action'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Alignment

newtype Alignment Source #

Constructors

Alignment' 

Fields

Bundled Patterns

pattern Alignment_CENTER :: Alignment 
pattern Alignment_LEFT :: Alignment 
pattern Alignment_RIGHT :: Alignment 

Instances

Instances details
Eq Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

Ord Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

Read Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

Show Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

Generic Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

Associated Types

type Rep Alignment :: Type -> Type #

NFData Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

Methods

rnf :: Alignment -> () #

Hashable Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

ToJSON Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

ToJSONKey Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

FromJSON Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

FromJSONKey Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

ToLog Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

ToHeader Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

ToQuery Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

FromXML Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

ToXML Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

Methods

toXML :: Alignment -> XML #

ToByteString Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

Methods

toBS :: Alignment -> ByteString #

FromText Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

ToText Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

Methods

toText :: Alignment -> Text #

type Rep Alignment Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Alignment

type Rep Alignment = D1 ('MetaData "Alignment" "Amazonka.Pinpoint.Types.Alignment" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "Alignment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAlignment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AttributeType

newtype AttributeType Source #

Constructors

AttributeType' 

Instances

Instances details
Eq AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

Ord AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

Read AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

Show AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

Generic AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

Associated Types

type Rep AttributeType :: Type -> Type #

NFData AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

Methods

rnf :: AttributeType -> () #

Hashable AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

ToJSON AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

ToJSONKey AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

FromJSON AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

FromJSONKey AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

ToLog AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

ToHeader AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

ToQuery AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

FromXML AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

ToXML AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

Methods

toXML :: AttributeType -> XML #

ToByteString AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

FromText AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

ToText AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

Methods

toText :: AttributeType -> Text #

type Rep AttributeType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeType

type Rep AttributeType = D1 ('MetaData "AttributeType" "Amazonka.Pinpoint.Types.AttributeType" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "AttributeType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAttributeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ButtonAction

newtype ButtonAction Source #

Constructors

ButtonAction' 

Instances

Instances details
Eq ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

Ord ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

Read ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

Show ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

Generic ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

Associated Types

type Rep ButtonAction :: Type -> Type #

NFData ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

Methods

rnf :: ButtonAction -> () #

Hashable ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

ToJSON ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

ToJSONKey ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

FromJSON ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

FromJSONKey ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

ToLog ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

ToHeader ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

ToQuery ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

FromXML ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

ToXML ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

Methods

toXML :: ButtonAction -> XML #

ToByteString ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

FromText ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

ToText ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

Methods

toText :: ButtonAction -> Text #

type Rep ButtonAction Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ButtonAction

type Rep ButtonAction = D1 ('MetaData "ButtonAction" "Amazonka.Pinpoint.Types.ButtonAction" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "ButtonAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromButtonAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CampaignStatus

newtype CampaignStatus Source #

Constructors

CampaignStatus' 

Instances

Instances details
Eq CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

Ord CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

Read CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

Show CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

Generic CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

Associated Types

type Rep CampaignStatus :: Type -> Type #

NFData CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

Methods

rnf :: CampaignStatus -> () #

Hashable CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

ToJSON CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

ToJSONKey CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

FromJSON CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

FromJSONKey CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

ToLog CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

ToHeader CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

ToQuery CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

FromXML CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

ToXML CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

Methods

toXML :: CampaignStatus -> XML #

ToByteString CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

FromText CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

ToText CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

type Rep CampaignStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignStatus

type Rep CampaignStatus = D1 ('MetaData "CampaignStatus" "Amazonka.Pinpoint.Types.CampaignStatus" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "CampaignStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCampaignStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ChannelType

newtype ChannelType Source #

Constructors

ChannelType' 

Instances

Instances details
Eq ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

Ord ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

Read ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

Show ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

Generic ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

Associated Types

type Rep ChannelType :: Type -> Type #

NFData ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

Methods

rnf :: ChannelType -> () #

Hashable ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

ToJSON ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

ToJSONKey ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

FromJSON ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

FromJSONKey ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

ToLog ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

ToHeader ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

ToQuery ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

FromXML ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

ToXML ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

Methods

toXML :: ChannelType -> XML #

ToByteString ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

FromText ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

ToText ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

Methods

toText :: ChannelType -> Text #

type Rep ChannelType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelType

type Rep ChannelType = D1 ('MetaData "ChannelType" "Amazonka.Pinpoint.Types.ChannelType" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "ChannelType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromChannelType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DefinitionFormat

newtype DefinitionFormat Source #

Instances

Instances details
Eq DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

Ord DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

Read DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

Show DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

Generic DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

Associated Types

type Rep DefinitionFormat :: Type -> Type #

NFData DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

Methods

rnf :: DefinitionFormat -> () #

Hashable DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

ToJSON DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

ToJSONKey DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

FromJSON DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

FromJSONKey DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

ToLog DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

ToHeader DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

ToQuery DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

FromXML DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

ToXML DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

ToByteString DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

FromText DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

ToText DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

type Rep DefinitionFormat Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefinitionFormat

type Rep DefinitionFormat = D1 ('MetaData "DefinitionFormat" "Amazonka.Pinpoint.Types.DefinitionFormat" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "DefinitionFormat'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDefinitionFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DeliveryStatus

newtype DeliveryStatus Source #

Constructors

DeliveryStatus' 

Instances

Instances details
Eq DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

Ord DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

Read DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

Show DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

Generic DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

Associated Types

type Rep DeliveryStatus :: Type -> Type #

NFData DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

Methods

rnf :: DeliveryStatus -> () #

Hashable DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

ToJSON DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

ToJSONKey DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

FromJSON DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

FromJSONKey DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

ToLog DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

ToHeader DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

ToQuery DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

FromXML DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

ToXML DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

Methods

toXML :: DeliveryStatus -> XML #

ToByteString DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

FromText DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

ToText DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

type Rep DeliveryStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DeliveryStatus

type Rep DeliveryStatus = D1 ('MetaData "DeliveryStatus" "Amazonka.Pinpoint.Types.DeliveryStatus" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "DeliveryStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDeliveryStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DimensionType

newtype DimensionType Source #

Constructors

DimensionType' 

Instances

Instances details
Eq DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

Ord DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

Read DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

Show DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

Generic DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

Associated Types

type Rep DimensionType :: Type -> Type #

NFData DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

Methods

rnf :: DimensionType -> () #

Hashable DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

ToJSON DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

ToJSONKey DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

FromJSON DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

FromJSONKey DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

ToLog DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

ToHeader DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

ToQuery DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

FromXML DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

ToXML DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

Methods

toXML :: DimensionType -> XML #

ToByteString DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

FromText DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

ToText DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

Methods

toText :: DimensionType -> Text #

type Rep DimensionType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DimensionType

type Rep DimensionType = D1 ('MetaData "DimensionType" "Amazonka.Pinpoint.Types.DimensionType" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "DimensionType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDimensionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Duration

newtype Duration Source #

Constructors

Duration' 

Fields

Bundled Patterns

pattern Duration_DAY_14 :: Duration 
pattern Duration_DAY_30 :: Duration 
pattern Duration_DAY_7 :: Duration 
pattern Duration_HR_24 :: Duration 

Instances

Instances details
Eq Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

Ord Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

Read Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

Show Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

Generic Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

Associated Types

type Rep Duration :: Type -> Type #

Methods

from :: Duration -> Rep Duration x #

to :: Rep Duration x -> Duration #

NFData Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

Methods

rnf :: Duration -> () #

Hashable Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

Methods

hashWithSalt :: Int -> Duration -> Int #

hash :: Duration -> Int #

ToJSON Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

ToJSONKey Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

FromJSON Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

FromJSONKey Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

ToLog Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

ToHeader Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

Methods

toHeader :: HeaderName -> Duration -> [Header] #

ToQuery Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

FromXML Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

ToXML Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

Methods

toXML :: Duration -> XML #

ToByteString Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

Methods

toBS :: Duration -> ByteString #

FromText Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

ToText Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

Methods

toText :: Duration -> Text #

type Rep Duration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Duration

type Rep Duration = D1 ('MetaData "Duration" "Amazonka.Pinpoint.Types.Duration" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "Duration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EndpointTypesElement

newtype EndpointTypesElement Source #

Instances

Instances details
Eq EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

Ord EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

Read EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

Show EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

Generic EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

Associated Types

type Rep EndpointTypesElement :: Type -> Type #

NFData EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

Methods

rnf :: EndpointTypesElement -> () #

Hashable EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

ToJSON EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

ToJSONKey EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

FromJSON EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

FromJSONKey EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

ToLog EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

ToHeader EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

ToQuery EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

FromXML EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

ToXML EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

ToByteString EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

FromText EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

ToText EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

type Rep EndpointTypesElement Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointTypesElement

type Rep EndpointTypesElement = D1 ('MetaData "EndpointTypesElement" "Amazonka.Pinpoint.Types.EndpointTypesElement" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "EndpointTypesElement'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEndpointTypesElement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

FilterType

newtype FilterType Source #

Constructors

FilterType' 

Fields

Bundled Patterns

pattern FilterType_ENDPOINT :: FilterType 
pattern FilterType_SYSTEM :: FilterType 

Instances

Instances details
Eq FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

Ord FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

Read FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

Show FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

Generic FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

Associated Types

type Rep FilterType :: Type -> Type #

NFData FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

Methods

rnf :: FilterType -> () #

Hashable FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

ToJSON FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

ToJSONKey FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

FromJSON FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

FromJSONKey FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

ToLog FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

ToHeader FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

ToQuery FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

FromXML FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

ToXML FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

Methods

toXML :: FilterType -> XML #

ToByteString FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

FromText FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

ToText FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

Methods

toText :: FilterType -> Text #

type Rep FilterType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.FilterType

type Rep FilterType = D1 ('MetaData "FilterType" "Amazonka.Pinpoint.Types.FilterType" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "FilterType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromFilterType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Frequency

newtype Frequency Source #

Constructors

Frequency' 

Fields

Instances

Instances details
Eq Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

Ord Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

Read Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

Show Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

Generic Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

Associated Types

type Rep Frequency :: Type -> Type #

NFData Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

Methods

rnf :: Frequency -> () #

Hashable Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

ToJSON Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

ToJSONKey Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

FromJSON Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

FromJSONKey Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

ToLog Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

ToHeader Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

ToQuery Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

FromXML Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

ToXML Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

Methods

toXML :: Frequency -> XML #

ToByteString Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

Methods

toBS :: Frequency -> ByteString #

FromText Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

ToText Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

Methods

toText :: Frequency -> Text #

type Rep Frequency Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Frequency

type Rep Frequency = D1 ('MetaData "Frequency" "Amazonka.Pinpoint.Types.Frequency" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "Frequency'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Include

newtype Include Source #

Constructors

Include' 

Fields

Bundled Patterns

pattern Include_ALL :: Include 
pattern Include_ANY :: Include 
pattern Include_NONE :: Include 

Instances

Instances details
Eq Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

Methods

(==) :: Include -> Include -> Bool #

(/=) :: Include -> Include -> Bool #

Ord Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

Read Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

Show Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

Generic Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

Associated Types

type Rep Include :: Type -> Type #

Methods

from :: Include -> Rep Include x #

to :: Rep Include x -> Include #

NFData Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

Methods

rnf :: Include -> () #

Hashable Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

Methods

hashWithSalt :: Int -> Include -> Int #

hash :: Include -> Int #

ToJSON Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

ToJSONKey Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

FromJSON Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

FromJSONKey Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

ToLog Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

ToHeader Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

Methods

toHeader :: HeaderName -> Include -> [Header] #

ToQuery Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

FromXML Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

ToXML Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

Methods

toXML :: Include -> XML #

ToByteString Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

Methods

toBS :: Include -> ByteString #

FromText Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

ToText Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

Methods

toText :: Include -> Text #

type Rep Include Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Include

type Rep Include = D1 ('MetaData "Include" "Amazonka.Pinpoint.Types.Include" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "Include'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromInclude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

JobStatus

newtype JobStatus Source #

Constructors

JobStatus' 

Fields

Instances

Instances details
Eq JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

Ord JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

Read JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

Show JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

Generic JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

Associated Types

type Rep JobStatus :: Type -> Type #

NFData JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

Methods

rnf :: JobStatus -> () #

Hashable JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

ToJSON JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

ToJSONKey JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

FromJSON JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

FromJSONKey JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

ToLog JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

ToHeader JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

ToQuery JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

FromXML JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

ToXML JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

Methods

toXML :: JobStatus -> XML #

ToByteString JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

Methods

toBS :: JobStatus -> ByteString #

FromText JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

ToText JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

Methods

toText :: JobStatus -> Text #

type Rep JobStatus Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JobStatus

type Rep JobStatus = D1 ('MetaData "JobStatus" "Amazonka.Pinpoint.Types.JobStatus" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "JobStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromJobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Layout

newtype Layout Source #

Constructors

Layout' 

Fields

Bundled Patterns

pattern Layout_BOTTOM_BANNER :: Layout 
pattern Layout_CAROUSEL :: Layout 
pattern Layout_MIDDLE_BANNER :: Layout 
pattern Layout_MOBILE_FEED :: Layout 
pattern Layout_OVERLAYS :: Layout 
pattern Layout_TOP_BANNER :: Layout 

Instances

Instances details
Eq Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

Methods

(==) :: Layout -> Layout -> Bool #

(/=) :: Layout -> Layout -> Bool #

Ord Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

Read Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

Show Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

Generic Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

Associated Types

type Rep Layout :: Type -> Type #

Methods

from :: Layout -> Rep Layout x #

to :: Rep Layout x -> Layout #

NFData Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

Methods

rnf :: Layout -> () #

Hashable Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

Methods

hashWithSalt :: Int -> Layout -> Int #

hash :: Layout -> Int #

ToJSON Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

ToJSONKey Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

FromJSON Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

FromJSONKey Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

ToLog Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

ToHeader Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

Methods

toHeader :: HeaderName -> Layout -> [Header] #

ToQuery Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

FromXML Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

ToXML Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

Methods

toXML :: Layout -> XML #

ToByteString Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

Methods

toBS :: Layout -> ByteString #

FromText Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

ToText Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

Methods

toText :: Layout -> Text #

type Rep Layout Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Layout

type Rep Layout = D1 ('MetaData "Layout" "Amazonka.Pinpoint.Types.Layout" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "Layout'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromLayout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

MessageType

newtype MessageType Source #

Constructors

MessageType' 

Instances

Instances details
Eq MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

Ord MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

Read MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

Show MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

Generic MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

Associated Types

type Rep MessageType :: Type -> Type #

NFData MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

Methods

rnf :: MessageType -> () #

Hashable MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

ToJSON MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

ToJSONKey MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

FromJSON MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

FromJSONKey MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

ToLog MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

ToHeader MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

ToQuery MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

FromXML MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

ToXML MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

Methods

toXML :: MessageType -> XML #

ToByteString MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

FromText MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

ToText MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

Methods

toText :: MessageType -> Text #

type Rep MessageType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageType

type Rep MessageType = D1 ('MetaData "MessageType" "Amazonka.Pinpoint.Types.MessageType" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "MessageType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromMessageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Mode

newtype Mode Source #

Constructors

Mode' 

Fields

Bundled Patterns

pattern Mode_DELIVERY :: Mode 
pattern Mode_FILTER :: Mode 

Instances

Instances details
Eq Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

Methods

(==) :: Mode -> Mode -> Bool #

(/=) :: Mode -> Mode -> Bool #

Ord Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

Methods

compare :: Mode -> Mode -> Ordering #

(<) :: Mode -> Mode -> Bool #

(<=) :: Mode -> Mode -> Bool #

(>) :: Mode -> Mode -> Bool #

(>=) :: Mode -> Mode -> Bool #

max :: Mode -> Mode -> Mode #

min :: Mode -> Mode -> Mode #

Read Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

Show Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

Methods

showsPrec :: Int -> Mode -> ShowS #

show :: Mode -> String #

showList :: [Mode] -> ShowS #

Generic Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

Associated Types

type Rep Mode :: Type -> Type #

Methods

from :: Mode -> Rep Mode x #

to :: Rep Mode x -> Mode #

NFData Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

Methods

rnf :: Mode -> () #

Hashable Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

Methods

hashWithSalt :: Int -> Mode -> Int #

hash :: Mode -> Int #

ToJSON Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

ToJSONKey Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

FromJSON Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

FromJSONKey Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

ToLog Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

ToHeader Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

Methods

toHeader :: HeaderName -> Mode -> [Header] #

ToQuery Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

Methods

toQuery :: Mode -> QueryString #

FromXML Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

Methods

parseXML :: [Node] -> Either String Mode #

ToXML Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

Methods

toXML :: Mode -> XML #

ToByteString Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

Methods

toBS :: Mode -> ByteString #

FromText Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

ToText Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

Methods

toText :: Mode -> Text #

type Rep Mode Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Mode

type Rep Mode = D1 ('MetaData "Mode" "Amazonka.Pinpoint.Types.Mode" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "Mode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Operator

newtype Operator Source #

Constructors

Operator' 

Fields

Bundled Patterns

pattern Operator_ALL :: Operator 
pattern Operator_ANY :: Operator 

Instances

Instances details
Eq Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

Ord Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

Read Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

Show Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

Generic Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

Associated Types

type Rep Operator :: Type -> Type #

Methods

from :: Operator -> Rep Operator x #

to :: Rep Operator x -> Operator #

NFData Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

Methods

rnf :: Operator -> () #

Hashable Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

Methods

hashWithSalt :: Int -> Operator -> Int #

hash :: Operator -> Int #

ToJSON Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

ToJSONKey Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

FromJSON Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

FromJSONKey Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

ToLog Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

ToHeader Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

Methods

toHeader :: HeaderName -> Operator -> [Header] #

ToQuery Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

FromXML Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

ToXML Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

Methods

toXML :: Operator -> XML #

ToByteString Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

Methods

toBS :: Operator -> ByteString #

FromText Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

ToText Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

Methods

toText :: Operator -> Text #

type Rep Operator Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Operator

type Rep Operator = D1 ('MetaData "Operator" "Amazonka.Pinpoint.Types.Operator" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "Operator'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromOperator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

RecencyType

newtype RecencyType Source #

Constructors

RecencyType' 

Bundled Patterns

pattern RecencyType_ACTIVE :: RecencyType 
pattern RecencyType_INACTIVE :: RecencyType 

Instances

Instances details
Eq RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

Ord RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

Read RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

Show RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

Generic RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

Associated Types

type Rep RecencyType :: Type -> Type #

NFData RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

Methods

rnf :: RecencyType -> () #

Hashable RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

ToJSON RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

ToJSONKey RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

FromJSON RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

FromJSONKey RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

ToLog RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

ToHeader RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

ToQuery RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

FromXML RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

ToXML RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

Methods

toXML :: RecencyType -> XML #

ToByteString RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

FromText RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

ToText RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

Methods

toText :: RecencyType -> Text #

type Rep RecencyType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyType

type Rep RecencyType = D1 ('MetaData "RecencyType" "Amazonka.Pinpoint.Types.RecencyType" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "RecencyType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromRecencyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SegmentType

newtype SegmentType Source #

Constructors

SegmentType' 

Bundled Patterns

pattern SegmentType_DIMENSIONAL :: SegmentType 
pattern SegmentType_IMPORT :: SegmentType 

Instances

Instances details
Eq SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

Ord SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

Read SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

Show SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

Generic SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

Associated Types

type Rep SegmentType :: Type -> Type #

NFData SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

Methods

rnf :: SegmentType -> () #

Hashable SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

ToJSON SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

ToJSONKey SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

FromJSON SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

FromJSONKey SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

ToLog SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

ToHeader SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

ToQuery SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

FromXML SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

ToXML SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

Methods

toXML :: SegmentType -> XML #

ToByteString SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

FromText SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

ToText SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

Methods

toText :: SegmentType -> Text #

type Rep SegmentType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentType

type Rep SegmentType = D1 ('MetaData "SegmentType" "Amazonka.Pinpoint.Types.SegmentType" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "SegmentType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSegmentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SourceType

newtype SourceType Source #

Constructors

SourceType' 

Fields

Bundled Patterns

pattern SourceType_ALL :: SourceType 
pattern SourceType_ANY :: SourceType 
pattern SourceType_NONE :: SourceType 

Instances

Instances details
Eq SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

Ord SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

Read SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

Show SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

Generic SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

Associated Types

type Rep SourceType :: Type -> Type #

NFData SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

Methods

rnf :: SourceType -> () #

Hashable SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

ToJSON SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

ToJSONKey SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

FromJSON SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

FromJSONKey SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

ToLog SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

ToHeader SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

ToQuery SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

FromXML SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

ToXML SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

Methods

toXML :: SourceType -> XML #

ToByteString SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

FromText SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

ToText SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

Methods

toText :: SourceType -> Text #

type Rep SourceType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SourceType

type Rep SourceType = D1 ('MetaData "SourceType" "Amazonka.Pinpoint.Types.SourceType" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "SourceType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

State

newtype State Source #

Constructors

State' 

Fields

Bundled Patterns

pattern State_ACTIVE :: State 
pattern State_CANCELLED :: State 
pattern State_CLOSED :: State 
pattern State_COMPLETED :: State 
pattern State_DRAFT :: State 
pattern State_PAUSED :: State 

Instances

Instances details
Eq State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

Methods

(==) :: State -> State -> Bool #

(/=) :: State -> State -> Bool #

Ord State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

Methods

compare :: State -> State -> Ordering #

(<) :: State -> State -> Bool #

(<=) :: State -> State -> Bool #

(>) :: State -> State -> Bool #

(>=) :: State -> State -> Bool #

max :: State -> State -> State #

min :: State -> State -> State #

Read State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

Show State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

Methods

showsPrec :: Int -> State -> ShowS #

show :: State -> String #

showList :: [State] -> ShowS #

Generic State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

Associated Types

type Rep State :: Type -> Type #

Methods

from :: State -> Rep State x #

to :: Rep State x -> State #

NFData State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

Methods

rnf :: State -> () #

Hashable State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

Methods

hashWithSalt :: Int -> State -> Int #

hash :: State -> Int #

ToJSON State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

ToJSONKey State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

FromJSON State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

FromJSONKey State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

ToLog State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

ToHeader State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

Methods

toHeader :: HeaderName -> State -> [Header] #

ToQuery State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

Methods

toQuery :: State -> QueryString #

FromXML State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

Methods

parseXML :: [Node] -> Either String State #

ToXML State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

Methods

toXML :: State -> XML #

ToByteString State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

Methods

toBS :: State -> ByteString #

FromText State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

ToText State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

Methods

toText :: State -> Text #

type Rep State Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.State

type Rep State = D1 ('MetaData "State" "Amazonka.Pinpoint.Types.State" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "State'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

TemplateType

newtype TemplateType Source #

Constructors

TemplateType' 

Instances

Instances details
Eq TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

Ord TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

Read TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

Show TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

Generic TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

Associated Types

type Rep TemplateType :: Type -> Type #

NFData TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

Methods

rnf :: TemplateType -> () #

Hashable TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

ToJSON TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

ToJSONKey TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

FromJSON TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

FromJSONKey TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

ToLog TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

ToHeader TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

ToQuery TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

FromXML TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

ToXML TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

Methods

toXML :: TemplateType -> XML #

ToByteString TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

FromText TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

ToText TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

Methods

toText :: TemplateType -> Text #

type Rep TemplateType Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateType

type Rep TemplateType = D1 ('MetaData "TemplateType" "Amazonka.Pinpoint.Types.TemplateType" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "TemplateType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromTemplateType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Type

newtype Type Source #

Constructors

Type' 

Fields

Bundled Patterns

pattern Type_ALL :: Type 
pattern Type_ANY :: Type 
pattern Type_NONE :: Type 

Instances

Instances details
Eq Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

Methods

(==) :: Type -> Type -> Bool #

(/=) :: Type -> Type -> Bool #

Ord Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

Methods

compare :: Type -> Type -> Ordering #

(<) :: Type -> Type -> Bool #

(<=) :: Type -> Type -> Bool #

(>) :: Type -> Type -> Bool #

(>=) :: Type -> Type -> Bool #

max :: Type -> Type -> Type #

min :: Type -> Type -> Type #

Read Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

Show Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

Methods

showsPrec :: Int -> Type -> ShowS #

show :: Type -> String #

showList :: [Type] -> ShowS #

Generic Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

Associated Types

type Rep Type :: Type -> Type #

Methods

from :: Type -> Rep Type x #

to :: Rep Type x -> Type #

NFData Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

Methods

rnf :: Type -> () #

Hashable Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

Methods

hashWithSalt :: Int -> Type -> Int #

hash :: Type -> Int #

ToJSON Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

ToJSONKey Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

FromJSON Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

FromJSONKey Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

ToLog Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

ToHeader Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

Methods

toHeader :: HeaderName -> Type -> [Header] #

ToQuery Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

Methods

toQuery :: Type -> QueryString #

FromXML Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

Methods

parseXML :: [Node] -> Either String Type #

ToXML Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

Methods

toXML :: Type -> XML #

ToByteString Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

Methods

toBS :: Type -> ByteString #

FromText Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

ToText Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

Methods

toText :: Type -> Text #

type Rep Type Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Type

type Rep Type = D1 ('MetaData "Type" "Amazonka.Pinpoint.Types.Type" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'True) (C1 ('MetaCons "Type'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ADMChannelRequest

data ADMChannelRequest Source #

Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.

See: newADMChannelRequest smart constructor.

Constructors

ADMChannelRequest' 

Fields

  • enabled :: Maybe Bool

    Specifies whether to enable the ADM channel for the application.

  • clientSecret :: Text

    The Client Secret that you received from Amazon to send messages by using ADM.

  • clientId :: Text

    The Client ID that you received from Amazon to send messages by using ADM.

Instances

Instances details
Eq ADMChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMChannelRequest

Read ADMChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMChannelRequest

Show ADMChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMChannelRequest

Generic ADMChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMChannelRequest

Associated Types

type Rep ADMChannelRequest :: Type -> Type #

NFData ADMChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMChannelRequest

Methods

rnf :: ADMChannelRequest -> () #

Hashable ADMChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMChannelRequest

ToJSON ADMChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMChannelRequest

type Rep ADMChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMChannelRequest

type Rep ADMChannelRequest = D1 ('MetaData "ADMChannelRequest" "Amazonka.Pinpoint.Types.ADMChannelRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ADMChannelRequest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "clientSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newADMChannelRequest Source #

Create a value of ADMChannelRequest 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:enabled:ADMChannelRequest', aDMChannelRequest_enabled - Specifies whether to enable the ADM channel for the application.

$sel:clientSecret:ADMChannelRequest', aDMChannelRequest_clientSecret - The Client Secret that you received from Amazon to send messages by using ADM.

$sel:clientId:ADMChannelRequest', aDMChannelRequest_clientId - The Client ID that you received from Amazon to send messages by using ADM.

aDMChannelRequest_enabled :: Lens' ADMChannelRequest (Maybe Bool) Source #

Specifies whether to enable the ADM channel for the application.

aDMChannelRequest_clientSecret :: Lens' ADMChannelRequest Text Source #

The Client Secret that you received from Amazon to send messages by using ADM.

aDMChannelRequest_clientId :: Lens' ADMChannelRequest Text Source #

The Client ID that you received from Amazon to send messages by using ADM.

ADMChannelResponse

data ADMChannelResponse Source #

Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.

See: newADMChannelResponse smart constructor.

Constructors

ADMChannelResponse' 

Fields

Instances

Instances details
Eq ADMChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMChannelResponse

Read ADMChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMChannelResponse

Show ADMChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMChannelResponse

Generic ADMChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMChannelResponse

Associated Types

type Rep ADMChannelResponse :: Type -> Type #

NFData ADMChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMChannelResponse

Methods

rnf :: ADMChannelResponse -> () #

Hashable ADMChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMChannelResponse

FromJSON ADMChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMChannelResponse

type Rep ADMChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMChannelResponse

newADMChannelResponse Source #

Create a value of ADMChannelResponse 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:lastModifiedDate:ADMChannelResponse', aDMChannelResponse_lastModifiedDate - The date and time when the ADM channel was last modified.

$sel:enabled:ADMChannelResponse', aDMChannelResponse_enabled - Specifies whether the ADM channel is enabled for the application.

$sel:isArchived:ADMChannelResponse', aDMChannelResponse_isArchived - Specifies whether the ADM channel is archived.

$sel:applicationId:ADMChannelResponse', aDMChannelResponse_applicationId - The unique identifier for the application that the ADM channel applies to.

$sel:version:ADMChannelResponse', aDMChannelResponse_version - The current version of the ADM channel.

$sel:id:ADMChannelResponse', aDMChannelResponse_id - (Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.

$sel:creationDate:ADMChannelResponse', aDMChannelResponse_creationDate - The date and time when the ADM channel was enabled.

$sel:lastModifiedBy:ADMChannelResponse', aDMChannelResponse_lastModifiedBy - The user who last modified the ADM channel.

$sel:hasCredential:ADMChannelResponse', aDMChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.

$sel:platform:ADMChannelResponse', aDMChannelResponse_platform - The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.

aDMChannelResponse_lastModifiedDate :: Lens' ADMChannelResponse (Maybe Text) Source #

The date and time when the ADM channel was last modified.

aDMChannelResponse_enabled :: Lens' ADMChannelResponse (Maybe Bool) Source #

Specifies whether the ADM channel is enabled for the application.

aDMChannelResponse_isArchived :: Lens' ADMChannelResponse (Maybe Bool) Source #

Specifies whether the ADM channel is archived.

aDMChannelResponse_applicationId :: Lens' ADMChannelResponse (Maybe Text) Source #

The unique identifier for the application that the ADM channel applies to.

aDMChannelResponse_version :: Lens' ADMChannelResponse (Maybe Int) Source #

The current version of the ADM channel.

aDMChannelResponse_id :: Lens' ADMChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.

aDMChannelResponse_creationDate :: Lens' ADMChannelResponse (Maybe Text) Source #

The date and time when the ADM channel was enabled.

aDMChannelResponse_lastModifiedBy :: Lens' ADMChannelResponse (Maybe Text) Source #

The user who last modified the ADM channel.

aDMChannelResponse_hasCredential :: Lens' ADMChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

aDMChannelResponse_platform :: Lens' ADMChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.

ADMMessage

data ADMMessage Source #

Specifies the settings for a one-time message that's sent directly to an endpoint through the ADM (Amazon Device Messaging) channel.

See: newADMMessage smart constructor.

Constructors

ADMMessage' 

Fields

  • substitutions :: Maybe (HashMap Text [Text])

    The default message variables to use in the notification message. You can override the default variables with individual address variables.

  • expiresAfter :: Maybe Text

    The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.

  • md5 :: Maybe Text

    The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.

  • silentPush :: Maybe Bool

    Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

  • imageIconUrl :: Maybe Text

    The URL of the large icon image to display in the content view of the push notification.

  • rawContent :: Maybe Text

    The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

  • data' :: Maybe (HashMap Text Text)

    The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

  • smallImageIconUrl :: Maybe Text

    The URL of the small icon image to display in the status bar and the content view of the push notification.

  • body :: Maybe Text

    The body of the notification message.

  • url :: Maybe Text

    The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

  • sound :: Maybe Text

    The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

  • action :: Maybe Action

    The action to occur if the recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
  • imageUrl :: Maybe Text

    The URL of an image to display in the push notification.

  • consolidationKey :: Maybe Text

    An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.

  • title :: Maybe Text

    The title to display above the notification message on the recipient's device.

  • iconReference :: Maybe Text

    The icon image name of the asset saved in your app.

Instances

Instances details
Eq ADMMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMMessage

Read ADMMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMMessage

Show ADMMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMMessage

Generic ADMMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMMessage

Associated Types

type Rep ADMMessage :: Type -> Type #

NFData ADMMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMMessage

Methods

rnf :: ADMMessage -> () #

Hashable ADMMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMMessage

ToJSON ADMMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMMessage

type Rep ADMMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ADMMessage

type Rep ADMMessage = D1 ('MetaData "ADMMessage" "Amazonka.Pinpoint.Types.ADMMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ADMMessage'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "substitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "expiresAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "md5") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "silentPush") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "imageIconUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "rawContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "smallImageIconUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Action)))) :*: ((S1 ('MetaSel ('Just "imageUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "consolidationKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iconReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newADMMessage :: ADMMessage Source #

Create a value of ADMMessage 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:substitutions:ADMMessage', aDMMessage_substitutions - The default message variables to use in the notification message. You can override the default variables with individual address variables.

$sel:expiresAfter:ADMMessage', aDMMessage_expiresAfter - The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.

$sel:md5:ADMMessage', aDMMessage_md5 - The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.

$sel:silentPush:ADMMessage', aDMMessage_silentPush - Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

$sel:imageIconUrl:ADMMessage', aDMMessage_imageIconUrl - The URL of the large icon image to display in the content view of the push notification.

$sel:rawContent:ADMMessage', aDMMessage_rawContent - The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

$sel:data':ADMMessage', aDMMessage_data - The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

$sel:smallImageIconUrl:ADMMessage', aDMMessage_smallImageIconUrl - The URL of the small icon image to display in the status bar and the content view of the push notification.

$sel:body:ADMMessage', aDMMessage_body - The body of the notification message.

$sel:url:ADMMessage', aDMMessage_url - The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

$sel:sound:ADMMessage', aDMMessage_sound - The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

$sel:action:ADMMessage', aDMMessage_action - The action to occur if the recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

$sel:imageUrl:ADMMessage', aDMMessage_imageUrl - The URL of an image to display in the push notification.

$sel:consolidationKey:ADMMessage', aDMMessage_consolidationKey - An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.

$sel:title:ADMMessage', aDMMessage_title - The title to display above the notification message on the recipient's device.

$sel:iconReference:ADMMessage', aDMMessage_iconReference - The icon image name of the asset saved in your app.

aDMMessage_substitutions :: Lens' ADMMessage (Maybe (HashMap Text [Text])) Source #

The default message variables to use in the notification message. You can override the default variables with individual address variables.

aDMMessage_expiresAfter :: Lens' ADMMessage (Maybe Text) Source #

The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.

aDMMessage_md5 :: Lens' ADMMessage (Maybe Text) Source #

The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.

aDMMessage_silentPush :: Lens' ADMMessage (Maybe Bool) Source #

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

aDMMessage_imageIconUrl :: Lens' ADMMessage (Maybe Text) Source #

The URL of the large icon image to display in the content view of the push notification.

aDMMessage_rawContent :: Lens' ADMMessage (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

aDMMessage_data :: Lens' ADMMessage (Maybe (HashMap Text Text)) Source #

The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

aDMMessage_smallImageIconUrl :: Lens' ADMMessage (Maybe Text) Source #

The URL of the small icon image to display in the status bar and the content view of the push notification.

aDMMessage_body :: Lens' ADMMessage (Maybe Text) Source #

The body of the notification message.

aDMMessage_url :: Lens' ADMMessage (Maybe Text) Source #

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

aDMMessage_sound :: Lens' ADMMessage (Maybe Text) Source #

The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

aDMMessage_action :: Lens' ADMMessage (Maybe Action) Source #

The action to occur if the recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

aDMMessage_imageUrl :: Lens' ADMMessage (Maybe Text) Source #

The URL of an image to display in the push notification.

aDMMessage_consolidationKey :: Lens' ADMMessage (Maybe Text) Source #

An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.

aDMMessage_title :: Lens' ADMMessage (Maybe Text) Source #

The title to display above the notification message on the recipient's device.

aDMMessage_iconReference :: Lens' ADMMessage (Maybe Text) Source #

The icon image name of the asset saved in your app.

APNSChannelRequest

data APNSChannelRequest Source #

Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.

See: newAPNSChannelRequest smart constructor.

Constructors

APNSChannelRequest' 

Fields

  • tokenKey :: Maybe Text

    The authentication key to use for APNs tokens.

  • privateKey :: Maybe Text

    The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

  • enabled :: Maybe Bool

    Specifies whether to enable the APNs channel for the application.

  • teamId :: Maybe Text

    The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

  • bundleId :: Maybe Text

    The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

  • defaultAuthenticationMethod :: Maybe Text

    The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

  • certificate :: Maybe Text

    The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

  • tokenKeyId :: Maybe Text

    The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

Instances

Instances details
Eq APNSChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSChannelRequest

Read APNSChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSChannelRequest

Show APNSChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSChannelRequest

Generic APNSChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSChannelRequest

Associated Types

type Rep APNSChannelRequest :: Type -> Type #

NFData APNSChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSChannelRequest

Methods

rnf :: APNSChannelRequest -> () #

Hashable APNSChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSChannelRequest

ToJSON APNSChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSChannelRequest

type Rep APNSChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSChannelRequest

type Rep APNSChannelRequest = D1 ('MetaData "APNSChannelRequest" "Amazonka.Pinpoint.Types.APNSChannelRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "APNSChannelRequest'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "tokenKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "privateKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "teamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "bundleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "defaultAuthenticationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tokenKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newAPNSChannelRequest :: APNSChannelRequest Source #

Create a value of APNSChannelRequest 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:tokenKey:APNSChannelRequest', aPNSChannelRequest_tokenKey - The authentication key to use for APNs tokens.

$sel:privateKey:APNSChannelRequest', aPNSChannelRequest_privateKey - The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

$sel:enabled:APNSChannelRequest', aPNSChannelRequest_enabled - Specifies whether to enable the APNs channel for the application.

$sel:teamId:APNSChannelRequest', aPNSChannelRequest_teamId - The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

$sel:bundleId:APNSChannelRequest', aPNSChannelRequest_bundleId - The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

$sel:defaultAuthenticationMethod:APNSChannelRequest', aPNSChannelRequest_defaultAuthenticationMethod - The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

$sel:certificate:APNSChannelRequest', aPNSChannelRequest_certificate - The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

$sel:tokenKeyId:APNSChannelRequest', aPNSChannelRequest_tokenKeyId - The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

aPNSChannelRequest_tokenKey :: Lens' APNSChannelRequest (Maybe Text) Source #

The authentication key to use for APNs tokens.

aPNSChannelRequest_privateKey :: Lens' APNSChannelRequest (Maybe Text) Source #

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

aPNSChannelRequest_enabled :: Lens' APNSChannelRequest (Maybe Bool) Source #

Specifies whether to enable the APNs channel for the application.

aPNSChannelRequest_teamId :: Lens' APNSChannelRequest (Maybe Text) Source #

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

aPNSChannelRequest_bundleId :: Lens' APNSChannelRequest (Maybe Text) Source #

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

aPNSChannelRequest_defaultAuthenticationMethod :: Lens' APNSChannelRequest (Maybe Text) Source #

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

aPNSChannelRequest_certificate :: Lens' APNSChannelRequest (Maybe Text) Source #

The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

aPNSChannelRequest_tokenKeyId :: Lens' APNSChannelRequest (Maybe Text) Source #

The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

APNSChannelResponse

data APNSChannelResponse Source #

Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.

See: newAPNSChannelResponse smart constructor.

Constructors

APNSChannelResponse' 

Fields

  • lastModifiedDate :: Maybe Text

    The date and time when the APNs channel was last modified.

  • enabled :: Maybe Bool

    Specifies whether the APNs channel is enabled for the application.

  • hasTokenKey :: Maybe Bool

    Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

  • defaultAuthenticationMethod :: Maybe Text

    The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

  • isArchived :: Maybe Bool

    Specifies whether the APNs channel is archived.

  • applicationId :: Maybe Text

    The unique identifier for the application that the APNs channel applies to.

  • version :: Maybe Int

    The current version of the APNs channel.

  • id :: Maybe Text

    (Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.

  • creationDate :: Maybe Text

    The date and time when the APNs channel was enabled.

  • lastModifiedBy :: Maybe Text

    The user who last modified the APNs channel.

  • hasCredential :: Maybe Bool

    (Not used) This property is retained only for backward compatibility.

  • platform :: Text

    The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.

Instances

Instances details
Eq APNSChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSChannelResponse

Read APNSChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSChannelResponse

Show APNSChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSChannelResponse

Generic APNSChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSChannelResponse

Associated Types

type Rep APNSChannelResponse :: Type -> Type #

NFData APNSChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSChannelResponse

Methods

rnf :: APNSChannelResponse -> () #

Hashable APNSChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSChannelResponse

FromJSON APNSChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSChannelResponse

type Rep APNSChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSChannelResponse

type Rep APNSChannelResponse = D1 ('MetaData "APNSChannelResponse" "Amazonka.Pinpoint.Types.APNSChannelResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "APNSChannelResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "hasTokenKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "defaultAuthenticationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "isArchived") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "hasCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newAPNSChannelResponse Source #

Create a value of APNSChannelResponse 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:lastModifiedDate:APNSChannelResponse', aPNSChannelResponse_lastModifiedDate - The date and time when the APNs channel was last modified.

$sel:enabled:APNSChannelResponse', aPNSChannelResponse_enabled - Specifies whether the APNs channel is enabled for the application.

$sel:hasTokenKey:APNSChannelResponse', aPNSChannelResponse_hasTokenKey - Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

$sel:defaultAuthenticationMethod:APNSChannelResponse', aPNSChannelResponse_defaultAuthenticationMethod - The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

$sel:isArchived:APNSChannelResponse', aPNSChannelResponse_isArchived - Specifies whether the APNs channel is archived.

$sel:applicationId:APNSChannelResponse', aPNSChannelResponse_applicationId - The unique identifier for the application that the APNs channel applies to.

$sel:version:APNSChannelResponse', aPNSChannelResponse_version - The current version of the APNs channel.

$sel:id:APNSChannelResponse', aPNSChannelResponse_id - (Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.

$sel:creationDate:APNSChannelResponse', aPNSChannelResponse_creationDate - The date and time when the APNs channel was enabled.

$sel:lastModifiedBy:APNSChannelResponse', aPNSChannelResponse_lastModifiedBy - The user who last modified the APNs channel.

$sel:hasCredential:APNSChannelResponse', aPNSChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.

$sel:platform:APNSChannelResponse', aPNSChannelResponse_platform - The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.

aPNSChannelResponse_lastModifiedDate :: Lens' APNSChannelResponse (Maybe Text) Source #

The date and time when the APNs channel was last modified.

aPNSChannelResponse_enabled :: Lens' APNSChannelResponse (Maybe Bool) Source #

Specifies whether the APNs channel is enabled for the application.

aPNSChannelResponse_hasTokenKey :: Lens' APNSChannelResponse (Maybe Bool) Source #

Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

aPNSChannelResponse_defaultAuthenticationMethod :: Lens' APNSChannelResponse (Maybe Text) Source #

The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

aPNSChannelResponse_isArchived :: Lens' APNSChannelResponse (Maybe Bool) Source #

Specifies whether the APNs channel is archived.

aPNSChannelResponse_applicationId :: Lens' APNSChannelResponse (Maybe Text) Source #

The unique identifier for the application that the APNs channel applies to.

aPNSChannelResponse_version :: Lens' APNSChannelResponse (Maybe Int) Source #

The current version of the APNs channel.

aPNSChannelResponse_id :: Lens' APNSChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.

aPNSChannelResponse_creationDate :: Lens' APNSChannelResponse (Maybe Text) Source #

The date and time when the APNs channel was enabled.

aPNSChannelResponse_lastModifiedBy :: Lens' APNSChannelResponse (Maybe Text) Source #

The user who last modified the APNs channel.

aPNSChannelResponse_hasCredential :: Lens' APNSChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

aPNSChannelResponse_platform :: Lens' APNSChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.

APNSMessage

data APNSMessage Source #

Specifies the settings for a one-time message that's sent directly to an endpoint through the APNs (Apple Push Notification service) channel.

See: newAPNSMessage smart constructor.

Constructors

APNSMessage' 

Fields

  • substitutions :: Maybe (HashMap Text [Text])

    The default message variables to use in the notification message. You can override these default variables with individual address variables.

  • silentPush :: Maybe Bool

    Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center.

    Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background.

    If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.

    Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.

  • aPNSPushType :: Maybe Text

    The type of push notification to send. Valid values are:

    • alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.
    • background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.
    • complication - For a notification that contains update information for an app’s complication timeline.
    • fileprovider - For a notification that signals changes to a File Provider extension.
    • mdm - For a notification that tells managed devices to contact the MDM server.
    • voip - For a notification that provides information about an incoming VoIP call.

    Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.

    For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.

  • priority :: Maybe Text

    para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.

    /listitem>

    10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

    /para>

    Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.

    The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.

  • rawContent :: Maybe Text

    The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

    If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.

  • data' :: Maybe (HashMap Text Text)

    The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

  • body :: Maybe Text

    The body of the notification message.

  • category :: Maybe Text

    The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.

  • timeToLive :: Maybe Int

    The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

    Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.

  • url :: Maybe Text

    The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

  • sound :: Maybe Text

    The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

  • action :: Maybe Action

    The action to occur if the recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
  • mediaUrl :: Maybe Text

    The URL of an image or video to display in the push notification.

  • preferredAuthenticationMethod :: Maybe Text

    The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.

  • badge :: Maybe Int

    The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.

  • title :: Maybe Text

    The title to display above the notification message on the recipient's device.

  • threadId :: Maybe Text

    The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.

  • collapseId :: Maybe Text

    An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.

    Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.

Instances

Instances details
Eq APNSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSMessage

Read APNSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSMessage

Show APNSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSMessage

Generic APNSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSMessage

Associated Types

type Rep APNSMessage :: Type -> Type #

NFData APNSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSMessage

Methods

rnf :: APNSMessage -> () #

Hashable APNSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSMessage

ToJSON APNSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSMessage

type Rep APNSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSMessage

type Rep APNSMessage = D1 ('MetaData "APNSMessage" "Amazonka.Pinpoint.Types.APNSMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "APNSMessage'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "substitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "silentPush") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "aPNSPushType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "rawContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "timeToLive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))) :*: (((S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Action)) :*: S1 ('MetaSel ('Just "mediaUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "preferredAuthenticationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "badge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "threadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "collapseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newAPNSMessage :: APNSMessage Source #

Create a value of APNSMessage 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:substitutions:APNSMessage', aPNSMessage_substitutions - The default message variables to use in the notification message. You can override these default variables with individual address variables.

$sel:silentPush:APNSMessage', aPNSMessage_silentPush - Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center.

Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background.

If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.

Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.

$sel:aPNSPushType:APNSMessage', aPNSMessage_aPNSPushType - The type of push notification to send. Valid values are:

  • alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.
  • background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.
  • complication - For a notification that contains update information for an app’s complication timeline.
  • fileprovider - For a notification that signals changes to a File Provider extension.
  • mdm - For a notification that tells managed devices to contact the MDM server.
  • voip - For a notification that provides information about an incoming VoIP call.

Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.

For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.

$sel:priority:APNSMessage', aPNSMessage_priority - para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.

/listitem>

10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

/para>

Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.

The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.

$sel:rawContent:APNSMessage', aPNSMessage_rawContent - The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.

$sel:data':APNSMessage', aPNSMessage_data - The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

$sel:body:APNSMessage', aPNSMessage_body - The body of the notification message.

$sel:category:APNSMessage', aPNSMessage_category - The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.

$sel:timeToLive:APNSMessage', aPNSMessage_timeToLive - The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.

$sel:url:APNSMessage', aPNSMessage_url - The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

$sel:sound:APNSMessage', aPNSMessage_sound - The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

$sel:action:APNSMessage', aPNSMessage_action - The action to occur if the recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

$sel:mediaUrl:APNSMessage', aPNSMessage_mediaUrl - The URL of an image or video to display in the push notification.

$sel:preferredAuthenticationMethod:APNSMessage', aPNSMessage_preferredAuthenticationMethod - The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.

$sel:badge:APNSMessage', aPNSMessage_badge - The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.

$sel:title:APNSMessage', aPNSMessage_title - The title to display above the notification message on the recipient's device.

$sel:threadId:APNSMessage', aPNSMessage_threadId - The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.

$sel:collapseId:APNSMessage', aPNSMessage_collapseId - An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.

Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.

aPNSMessage_substitutions :: Lens' APNSMessage (Maybe (HashMap Text [Text])) Source #

The default message variables to use in the notification message. You can override these default variables with individual address variables.

aPNSMessage_silentPush :: Lens' APNSMessage (Maybe Bool) Source #

Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center.

Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background.

If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.

Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.

aPNSMessage_aPNSPushType :: Lens' APNSMessage (Maybe Text) Source #

The type of push notification to send. Valid values are:

  • alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.
  • background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.
  • complication - For a notification that contains update information for an app’s complication timeline.
  • fileprovider - For a notification that signals changes to a File Provider extension.
  • mdm - For a notification that tells managed devices to contact the MDM server.
  • voip - For a notification that provides information about an incoming VoIP call.

Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.

For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.

aPNSMessage_priority :: Lens' APNSMessage (Maybe Text) Source #

para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.

/listitem>

10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

/para>

Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.

The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.

aPNSMessage_rawContent :: Lens' APNSMessage (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.

aPNSMessage_data :: Lens' APNSMessage (Maybe (HashMap Text Text)) Source #

The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

aPNSMessage_body :: Lens' APNSMessage (Maybe Text) Source #

The body of the notification message.

aPNSMessage_category :: Lens' APNSMessage (Maybe Text) Source #

The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.

aPNSMessage_timeToLive :: Lens' APNSMessage (Maybe Int) Source #

The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.

aPNSMessage_url :: Lens' APNSMessage (Maybe Text) Source #

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

aPNSMessage_sound :: Lens' APNSMessage (Maybe Text) Source #

The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

aPNSMessage_action :: Lens' APNSMessage (Maybe Action) Source #

The action to occur if the recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

aPNSMessage_mediaUrl :: Lens' APNSMessage (Maybe Text) Source #

The URL of an image or video to display in the push notification.

aPNSMessage_preferredAuthenticationMethod :: Lens' APNSMessage (Maybe Text) Source #

The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.

aPNSMessage_badge :: Lens' APNSMessage (Maybe Int) Source #

The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.

aPNSMessage_title :: Lens' APNSMessage (Maybe Text) Source #

The title to display above the notification message on the recipient's device.

aPNSMessage_threadId :: Lens' APNSMessage (Maybe Text) Source #

The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.

aPNSMessage_collapseId :: Lens' APNSMessage (Maybe Text) Source #

An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.

Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.

APNSPushNotificationTemplate

data APNSPushNotificationTemplate Source #

Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) channel.

See: newAPNSPushNotificationTemplate smart constructor.

Constructors

APNSPushNotificationTemplate' 

Fields

  • rawContent :: Maybe Text

    The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.

  • body :: Maybe Text

    The message body to use in push notifications that are based on the message template.

  • url :: Maybe Text

    The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

  • sound :: Maybe Text

    The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

  • action :: Maybe Action

    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
  • mediaUrl :: Maybe Text

    The URL of an image or video to display in push notifications that are based on the message template.

  • title :: Maybe Text

    The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

Instances

Instances details
Eq APNSPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate

Read APNSPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate

Show APNSPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate

Generic APNSPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate

Associated Types

type Rep APNSPushNotificationTemplate :: Type -> Type #

NFData APNSPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate

Hashable APNSPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate

ToJSON APNSPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate

FromJSON APNSPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate

type Rep APNSPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate

type Rep APNSPushNotificationTemplate = D1 ('MetaData "APNSPushNotificationTemplate" "Amazonka.Pinpoint.Types.APNSPushNotificationTemplate" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "APNSPushNotificationTemplate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rawContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "sound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Action))) :*: (S1 ('MetaSel ('Just "mediaUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newAPNSPushNotificationTemplate :: APNSPushNotificationTemplate Source #

Create a value of APNSPushNotificationTemplate 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:rawContent:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_rawContent - The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.

$sel:body:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_body - The message body to use in push notifications that are based on the message template.

$sel:url:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_url - The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

$sel:sound:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_sound - The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

$sel:action:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_action - The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

$sel:mediaUrl:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_mediaUrl - The URL of an image or video to display in push notifications that are based on the message template.

$sel:title:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_title - The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

aPNSPushNotificationTemplate_rawContent :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.

aPNSPushNotificationTemplate_body :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The message body to use in push notifications that are based on the message template.

aPNSPushNotificationTemplate_url :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

aPNSPushNotificationTemplate_sound :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

aPNSPushNotificationTemplate_action :: Lens' APNSPushNotificationTemplate (Maybe Action) Source #

The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

aPNSPushNotificationTemplate_mediaUrl :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The URL of an image or video to display in push notifications that are based on the message template.

aPNSPushNotificationTemplate_title :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

APNSSandboxChannelRequest

data APNSSandboxChannelRequest Source #

Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

See: newAPNSSandboxChannelRequest smart constructor.

Constructors

APNSSandboxChannelRequest' 

Fields

  • tokenKey :: Maybe Text

    The authentication key to use for APNs tokens.

  • privateKey :: Maybe Text

    The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

  • enabled :: Maybe Bool

    Specifies whether to enable the APNs sandbox channel for the application.

  • teamId :: Maybe Text

    The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

  • bundleId :: Maybe Text

    The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

  • defaultAuthenticationMethod :: Maybe Text

    The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.

  • certificate :: Maybe Text

    The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

  • tokenKeyId :: Maybe Text

    The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

Instances

Instances details
Eq APNSSandboxChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSSandboxChannelRequest

Read APNSSandboxChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSSandboxChannelRequest

Show APNSSandboxChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSSandboxChannelRequest

Generic APNSSandboxChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSSandboxChannelRequest

Associated Types

type Rep APNSSandboxChannelRequest :: Type -> Type #

NFData APNSSandboxChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSSandboxChannelRequest

Hashable APNSSandboxChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSSandboxChannelRequest

ToJSON APNSSandboxChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSSandboxChannelRequest

type Rep APNSSandboxChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSSandboxChannelRequest

type Rep APNSSandboxChannelRequest = D1 ('MetaData "APNSSandboxChannelRequest" "Amazonka.Pinpoint.Types.APNSSandboxChannelRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "APNSSandboxChannelRequest'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "tokenKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "privateKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "teamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "bundleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "defaultAuthenticationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tokenKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newAPNSSandboxChannelRequest :: APNSSandboxChannelRequest Source #

Create a value of APNSSandboxChannelRequest 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:tokenKey:APNSSandboxChannelRequest', aPNSSandboxChannelRequest_tokenKey - The authentication key to use for APNs tokens.

$sel:privateKey:APNSSandboxChannelRequest', aPNSSandboxChannelRequest_privateKey - The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

$sel:enabled:APNSSandboxChannelRequest', aPNSSandboxChannelRequest_enabled - Specifies whether to enable the APNs sandbox channel for the application.

$sel:teamId:APNSSandboxChannelRequest', aPNSSandboxChannelRequest_teamId - The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

$sel:bundleId:APNSSandboxChannelRequest', aPNSSandboxChannelRequest_bundleId - The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

$sel:defaultAuthenticationMethod:APNSSandboxChannelRequest', aPNSSandboxChannelRequest_defaultAuthenticationMethod - The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.

$sel:certificate:APNSSandboxChannelRequest', aPNSSandboxChannelRequest_certificate - The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

$sel:tokenKeyId:APNSSandboxChannelRequest', aPNSSandboxChannelRequest_tokenKeyId - The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

aPNSSandboxChannelRequest_tokenKey :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #

The authentication key to use for APNs tokens.

aPNSSandboxChannelRequest_privateKey :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

aPNSSandboxChannelRequest_enabled :: Lens' APNSSandboxChannelRequest (Maybe Bool) Source #

Specifies whether to enable the APNs sandbox channel for the application.

aPNSSandboxChannelRequest_teamId :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

aPNSSandboxChannelRequest_bundleId :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

aPNSSandboxChannelRequest_defaultAuthenticationMethod :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #

The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.

aPNSSandboxChannelRequest_certificate :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #

The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

aPNSSandboxChannelRequest_tokenKeyId :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #

The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

APNSSandboxChannelResponse

data APNSSandboxChannelResponse Source #

Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

See: newAPNSSandboxChannelResponse smart constructor.

Constructors

APNSSandboxChannelResponse' 

Fields

  • lastModifiedDate :: Maybe Text

    The date and time when the APNs sandbox channel was last modified.

  • enabled :: Maybe Bool

    Specifies whether the APNs sandbox channel is enabled for the application.

  • hasTokenKey :: Maybe Bool

    Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

  • defaultAuthenticationMethod :: Maybe Text

    The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

  • isArchived :: Maybe Bool

    Specifies whether the APNs sandbox channel is archived.

  • applicationId :: Maybe Text

    The unique identifier for the application that the APNs sandbox channel applies to.

  • version :: Maybe Int

    The current version of the APNs sandbox channel.

  • id :: Maybe Text

    (Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.

  • creationDate :: Maybe Text

    The date and time when the APNs sandbox channel was enabled.

  • lastModifiedBy :: Maybe Text

    The user who last modified the APNs sandbox channel.

  • hasCredential :: Maybe Bool

    (Not used) This property is retained only for backward compatibility.

  • platform :: Text

    The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.

Instances

Instances details
Eq APNSSandboxChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSSandboxChannelResponse

Read APNSSandboxChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSSandboxChannelResponse

Show APNSSandboxChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSSandboxChannelResponse

Generic APNSSandboxChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSSandboxChannelResponse

Associated Types

type Rep APNSSandboxChannelResponse :: Type -> Type #

NFData APNSSandboxChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSSandboxChannelResponse

Hashable APNSSandboxChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSSandboxChannelResponse

FromJSON APNSSandboxChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSSandboxChannelResponse

type Rep APNSSandboxChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSSandboxChannelResponse

type Rep APNSSandboxChannelResponse = D1 ('MetaData "APNSSandboxChannelResponse" "Amazonka.Pinpoint.Types.APNSSandboxChannelResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "APNSSandboxChannelResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "hasTokenKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "defaultAuthenticationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "isArchived") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "hasCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newAPNSSandboxChannelResponse Source #

Create a value of APNSSandboxChannelResponse 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:lastModifiedDate:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_lastModifiedDate - The date and time when the APNs sandbox channel was last modified.

$sel:enabled:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_enabled - Specifies whether the APNs sandbox channel is enabled for the application.

$sel:hasTokenKey:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_hasTokenKey - Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

$sel:defaultAuthenticationMethod:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_defaultAuthenticationMethod - The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

$sel:isArchived:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_isArchived - Specifies whether the APNs sandbox channel is archived.

$sel:applicationId:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_applicationId - The unique identifier for the application that the APNs sandbox channel applies to.

$sel:version:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_version - The current version of the APNs sandbox channel.

$sel:id:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_id - (Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.

$sel:creationDate:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_creationDate - The date and time when the APNs sandbox channel was enabled.

$sel:lastModifiedBy:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_lastModifiedBy - The user who last modified the APNs sandbox channel.

$sel:hasCredential:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.

$sel:platform:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_platform - The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.

aPNSSandboxChannelResponse_lastModifiedDate :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #

The date and time when the APNs sandbox channel was last modified.

aPNSSandboxChannelResponse_enabled :: Lens' APNSSandboxChannelResponse (Maybe Bool) Source #

Specifies whether the APNs sandbox channel is enabled for the application.

aPNSSandboxChannelResponse_hasTokenKey :: Lens' APNSSandboxChannelResponse (Maybe Bool) Source #

Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

aPNSSandboxChannelResponse_defaultAuthenticationMethod :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #

The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

aPNSSandboxChannelResponse_isArchived :: Lens' APNSSandboxChannelResponse (Maybe Bool) Source #

Specifies whether the APNs sandbox channel is archived.

aPNSSandboxChannelResponse_applicationId :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #

The unique identifier for the application that the APNs sandbox channel applies to.

aPNSSandboxChannelResponse_version :: Lens' APNSSandboxChannelResponse (Maybe Int) Source #

The current version of the APNs sandbox channel.

aPNSSandboxChannelResponse_id :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.

aPNSSandboxChannelResponse_creationDate :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #

The date and time when the APNs sandbox channel was enabled.

aPNSSandboxChannelResponse_lastModifiedBy :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #

The user who last modified the APNs sandbox channel.

aPNSSandboxChannelResponse_hasCredential :: Lens' APNSSandboxChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

aPNSSandboxChannelResponse_platform :: Lens' APNSSandboxChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.

APNSVoipChannelRequest

data APNSVoipChannelRequest Source #

Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

See: newAPNSVoipChannelRequest smart constructor.

Constructors

APNSVoipChannelRequest' 

Fields

  • tokenKey :: Maybe Text

    The authentication key to use for APNs tokens.

  • privateKey :: Maybe Text

    The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

  • enabled :: Maybe Bool

    Specifies whether to enable the APNs VoIP channel for the application.

  • teamId :: Maybe Text

    The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

  • bundleId :: Maybe Text

    The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

  • defaultAuthenticationMethod :: Maybe Text

    The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

  • certificate :: Maybe Text

    The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

  • tokenKeyId :: Maybe Text

    The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

Instances

Instances details
Eq APNSVoipChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelRequest

Read APNSVoipChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelRequest

Show APNSVoipChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelRequest

Generic APNSVoipChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelRequest

Associated Types

type Rep APNSVoipChannelRequest :: Type -> Type #

NFData APNSVoipChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelRequest

Methods

rnf :: APNSVoipChannelRequest -> () #

Hashable APNSVoipChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelRequest

ToJSON APNSVoipChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelRequest

type Rep APNSVoipChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelRequest

type Rep APNSVoipChannelRequest = D1 ('MetaData "APNSVoipChannelRequest" "Amazonka.Pinpoint.Types.APNSVoipChannelRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "APNSVoipChannelRequest'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "tokenKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "privateKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "teamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "bundleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "defaultAuthenticationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tokenKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newAPNSVoipChannelRequest :: APNSVoipChannelRequest Source #

Create a value of APNSVoipChannelRequest 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:tokenKey:APNSVoipChannelRequest', aPNSVoipChannelRequest_tokenKey - The authentication key to use for APNs tokens.

$sel:privateKey:APNSVoipChannelRequest', aPNSVoipChannelRequest_privateKey - The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

$sel:enabled:APNSVoipChannelRequest', aPNSVoipChannelRequest_enabled - Specifies whether to enable the APNs VoIP channel for the application.

$sel:teamId:APNSVoipChannelRequest', aPNSVoipChannelRequest_teamId - The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

$sel:bundleId:APNSVoipChannelRequest', aPNSVoipChannelRequest_bundleId - The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

$sel:defaultAuthenticationMethod:APNSVoipChannelRequest', aPNSVoipChannelRequest_defaultAuthenticationMethod - The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

$sel:certificate:APNSVoipChannelRequest', aPNSVoipChannelRequest_certificate - The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

$sel:tokenKeyId:APNSVoipChannelRequest', aPNSVoipChannelRequest_tokenKeyId - The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

aPNSVoipChannelRequest_tokenKey :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

The authentication key to use for APNs tokens.

aPNSVoipChannelRequest_privateKey :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

aPNSVoipChannelRequest_enabled :: Lens' APNSVoipChannelRequest (Maybe Bool) Source #

Specifies whether to enable the APNs VoIP channel for the application.

aPNSVoipChannelRequest_teamId :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

aPNSVoipChannelRequest_bundleId :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

aPNSVoipChannelRequest_defaultAuthenticationMethod :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

aPNSVoipChannelRequest_certificate :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

aPNSVoipChannelRequest_tokenKeyId :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

APNSVoipChannelResponse

data APNSVoipChannelResponse Source #

Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

See: newAPNSVoipChannelResponse smart constructor.

Constructors

APNSVoipChannelResponse' 

Fields

  • lastModifiedDate :: Maybe Text

    The date and time when the APNs VoIP channel was last modified.

  • enabled :: Maybe Bool

    Specifies whether the APNs VoIP channel is enabled for the application.

  • hasTokenKey :: Maybe Bool

    Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

  • defaultAuthenticationMethod :: Maybe Text

    The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

  • isArchived :: Maybe Bool

    Specifies whether the APNs VoIP channel is archived.

  • applicationId :: Maybe Text

    The unique identifier for the application that the APNs VoIP channel applies to.

  • version :: Maybe Int

    The current version of the APNs VoIP channel.

  • id :: Maybe Text

    (Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.

  • creationDate :: Maybe Text

    The date and time when the APNs VoIP channel was enabled.

  • lastModifiedBy :: Maybe Text

    The user who last modified the APNs VoIP channel.

  • hasCredential :: Maybe Bool

    (Not used) This property is retained only for backward compatibility.

  • platform :: Text

    The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.

Instances

Instances details
Eq APNSVoipChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelResponse

Read APNSVoipChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelResponse

Show APNSVoipChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelResponse

Generic APNSVoipChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelResponse

Associated Types

type Rep APNSVoipChannelResponse :: Type -> Type #

NFData APNSVoipChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelResponse

Methods

rnf :: APNSVoipChannelResponse -> () #

Hashable APNSVoipChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelResponse

FromJSON APNSVoipChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelResponse

type Rep APNSVoipChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelResponse

type Rep APNSVoipChannelResponse = D1 ('MetaData "APNSVoipChannelResponse" "Amazonka.Pinpoint.Types.APNSVoipChannelResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "APNSVoipChannelResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "hasTokenKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "defaultAuthenticationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "isArchived") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "hasCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newAPNSVoipChannelResponse Source #

Create a value of APNSVoipChannelResponse 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:lastModifiedDate:APNSVoipChannelResponse', aPNSVoipChannelResponse_lastModifiedDate - The date and time when the APNs VoIP channel was last modified.

$sel:enabled:APNSVoipChannelResponse', aPNSVoipChannelResponse_enabled - Specifies whether the APNs VoIP channel is enabled for the application.

$sel:hasTokenKey:APNSVoipChannelResponse', aPNSVoipChannelResponse_hasTokenKey - Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

$sel:defaultAuthenticationMethod:APNSVoipChannelResponse', aPNSVoipChannelResponse_defaultAuthenticationMethod - The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

$sel:isArchived:APNSVoipChannelResponse', aPNSVoipChannelResponse_isArchived - Specifies whether the APNs VoIP channel is archived.

$sel:applicationId:APNSVoipChannelResponse', aPNSVoipChannelResponse_applicationId - The unique identifier for the application that the APNs VoIP channel applies to.

$sel:version:APNSVoipChannelResponse', aPNSVoipChannelResponse_version - The current version of the APNs VoIP channel.

$sel:id:APNSVoipChannelResponse', aPNSVoipChannelResponse_id - (Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.

$sel:creationDate:APNSVoipChannelResponse', aPNSVoipChannelResponse_creationDate - The date and time when the APNs VoIP channel was enabled.

$sel:lastModifiedBy:APNSVoipChannelResponse', aPNSVoipChannelResponse_lastModifiedBy - The user who last modified the APNs VoIP channel.

$sel:hasCredential:APNSVoipChannelResponse', aPNSVoipChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.

$sel:platform:APNSVoipChannelResponse', aPNSVoipChannelResponse_platform - The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.

aPNSVoipChannelResponse_lastModifiedDate :: Lens' APNSVoipChannelResponse (Maybe Text) Source #

The date and time when the APNs VoIP channel was last modified.

aPNSVoipChannelResponse_enabled :: Lens' APNSVoipChannelResponse (Maybe Bool) Source #

Specifies whether the APNs VoIP channel is enabled for the application.

aPNSVoipChannelResponse_hasTokenKey :: Lens' APNSVoipChannelResponse (Maybe Bool) Source #

Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

aPNSVoipChannelResponse_defaultAuthenticationMethod :: Lens' APNSVoipChannelResponse (Maybe Text) Source #

The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

aPNSVoipChannelResponse_isArchived :: Lens' APNSVoipChannelResponse (Maybe Bool) Source #

Specifies whether the APNs VoIP channel is archived.

aPNSVoipChannelResponse_applicationId :: Lens' APNSVoipChannelResponse (Maybe Text) Source #

The unique identifier for the application that the APNs VoIP channel applies to.

aPNSVoipChannelResponse_version :: Lens' APNSVoipChannelResponse (Maybe Int) Source #

The current version of the APNs VoIP channel.

aPNSVoipChannelResponse_id :: Lens' APNSVoipChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.

aPNSVoipChannelResponse_creationDate :: Lens' APNSVoipChannelResponse (Maybe Text) Source #

The date and time when the APNs VoIP channel was enabled.

aPNSVoipChannelResponse_lastModifiedBy :: Lens' APNSVoipChannelResponse (Maybe Text) Source #

The user who last modified the APNs VoIP channel.

aPNSVoipChannelResponse_hasCredential :: Lens' APNSVoipChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

aPNSVoipChannelResponse_platform :: Lens' APNSVoipChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.

APNSVoipSandboxChannelRequest

data APNSVoipSandboxChannelRequest Source #

Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

See: newAPNSVoipSandboxChannelRequest smart constructor.

Constructors

APNSVoipSandboxChannelRequest' 

Fields

  • tokenKey :: Maybe Text

    The authentication key to use for APNs tokens.

  • privateKey :: Maybe Text

    The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

  • enabled :: Maybe Bool

    Specifies whether the APNs VoIP sandbox channel is enabled for the application.

  • teamId :: Maybe Text

    The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

  • bundleId :: Maybe Text

    The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

  • defaultAuthenticationMethod :: Maybe Text

    The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.

  • certificate :: Maybe Text

    The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

  • tokenKeyId :: Maybe Text

    The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

Instances

Instances details
Eq APNSVoipSandboxChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipSandboxChannelRequest

Read APNSVoipSandboxChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipSandboxChannelRequest

Show APNSVoipSandboxChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipSandboxChannelRequest

Generic APNSVoipSandboxChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipSandboxChannelRequest

Associated Types

type Rep APNSVoipSandboxChannelRequest :: Type -> Type #

NFData APNSVoipSandboxChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipSandboxChannelRequest

Hashable APNSVoipSandboxChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipSandboxChannelRequest

ToJSON APNSVoipSandboxChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipSandboxChannelRequest

type Rep APNSVoipSandboxChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipSandboxChannelRequest

type Rep APNSVoipSandboxChannelRequest = D1 ('MetaData "APNSVoipSandboxChannelRequest" "Amazonka.Pinpoint.Types.APNSVoipSandboxChannelRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "APNSVoipSandboxChannelRequest'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "tokenKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "privateKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "teamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "bundleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "defaultAuthenticationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tokenKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newAPNSVoipSandboxChannelRequest :: APNSVoipSandboxChannelRequest Source #

Create a value of APNSVoipSandboxChannelRequest 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:tokenKey:APNSVoipSandboxChannelRequest', aPNSVoipSandboxChannelRequest_tokenKey - The authentication key to use for APNs tokens.

$sel:privateKey:APNSVoipSandboxChannelRequest', aPNSVoipSandboxChannelRequest_privateKey - The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

$sel:enabled:APNSVoipSandboxChannelRequest', aPNSVoipSandboxChannelRequest_enabled - Specifies whether the APNs VoIP sandbox channel is enabled for the application.

$sel:teamId:APNSVoipSandboxChannelRequest', aPNSVoipSandboxChannelRequest_teamId - The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

$sel:bundleId:APNSVoipSandboxChannelRequest', aPNSVoipSandboxChannelRequest_bundleId - The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

$sel:defaultAuthenticationMethod:APNSVoipSandboxChannelRequest', aPNSVoipSandboxChannelRequest_defaultAuthenticationMethod - The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.

$sel:certificate:APNSVoipSandboxChannelRequest', aPNSVoipSandboxChannelRequest_certificate - The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

$sel:tokenKeyId:APNSVoipSandboxChannelRequest', aPNSVoipSandboxChannelRequest_tokenKeyId - The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

aPNSVoipSandboxChannelRequest_privateKey :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

aPNSVoipSandboxChannelRequest_enabled :: Lens' APNSVoipSandboxChannelRequest (Maybe Bool) Source #

Specifies whether the APNs VoIP sandbox channel is enabled for the application.

aPNSVoipSandboxChannelRequest_teamId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

aPNSVoipSandboxChannelRequest_bundleId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

aPNSVoipSandboxChannelRequest_defaultAuthenticationMethod :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #

The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.

aPNSVoipSandboxChannelRequest_certificate :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #

The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

aPNSVoipSandboxChannelRequest_tokenKeyId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #

The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

APNSVoipSandboxChannelResponse

data APNSVoipSandboxChannelResponse Source #

Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

See: newAPNSVoipSandboxChannelResponse smart constructor.

Constructors

APNSVoipSandboxChannelResponse' 

Fields

  • lastModifiedDate :: Maybe Text

    The date and time when the APNs VoIP sandbox channel was last modified.

  • enabled :: Maybe Bool

    Specifies whether the APNs VoIP sandbox channel is enabled for the application.

  • hasTokenKey :: Maybe Bool

    Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

  • defaultAuthenticationMethod :: Maybe Text

    The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

  • isArchived :: Maybe Bool

    Specifies whether the APNs VoIP sandbox channel is archived.

  • applicationId :: Maybe Text

    The unique identifier for the application that the APNs VoIP sandbox channel applies to.

  • version :: Maybe Int

    The current version of the APNs VoIP sandbox channel.

  • id :: Maybe Text

    (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.

  • creationDate :: Maybe Text

    The date and time when the APNs VoIP sandbox channel was enabled.

  • lastModifiedBy :: Maybe Text

    The user who last modified the APNs VoIP sandbox channel.

  • hasCredential :: Maybe Bool

    (Not used) This property is retained only for backward compatibility.

  • platform :: Text

    The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.

Instances

Instances details
Eq APNSVoipSandboxChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipSandboxChannelResponse

Read APNSVoipSandboxChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipSandboxChannelResponse

Show APNSVoipSandboxChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipSandboxChannelResponse

Generic APNSVoipSandboxChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipSandboxChannelResponse

Associated Types

type Rep APNSVoipSandboxChannelResponse :: Type -> Type #

NFData APNSVoipSandboxChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipSandboxChannelResponse

Hashable APNSVoipSandboxChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipSandboxChannelResponse

FromJSON APNSVoipSandboxChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipSandboxChannelResponse

type Rep APNSVoipSandboxChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipSandboxChannelResponse

type Rep APNSVoipSandboxChannelResponse = D1 ('MetaData "APNSVoipSandboxChannelResponse" "Amazonka.Pinpoint.Types.APNSVoipSandboxChannelResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "APNSVoipSandboxChannelResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "hasTokenKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "defaultAuthenticationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "isArchived") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "hasCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newAPNSVoipSandboxChannelResponse Source #

Create a value of APNSVoipSandboxChannelResponse 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:lastModifiedDate:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_lastModifiedDate - The date and time when the APNs VoIP sandbox channel was last modified.

$sel:enabled:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_enabled - Specifies whether the APNs VoIP sandbox channel is enabled for the application.

$sel:hasTokenKey:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_hasTokenKey - Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

$sel:defaultAuthenticationMethod:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_defaultAuthenticationMethod - The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

$sel:isArchived:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_isArchived - Specifies whether the APNs VoIP sandbox channel is archived.

$sel:applicationId:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_applicationId - The unique identifier for the application that the APNs VoIP sandbox channel applies to.

$sel:version:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_version - The current version of the APNs VoIP sandbox channel.

$sel:id:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_id - (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.

$sel:creationDate:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_creationDate - The date and time when the APNs VoIP sandbox channel was enabled.

$sel:lastModifiedBy:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_lastModifiedBy - The user who last modified the APNs VoIP sandbox channel.

$sel:hasCredential:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.

$sel:platform:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_platform - The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.

aPNSVoipSandboxChannelResponse_lastModifiedDate :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #

The date and time when the APNs VoIP sandbox channel was last modified.

aPNSVoipSandboxChannelResponse_enabled :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) Source #

Specifies whether the APNs VoIP sandbox channel is enabled for the application.

aPNSVoipSandboxChannelResponse_hasTokenKey :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) Source #

Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

aPNSVoipSandboxChannelResponse_defaultAuthenticationMethod :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #

The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

aPNSVoipSandboxChannelResponse_isArchived :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) Source #

Specifies whether the APNs VoIP sandbox channel is archived.

aPNSVoipSandboxChannelResponse_applicationId :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #

The unique identifier for the application that the APNs VoIP sandbox channel applies to.

aPNSVoipSandboxChannelResponse_version :: Lens' APNSVoipSandboxChannelResponse (Maybe Int) Source #

The current version of the APNs VoIP sandbox channel.

aPNSVoipSandboxChannelResponse_id :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.

aPNSVoipSandboxChannelResponse_creationDate :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #

The date and time when the APNs VoIP sandbox channel was enabled.

aPNSVoipSandboxChannelResponse_lastModifiedBy :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #

The user who last modified the APNs VoIP sandbox channel.

aPNSVoipSandboxChannelResponse_hasCredential :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

aPNSVoipSandboxChannelResponse_platform :: Lens' APNSVoipSandboxChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.

ActivitiesResponse

data ActivitiesResponse Source #

Provides information about the activities that were performed by a campaign.

See: newActivitiesResponse smart constructor.

Constructors

ActivitiesResponse' 

Fields

  • nextToken :: Maybe Text

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

  • item :: [ActivityResponse]

    An array of responses, one for each activity that was performed by the campaign.

Instances

Instances details
Eq ActivitiesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ActivitiesResponse

Read ActivitiesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ActivitiesResponse

Show ActivitiesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ActivitiesResponse

Generic ActivitiesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ActivitiesResponse

Associated Types

type Rep ActivitiesResponse :: Type -> Type #

NFData ActivitiesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ActivitiesResponse

Methods

rnf :: ActivitiesResponse -> () #

Hashable ActivitiesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ActivitiesResponse

FromJSON ActivitiesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ActivitiesResponse

type Rep ActivitiesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ActivitiesResponse

type Rep ActivitiesResponse = D1 ('MetaData "ActivitiesResponse" "Amazonka.Pinpoint.Types.ActivitiesResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ActivitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ActivityResponse])))

newActivitiesResponse :: ActivitiesResponse Source #

Create a value of ActivitiesResponse 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:nextToken:ActivitiesResponse', activitiesResponse_nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

$sel:item:ActivitiesResponse', activitiesResponse_item - An array of responses, one for each activity that was performed by the campaign.

activitiesResponse_nextToken :: Lens' ActivitiesResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

activitiesResponse_item :: Lens' ActivitiesResponse [ActivityResponse] Source #

An array of responses, one for each activity that was performed by the campaign.

Activity

data Activity Source #

Specifies the configuration and other settings for an activity in a journey.

See: newActivity smart constructor.

Constructors

Activity' 

Fields

  • conditionalSplit :: Maybe ConditionalSplitActivity

    The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

  • email :: Maybe EmailMessageActivity

    The settings for an email activity. This type of activity sends an email message to participants.

  • multiCondition :: Maybe MultiConditionalSplitActivity

    The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

  • contactCenter :: Maybe ContactCenterActivity

    The settings for a connect activity. This type of activity initiates a contact center call to participants.

  • custom :: Maybe CustomMessageActivity

    The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

  • wait :: Maybe WaitActivity

    The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

  • randomSplit :: Maybe RandomSplitActivity

    The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

  • holdout :: Maybe HoldoutActivity

    The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

  • sms :: Maybe SMSMessageActivity

    The settings for an SMS activity. This type of activity sends a text message to participants.

  • push :: Maybe PushMessageActivity

    The settings for a push notification activity. This type of activity sends a push notification to participants.

  • description :: Maybe Text

    The custom description of the activity.

Instances

Instances details
Eq Activity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Activity

Read Activity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Activity

Show Activity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Activity

Generic Activity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Activity

Associated Types

type Rep Activity :: Type -> Type #

Methods

from :: Activity -> Rep Activity x #

to :: Rep Activity x -> Activity #

NFData Activity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Activity

Methods

rnf :: Activity -> () #

Hashable Activity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Activity

Methods

hashWithSalt :: Int -> Activity -> Int #

hash :: Activity -> Int #

ToJSON Activity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Activity

FromJSON Activity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Activity

type Rep Activity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Activity

type Rep Activity = D1 ('MetaData "Activity" "Amazonka.Pinpoint.Types.Activity" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "Activity'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "conditionalSplit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConditionalSplitActivity)) :*: S1 ('MetaSel ('Just "email") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EmailMessageActivity))) :*: (S1 ('MetaSel ('Just "multiCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MultiConditionalSplitActivity)) :*: (S1 ('MetaSel ('Just "contactCenter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContactCenterActivity)) :*: S1 ('MetaSel ('Just "custom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomMessageActivity))))) :*: ((S1 ('MetaSel ('Just "wait") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WaitActivity)) :*: (S1 ('MetaSel ('Just "randomSplit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RandomSplitActivity)) :*: S1 ('MetaSel ('Just "holdout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HoldoutActivity)))) :*: (S1 ('MetaSel ('Just "sms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SMSMessageActivity)) :*: (S1 ('MetaSel ('Just "push") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PushMessageActivity)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newActivity :: Activity Source #

Create a value of Activity 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:conditionalSplit:Activity', activity_conditionalSplit - The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

$sel:email:Activity', activity_email - The settings for an email activity. This type of activity sends an email message to participants.

$sel:multiCondition:Activity', activity_multiCondition - The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

$sel:contactCenter:Activity', activity_contactCenter - The settings for a connect activity. This type of activity initiates a contact center call to participants.

$sel:custom:Activity', activity_custom - The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

$sel:wait:Activity', activity_wait - The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

$sel:randomSplit:Activity', activity_randomSplit - The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

$sel:holdout:Activity', activity_holdout - The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

$sel:sms:Activity', activity_sms - The settings for an SMS activity. This type of activity sends a text message to participants.

$sel:push:Activity', activity_push - The settings for a push notification activity. This type of activity sends a push notification to participants.

$sel:description:Activity', activity_description - The custom description of the activity.

activity_conditionalSplit :: Lens' Activity (Maybe ConditionalSplitActivity) Source #

The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

activity_email :: Lens' Activity (Maybe EmailMessageActivity) Source #

The settings for an email activity. This type of activity sends an email message to participants.

activity_multiCondition :: Lens' Activity (Maybe MultiConditionalSplitActivity) Source #

The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

activity_contactCenter :: Lens' Activity (Maybe ContactCenterActivity) Source #

The settings for a connect activity. This type of activity initiates a contact center call to participants.

activity_custom :: Lens' Activity (Maybe CustomMessageActivity) Source #

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

activity_wait :: Lens' Activity (Maybe WaitActivity) Source #

The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

activity_randomSplit :: Lens' Activity (Maybe RandomSplitActivity) Source #

The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

activity_holdout :: Lens' Activity (Maybe HoldoutActivity) Source #

The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

activity_sms :: Lens' Activity (Maybe SMSMessageActivity) Source #

The settings for an SMS activity. This type of activity sends a text message to participants.

activity_push :: Lens' Activity (Maybe PushMessageActivity) Source #

The settings for a push notification activity. This type of activity sends a push notification to participants.

activity_description :: Lens' Activity (Maybe Text) Source #

The custom description of the activity.

ActivityResponse

data ActivityResponse Source #

Provides information about an activity that was performed by a campaign.

See: newActivityResponse smart constructor.

Constructors

ActivityResponse' 

Fields

  • state :: Maybe Text

    The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

  • start :: Maybe Text

    The actual start time, in ISO 8601 format, of the activity.

  • timezonesCompletedCount :: Maybe Int

    The total number of time zones that were completed.

  • timezonesTotalCount :: Maybe Int

    The total number of unique time zones that are in the segment for the campaign.

  • result :: Maybe Text

    Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.

  • treatmentId :: Maybe Text

    The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

  • successfulEndpointCount :: Maybe Int

    The total number of endpoints that the campaign successfully delivered messages to.

  • end :: Maybe Text

    The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.

  • totalEndpointCount :: Maybe Int

    The total number of endpoints that the campaign attempted to deliver messages to.

  • scheduledStart :: Maybe Text

    The scheduled start time, in ISO 8601 format, for the activity.

  • campaignId :: Text

    The unique identifier for the campaign that the activity applies to.

  • id :: Text

    The unique identifier for the activity.

  • applicationId :: Text

    The unique identifier for the application that the campaign applies to.

Instances

Instances details
Eq ActivityResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ActivityResponse

Read ActivityResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ActivityResponse

Show ActivityResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ActivityResponse

Generic ActivityResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ActivityResponse

Associated Types

type Rep ActivityResponse :: Type -> Type #

NFData ActivityResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ActivityResponse

Methods

rnf :: ActivityResponse -> () #

Hashable ActivityResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ActivityResponse

FromJSON ActivityResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ActivityResponse

type Rep ActivityResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ActivityResponse

type Rep ActivityResponse = D1 ('MetaData "ActivityResponse" "Amazonka.Pinpoint.Types.ActivityResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ActivityResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "timezonesCompletedCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "timezonesTotalCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "treatmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "successfulEndpointCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "end") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "totalEndpointCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "scheduledStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "campaignId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newActivityResponse Source #

Create a value of ActivityResponse 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:state:ActivityResponse', activityResponse_state - The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

$sel:start:ActivityResponse', activityResponse_start - The actual start time, in ISO 8601 format, of the activity.

$sel:timezonesCompletedCount:ActivityResponse', activityResponse_timezonesCompletedCount - The total number of time zones that were completed.

$sel:timezonesTotalCount:ActivityResponse', activityResponse_timezonesTotalCount - The total number of unique time zones that are in the segment for the campaign.

$sel:result:ActivityResponse', activityResponse_result - Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.

$sel:treatmentId:ActivityResponse', activityResponse_treatmentId - The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

$sel:successfulEndpointCount:ActivityResponse', activityResponse_successfulEndpointCount - The total number of endpoints that the campaign successfully delivered messages to.

$sel:end:ActivityResponse', activityResponse_end - The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.

$sel:totalEndpointCount:ActivityResponse', activityResponse_totalEndpointCount - The total number of endpoints that the campaign attempted to deliver messages to.

$sel:scheduledStart:ActivityResponse', activityResponse_scheduledStart - The scheduled start time, in ISO 8601 format, for the activity.

$sel:campaignId:ActivityResponse', activityResponse_campaignId - The unique identifier for the campaign that the activity applies to.

$sel:id:ActivityResponse', activityResponse_id - The unique identifier for the activity.

$sel:applicationId:ActivityResponse', activityResponse_applicationId - The unique identifier for the application that the campaign applies to.

activityResponse_state :: Lens' ActivityResponse (Maybe Text) Source #

The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

activityResponse_start :: Lens' ActivityResponse (Maybe Text) Source #

The actual start time, in ISO 8601 format, of the activity.

activityResponse_timezonesCompletedCount :: Lens' ActivityResponse (Maybe Int) Source #

The total number of time zones that were completed.

activityResponse_timezonesTotalCount :: Lens' ActivityResponse (Maybe Int) Source #

The total number of unique time zones that are in the segment for the campaign.

activityResponse_result :: Lens' ActivityResponse (Maybe Text) Source #

Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.

activityResponse_treatmentId :: Lens' ActivityResponse (Maybe Text) Source #

The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

activityResponse_successfulEndpointCount :: Lens' ActivityResponse (Maybe Int) Source #

The total number of endpoints that the campaign successfully delivered messages to.

activityResponse_end :: Lens' ActivityResponse (Maybe Text) Source #

The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.

activityResponse_totalEndpointCount :: Lens' ActivityResponse (Maybe Int) Source #

The total number of endpoints that the campaign attempted to deliver messages to.

activityResponse_scheduledStart :: Lens' ActivityResponse (Maybe Text) Source #

The scheduled start time, in ISO 8601 format, for the activity.

activityResponse_campaignId :: Lens' ActivityResponse Text Source #

The unique identifier for the campaign that the activity applies to.

activityResponse_id :: Lens' ActivityResponse Text Source #

The unique identifier for the activity.

activityResponse_applicationId :: Lens' ActivityResponse Text Source #

The unique identifier for the application that the campaign applies to.

AddressConfiguration

data AddressConfiguration Source #

Specifies address-based configuration settings for a message that's sent directly to an endpoint.

See: newAddressConfiguration smart constructor.

Constructors

AddressConfiguration' 

Fields

  • substitutions :: Maybe (HashMap Text [Text])

    A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.

  • titleOverride :: Maybe Text

    The message title to use instead of the default message title. This value overrides the default message title.

  • context :: Maybe (HashMap Text Text)

    An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.

    For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

  • rawContent :: Maybe Text

    The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

  • bodyOverride :: Maybe Text

    The message body to use instead of the default message body. This value overrides the default message body.

  • channelType :: Maybe ChannelType

    The channel to use when sending the message.

Instances

Instances details
Eq AddressConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AddressConfiguration

Read AddressConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AddressConfiguration

Show AddressConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AddressConfiguration

Generic AddressConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AddressConfiguration

Associated Types

type Rep AddressConfiguration :: Type -> Type #

NFData AddressConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AddressConfiguration

Methods

rnf :: AddressConfiguration -> () #

Hashable AddressConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AddressConfiguration

ToJSON AddressConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AddressConfiguration

type Rep AddressConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AddressConfiguration

type Rep AddressConfiguration = D1 ('MetaData "AddressConfiguration" "Amazonka.Pinpoint.Types.AddressConfiguration" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "AddressConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "substitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: (S1 ('MetaSel ('Just "titleOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "context") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: (S1 ('MetaSel ('Just "rawContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "bodyOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "channelType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelType))))))

newAddressConfiguration :: AddressConfiguration Source #

Create a value of AddressConfiguration 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:substitutions:AddressConfiguration', addressConfiguration_substitutions - A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.

$sel:titleOverride:AddressConfiguration', addressConfiguration_titleOverride - The message title to use instead of the default message title. This value overrides the default message title.

$sel:context:AddressConfiguration', addressConfiguration_context - An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.

For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

$sel:rawContent:AddressConfiguration', addressConfiguration_rawContent - The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

$sel:bodyOverride:AddressConfiguration', addressConfiguration_bodyOverride - The message body to use instead of the default message body. This value overrides the default message body.

$sel:channelType:AddressConfiguration', addressConfiguration_channelType - The channel to use when sending the message.

addressConfiguration_substitutions :: Lens' AddressConfiguration (Maybe (HashMap Text [Text])) Source #

A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.

addressConfiguration_titleOverride :: Lens' AddressConfiguration (Maybe Text) Source #

The message title to use instead of the default message title. This value overrides the default message title.

addressConfiguration_context :: Lens' AddressConfiguration (Maybe (HashMap Text Text)) Source #

An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.

For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

addressConfiguration_rawContent :: Lens' AddressConfiguration (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

addressConfiguration_bodyOverride :: Lens' AddressConfiguration (Maybe Text) Source #

The message body to use instead of the default message body. This value overrides the default message body.

addressConfiguration_channelType :: Lens' AddressConfiguration (Maybe ChannelType) Source #

The channel to use when sending the message.

AndroidPushNotificationTemplate

data AndroidPushNotificationTemplate Source #

Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.

See: newAndroidPushNotificationTemplate smart constructor.

Constructors

AndroidPushNotificationTemplate' 

Fields

  • imageIconUrl :: Maybe Text

    The URL of the large icon image to display in the content view of a push notification that's based on the message template.

  • rawContent :: Maybe Text

    The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

  • smallImageIconUrl :: Maybe Text

    The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

  • body :: Maybe Text

    The message body to use in a push notification that's based on the message template.

  • url :: Maybe Text

    The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

  • sound :: Maybe Text

    The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

  • action :: Maybe Action

    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
  • imageUrl :: Maybe Text

    The URL of an image to display in a push notification that's based on the message template.

  • title :: Maybe Text

    The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

Instances

Instances details
Eq AndroidPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AndroidPushNotificationTemplate

Read AndroidPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AndroidPushNotificationTemplate

Show AndroidPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AndroidPushNotificationTemplate

Generic AndroidPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AndroidPushNotificationTemplate

Associated Types

type Rep AndroidPushNotificationTemplate :: Type -> Type #

NFData AndroidPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AndroidPushNotificationTemplate

Hashable AndroidPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AndroidPushNotificationTemplate

ToJSON AndroidPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AndroidPushNotificationTemplate

FromJSON AndroidPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AndroidPushNotificationTemplate

type Rep AndroidPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AndroidPushNotificationTemplate

type Rep AndroidPushNotificationTemplate = D1 ('MetaData "AndroidPushNotificationTemplate" "Amazonka.Pinpoint.Types.AndroidPushNotificationTemplate" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "AndroidPushNotificationTemplate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "imageIconUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "rawContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "smallImageIconUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Action)) :*: (S1 ('MetaSel ('Just "imageUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newAndroidPushNotificationTemplate :: AndroidPushNotificationTemplate Source #

Create a value of AndroidPushNotificationTemplate 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:imageIconUrl:AndroidPushNotificationTemplate', androidPushNotificationTemplate_imageIconUrl - The URL of the large icon image to display in the content view of a push notification that's based on the message template.

$sel:rawContent:AndroidPushNotificationTemplate', androidPushNotificationTemplate_rawContent - The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

$sel:smallImageIconUrl:AndroidPushNotificationTemplate', androidPushNotificationTemplate_smallImageIconUrl - The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

$sel:body:AndroidPushNotificationTemplate', androidPushNotificationTemplate_body - The message body to use in a push notification that's based on the message template.

$sel:url:AndroidPushNotificationTemplate', androidPushNotificationTemplate_url - The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

$sel:sound:AndroidPushNotificationTemplate', androidPushNotificationTemplate_sound - The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

$sel:action:AndroidPushNotificationTemplate', androidPushNotificationTemplate_action - The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

$sel:imageUrl:AndroidPushNotificationTemplate', androidPushNotificationTemplate_imageUrl - The URL of an image to display in a push notification that's based on the message template.

$sel:title:AndroidPushNotificationTemplate', androidPushNotificationTemplate_title - The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

androidPushNotificationTemplate_imageIconUrl :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #

The URL of the large icon image to display in the content view of a push notification that's based on the message template.

androidPushNotificationTemplate_rawContent :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

androidPushNotificationTemplate_smallImageIconUrl :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #

The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

androidPushNotificationTemplate_body :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #

The message body to use in a push notification that's based on the message template.

androidPushNotificationTemplate_url :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #

The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

androidPushNotificationTemplate_sound :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #

The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

androidPushNotificationTemplate_action :: Lens' AndroidPushNotificationTemplate (Maybe Action) Source #

The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

androidPushNotificationTemplate_imageUrl :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #

The URL of an image to display in a push notification that's based on the message template.

androidPushNotificationTemplate_title :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #

The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

ApplicationDateRangeKpiResponse

data ApplicationDateRangeKpiResponse Source #

Provides the results of a query that retrieved the data for a standard metric that applies to an application, and provides information about that query.

See: newApplicationDateRangeKpiResponse smart constructor.

Constructors

ApplicationDateRangeKpiResponse' 

Fields

  • nextToken :: Maybe Text

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Application Metrics resource because the resource returns all results in a single page.

  • kpiResult :: BaseKpiResult

    An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

  • kpiName :: Text

    The name of the metric, also referred to as a /key performance indicator (KPI)/, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

  • endTime :: POSIX

    The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

  • startTime :: POSIX

    The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

  • applicationId :: Text

    The unique identifier for the application that the metric applies to.

Instances

Instances details
Eq ApplicationDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

Read ApplicationDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

Show ApplicationDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

Generic ApplicationDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

Associated Types

type Rep ApplicationDateRangeKpiResponse :: Type -> Type #

NFData ApplicationDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

Hashable ApplicationDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

FromJSON ApplicationDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

type Rep ApplicationDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

type Rep ApplicationDateRangeKpiResponse = D1 ('MetaData "ApplicationDateRangeKpiResponse" "Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ApplicationDateRangeKpiResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "kpiResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BaseKpiResult) :*: S1 ('MetaSel ('Just "kpiName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newApplicationDateRangeKpiResponse Source #

Create a value of ApplicationDateRangeKpiResponse 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:nextToken:ApplicationDateRangeKpiResponse', applicationDateRangeKpiResponse_nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Application Metrics resource because the resource returns all results in a single page.

$sel:kpiResult:ApplicationDateRangeKpiResponse', applicationDateRangeKpiResponse_kpiResult - An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

$sel:kpiName:ApplicationDateRangeKpiResponse', applicationDateRangeKpiResponse_kpiName - The name of the metric, also referred to as a /key performance indicator (KPI)/, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

$sel:endTime:ApplicationDateRangeKpiResponse', applicationDateRangeKpiResponse_endTime - The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

$sel:startTime:ApplicationDateRangeKpiResponse', applicationDateRangeKpiResponse_startTime - The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

$sel:applicationId:ApplicationDateRangeKpiResponse', applicationDateRangeKpiResponse_applicationId - The unique identifier for the application that the metric applies to.

applicationDateRangeKpiResponse_nextToken :: Lens' ApplicationDateRangeKpiResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Application Metrics resource because the resource returns all results in a single page.

applicationDateRangeKpiResponse_kpiResult :: Lens' ApplicationDateRangeKpiResponse BaseKpiResult Source #

An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

applicationDateRangeKpiResponse_kpiName :: Lens' ApplicationDateRangeKpiResponse Text Source #

The name of the metric, also referred to as a /key performance indicator (KPI)/, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

applicationDateRangeKpiResponse_endTime :: Lens' ApplicationDateRangeKpiResponse UTCTime Source #

The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

applicationDateRangeKpiResponse_startTime :: Lens' ApplicationDateRangeKpiResponse UTCTime Source #

The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

applicationDateRangeKpiResponse_applicationId :: Lens' ApplicationDateRangeKpiResponse Text Source #

The unique identifier for the application that the metric applies to.

ApplicationResponse

data ApplicationResponse Source #

Provides information about an application.

See: newApplicationResponse smart constructor.

Constructors

ApplicationResponse' 

Fields

  • tags :: Maybe (HashMap Text Text)

    A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

  • id :: Text

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

  • arn :: Text

    The Amazon Resource Name (ARN) of the application.

  • name :: Text

    The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

Instances

Instances details
Eq ApplicationResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationResponse

Read ApplicationResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationResponse

Show ApplicationResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationResponse

Generic ApplicationResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationResponse

Associated Types

type Rep ApplicationResponse :: Type -> Type #

NFData ApplicationResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationResponse

Methods

rnf :: ApplicationResponse -> () #

Hashable ApplicationResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationResponse

FromJSON ApplicationResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationResponse

type Rep ApplicationResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationResponse

type Rep ApplicationResponse = D1 ('MetaData "ApplicationResponse" "Amazonka.Pinpoint.Types.ApplicationResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ApplicationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newApplicationResponse Source #

Create a value of ApplicationResponse 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:tags:ApplicationResponse', applicationResponse_tags - A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

$sel:id:ApplicationResponse', applicationResponse_id - The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

$sel:arn:ApplicationResponse', applicationResponse_arn - The Amazon Resource Name (ARN) of the application.

$sel:name:ApplicationResponse', applicationResponse_name - The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

applicationResponse_tags :: Lens' ApplicationResponse (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

applicationResponse_id :: Lens' ApplicationResponse Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

applicationResponse_arn :: Lens' ApplicationResponse Text Source #

The Amazon Resource Name (ARN) of the application.

applicationResponse_name :: Lens' ApplicationResponse Text Source #

The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

ApplicationSettingsResource

data ApplicationSettingsResource Source #

Provides information about an application, including the default settings for an application.

See: newApplicationSettingsResource smart constructor.

Constructors

ApplicationSettingsResource' 

Fields

  • lastModifiedDate :: Maybe Text

    The date and time, in ISO 8601 format, when the application's settings were last modified.

  • limits :: Maybe CampaignLimits

    The default sending limits for campaigns in the application.

  • quietTime :: Maybe QuietTime

    The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
    • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
    • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

  • campaignHook :: Maybe CampaignHook

    The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.

  • applicationId :: Text

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Instances

Instances details
Eq ApplicationSettingsResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationSettingsResource

Read ApplicationSettingsResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationSettingsResource

Show ApplicationSettingsResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationSettingsResource

Generic ApplicationSettingsResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationSettingsResource

Associated Types

type Rep ApplicationSettingsResource :: Type -> Type #

NFData ApplicationSettingsResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationSettingsResource

Hashable ApplicationSettingsResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationSettingsResource

FromJSON ApplicationSettingsResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationSettingsResource

type Rep ApplicationSettingsResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationSettingsResource

type Rep ApplicationSettingsResource = D1 ('MetaData "ApplicationSettingsResource" "Amazonka.Pinpoint.Types.ApplicationSettingsResource" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ApplicationSettingsResource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignLimits))) :*: (S1 ('MetaSel ('Just "quietTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuietTime)) :*: (S1 ('MetaSel ('Just "campaignHook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignHook)) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newApplicationSettingsResource Source #

Create a value of ApplicationSettingsResource 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:lastModifiedDate:ApplicationSettingsResource', applicationSettingsResource_lastModifiedDate - The date and time, in ISO 8601 format, when the application's settings were last modified.

$sel:limits:ApplicationSettingsResource', applicationSettingsResource_limits - The default sending limits for campaigns in the application.

$sel:quietTime:ApplicationSettingsResource', applicationSettingsResource_quietTime - The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

  • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
  • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
  • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

$sel:campaignHook:ApplicationSettingsResource', applicationSettingsResource_campaignHook - The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.

$sel:applicationId:ApplicationSettingsResource', applicationSettingsResource_applicationId - The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

applicationSettingsResource_lastModifiedDate :: Lens' ApplicationSettingsResource (Maybe Text) Source #

The date and time, in ISO 8601 format, when the application's settings were last modified.

applicationSettingsResource_limits :: Lens' ApplicationSettingsResource (Maybe CampaignLimits) Source #

The default sending limits for campaigns in the application.

applicationSettingsResource_quietTime :: Lens' ApplicationSettingsResource (Maybe QuietTime) Source #

The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

  • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
  • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
  • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

applicationSettingsResource_campaignHook :: Lens' ApplicationSettingsResource (Maybe CampaignHook) Source #

The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.

applicationSettingsResource_applicationId :: Lens' ApplicationSettingsResource Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

ApplicationsResponse

data ApplicationsResponse Source #

Provides information about all of your applications.

See: newApplicationsResponse smart constructor.

Constructors

ApplicationsResponse' 

Fields

  • nextToken :: Maybe Text

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

  • item :: Maybe [ApplicationResponse]

    An array of responses, one for each application that was returned.

Instances

Instances details
Eq ApplicationsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationsResponse

Read ApplicationsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationsResponse

Show ApplicationsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationsResponse

Generic ApplicationsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationsResponse

Associated Types

type Rep ApplicationsResponse :: Type -> Type #

NFData ApplicationsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationsResponse

Methods

rnf :: ApplicationsResponse -> () #

Hashable ApplicationsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationsResponse

FromJSON ApplicationsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationsResponse

type Rep ApplicationsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ApplicationsResponse

type Rep ApplicationsResponse = D1 ('MetaData "ApplicationsResponse" "Amazonka.Pinpoint.Types.ApplicationsResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ApplicationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ApplicationResponse]))))

newApplicationsResponse :: ApplicationsResponse Source #

Create a value of ApplicationsResponse 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:nextToken:ApplicationsResponse', applicationsResponse_nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

$sel:item:ApplicationsResponse', applicationsResponse_item - An array of responses, one for each application that was returned.

applicationsResponse_nextToken :: Lens' ApplicationsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

applicationsResponse_item :: Lens' ApplicationsResponse (Maybe [ApplicationResponse]) Source #

An array of responses, one for each application that was returned.

AttributeDimension

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
Eq AttributeDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeDimension

Read AttributeDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeDimension

Show AttributeDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeDimension

Generic AttributeDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeDimension

Associated Types

type Rep AttributeDimension :: Type -> Type #

NFData AttributeDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeDimension

Methods

rnf :: AttributeDimension -> () #

Hashable AttributeDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeDimension

ToJSON AttributeDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeDimension

FromJSON AttributeDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeDimension

type Rep AttributeDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributeDimension

type Rep AttributeDimension = D1 ('MetaData "AttributeDimension" "Amazonka.Pinpoint.Types.AttributeDimension" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" '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:

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.

attributeDimension_values :: Lens' AttributeDimension [Text] Source #

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.

AttributesResource

data AttributesResource Source #

Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.

See: newAttributesResource smart constructor.

Constructors

AttributesResource' 

Fields

  • attributes :: Maybe [Text]

    An array that specifies the names of the attributes that were removed from the endpoints.

  • attributeType :: Text

    The type of attribute or attributes that were removed from the endpoints. Valid values are:

    • endpoint-custom-attributes - Custom attributes that describe endpoints.
    • endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints.
    • endpoint-user-attributes - Custom attributes that describe users.
  • applicationId :: Text

    The unique identifier for the application.

Instances

Instances details
Eq AttributesResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributesResource

Read AttributesResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributesResource

Show AttributesResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributesResource

Generic AttributesResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributesResource

Associated Types

type Rep AttributesResource :: Type -> Type #

NFData AttributesResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributesResource

Methods

rnf :: AttributesResource -> () #

Hashable AttributesResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributesResource

FromJSON AttributesResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributesResource

type Rep AttributesResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.AttributesResource

type Rep AttributesResource = D1 ('MetaData "AttributesResource" "Amazonka.Pinpoint.Types.AttributesResource" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "AttributesResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "attributeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newAttributesResource Source #

Create a value of AttributesResource 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:attributes:AttributesResource', attributesResource_attributes - An array that specifies the names of the attributes that were removed from the endpoints.

$sel:attributeType:AttributesResource', attributesResource_attributeType - The type of attribute or attributes that were removed from the endpoints. Valid values are:

  • endpoint-custom-attributes - Custom attributes that describe endpoints.
  • endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints.
  • endpoint-user-attributes - Custom attributes that describe users.

$sel:applicationId:AttributesResource', attributesResource_applicationId - The unique identifier for the application.

attributesResource_attributes :: Lens' AttributesResource (Maybe [Text]) Source #

An array that specifies the names of the attributes that were removed from the endpoints.

attributesResource_attributeType :: Lens' AttributesResource Text Source #

The type of attribute or attributes that were removed from the endpoints. Valid values are:

  • endpoint-custom-attributes - Custom attributes that describe endpoints.
  • endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints.
  • endpoint-user-attributes - Custom attributes that describe users.

attributesResource_applicationId :: Lens' AttributesResource Text Source #

The unique identifier for the application.

BaiduChannelRequest

data BaiduChannelRequest Source #

Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

See: newBaiduChannelRequest smart constructor.

Constructors

BaiduChannelRequest' 

Fields

  • enabled :: Maybe Bool

    Specifies whether to enable the Baidu channel for the application.

  • secretKey :: Text

    The secret key that you received from the Baidu Cloud Push service to communicate with the service.

  • apiKey :: Text

    The API key that you received from the Baidu Cloud Push service to communicate with the service.

Instances

Instances details
Eq BaiduChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduChannelRequest

Read BaiduChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduChannelRequest

Show BaiduChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduChannelRequest

Generic BaiduChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduChannelRequest

Associated Types

type Rep BaiduChannelRequest :: Type -> Type #

NFData BaiduChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduChannelRequest

Methods

rnf :: BaiduChannelRequest -> () #

Hashable BaiduChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduChannelRequest

ToJSON BaiduChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduChannelRequest

type Rep BaiduChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduChannelRequest

type Rep BaiduChannelRequest = D1 ('MetaData "BaiduChannelRequest" "Amazonka.Pinpoint.Types.BaiduChannelRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "BaiduChannelRequest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "secretKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "apiKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newBaiduChannelRequest Source #

Create a value of BaiduChannelRequest 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:enabled:BaiduChannelRequest', baiduChannelRequest_enabled - Specifies whether to enable the Baidu channel for the application.

$sel:secretKey:BaiduChannelRequest', baiduChannelRequest_secretKey - The secret key that you received from the Baidu Cloud Push service to communicate with the service.

$sel:apiKey:BaiduChannelRequest', baiduChannelRequest_apiKey - The API key that you received from the Baidu Cloud Push service to communicate with the service.

baiduChannelRequest_enabled :: Lens' BaiduChannelRequest (Maybe Bool) Source #

Specifies whether to enable the Baidu channel for the application.

baiduChannelRequest_secretKey :: Lens' BaiduChannelRequest Text Source #

The secret key that you received from the Baidu Cloud Push service to communicate with the service.

baiduChannelRequest_apiKey :: Lens' BaiduChannelRequest Text Source #

The API key that you received from the Baidu Cloud Push service to communicate with the service.

BaiduChannelResponse

data BaiduChannelResponse Source #

Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

See: newBaiduChannelResponse smart constructor.

Constructors

BaiduChannelResponse' 

Fields

  • lastModifiedDate :: Maybe Text

    The date and time when the Baidu channel was last modified.

  • enabled :: Maybe Bool

    Specifies whether the Baidu channel is enabled for the application.

  • isArchived :: Maybe Bool

    Specifies whether the Baidu channel is archived.

  • applicationId :: Maybe Text

    The unique identifier for the application that the Baidu channel applies to.

  • version :: Maybe Int

    The current version of the Baidu channel.

  • id :: Maybe Text

    (Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.

  • creationDate :: Maybe Text

    The date and time when the Baidu channel was enabled.

  • lastModifiedBy :: Maybe Text

    The user who last modified the Baidu channel.

  • hasCredential :: Maybe Bool

    (Not used) This property is retained only for backward compatibility.

  • credential :: Text

    The API key that you received from the Baidu Cloud Push service to communicate with the service.

  • platform :: Text

    The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.

Instances

Instances details
Eq BaiduChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduChannelResponse

Read BaiduChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduChannelResponse

Show BaiduChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduChannelResponse

Generic BaiduChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduChannelResponse

Associated Types

type Rep BaiduChannelResponse :: Type -> Type #

NFData BaiduChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduChannelResponse

Methods

rnf :: BaiduChannelResponse -> () #

Hashable BaiduChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduChannelResponse

FromJSON BaiduChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduChannelResponse

type Rep BaiduChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduChannelResponse

type Rep BaiduChannelResponse = D1 ('MetaData "BaiduChannelResponse" "Amazonka.Pinpoint.Types.BaiduChannelResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "BaiduChannelResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "isArchived") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "hasCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "credential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newBaiduChannelResponse Source #

Create a value of BaiduChannelResponse 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:lastModifiedDate:BaiduChannelResponse', baiduChannelResponse_lastModifiedDate - The date and time when the Baidu channel was last modified.

$sel:enabled:BaiduChannelResponse', baiduChannelResponse_enabled - Specifies whether the Baidu channel is enabled for the application.

$sel:isArchived:BaiduChannelResponse', baiduChannelResponse_isArchived - Specifies whether the Baidu channel is archived.

$sel:applicationId:BaiduChannelResponse', baiduChannelResponse_applicationId - The unique identifier for the application that the Baidu channel applies to.

$sel:version:BaiduChannelResponse', baiduChannelResponse_version - The current version of the Baidu channel.

$sel:id:BaiduChannelResponse', baiduChannelResponse_id - (Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.

$sel:creationDate:BaiduChannelResponse', baiduChannelResponse_creationDate - The date and time when the Baidu channel was enabled.

$sel:lastModifiedBy:BaiduChannelResponse', baiduChannelResponse_lastModifiedBy - The user who last modified the Baidu channel.

$sel:hasCredential:BaiduChannelResponse', baiduChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.

$sel:credential:BaiduChannelResponse', baiduChannelResponse_credential - The API key that you received from the Baidu Cloud Push service to communicate with the service.

$sel:platform:BaiduChannelResponse', baiduChannelResponse_platform - The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.

baiduChannelResponse_lastModifiedDate :: Lens' BaiduChannelResponse (Maybe Text) Source #

The date and time when the Baidu channel was last modified.

baiduChannelResponse_enabled :: Lens' BaiduChannelResponse (Maybe Bool) Source #

Specifies whether the Baidu channel is enabled for the application.

baiduChannelResponse_isArchived :: Lens' BaiduChannelResponse (Maybe Bool) Source #

Specifies whether the Baidu channel is archived.

baiduChannelResponse_applicationId :: Lens' BaiduChannelResponse (Maybe Text) Source #

The unique identifier for the application that the Baidu channel applies to.

baiduChannelResponse_version :: Lens' BaiduChannelResponse (Maybe Int) Source #

The current version of the Baidu channel.

baiduChannelResponse_id :: Lens' BaiduChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.

baiduChannelResponse_creationDate :: Lens' BaiduChannelResponse (Maybe Text) Source #

The date and time when the Baidu channel was enabled.

baiduChannelResponse_lastModifiedBy :: Lens' BaiduChannelResponse (Maybe Text) Source #

The user who last modified the Baidu channel.

baiduChannelResponse_hasCredential :: Lens' BaiduChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

baiduChannelResponse_credential :: Lens' BaiduChannelResponse Text Source #

The API key that you received from the Baidu Cloud Push service to communicate with the service.

baiduChannelResponse_platform :: Lens' BaiduChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.

BaiduMessage

data BaiduMessage Source #

Specifies the settings for a one-time message that's sent directly to an endpoint through the Baidu (Baidu Cloud Push) channel.

See: newBaiduMessage smart constructor.

Constructors

BaiduMessage' 

Fields

  • substitutions :: Maybe (HashMap Text [Text])

    The default message variables to use in the notification message. You can override the default variables with individual address variables.

  • silentPush :: Maybe Bool

    Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

  • imageIconUrl :: Maybe Text

    The URL of the large icon image to display in the content view of the push notification.

  • rawContent :: Maybe Text

    The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

  • data' :: Maybe (HashMap Text Text)

    The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

  • smallImageIconUrl :: Maybe Text

    The URL of the small icon image to display in the status bar and the content view of the push notification.

  • body :: Maybe Text

    The body of the notification message.

  • timeToLive :: Maybe Int

    The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).

  • url :: Maybe Text

    The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

  • sound :: Maybe Text

    The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

  • action :: Maybe Action

    The action to occur if the recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
  • imageUrl :: Maybe Text

    The URL of an image to display in the push notification.

  • title :: Maybe Text

    The title to display above the notification message on the recipient's device.

  • iconReference :: Maybe Text

    The icon image name of the asset saved in your app.

Instances

Instances details
Eq BaiduMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduMessage

Read BaiduMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduMessage

Show BaiduMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduMessage

Generic BaiduMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduMessage

Associated Types

type Rep BaiduMessage :: Type -> Type #

NFData BaiduMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduMessage

Methods

rnf :: BaiduMessage -> () #

Hashable BaiduMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduMessage

ToJSON BaiduMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduMessage

type Rep BaiduMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaiduMessage

type Rep BaiduMessage = D1 ('MetaData "BaiduMessage" "Amazonka.Pinpoint.Types.BaiduMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "BaiduMessage'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "substitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: (S1 ('MetaSel ('Just "silentPush") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "imageIconUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "rawContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "smallImageIconUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "timeToLive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Action)) :*: S1 ('MetaSel ('Just "imageUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iconReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newBaiduMessage :: BaiduMessage Source #

Create a value of BaiduMessage 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:substitutions:BaiduMessage', baiduMessage_substitutions - The default message variables to use in the notification message. You can override the default variables with individual address variables.

$sel:silentPush:BaiduMessage', baiduMessage_silentPush - Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

$sel:imageIconUrl:BaiduMessage', baiduMessage_imageIconUrl - The URL of the large icon image to display in the content view of the push notification.

$sel:rawContent:BaiduMessage', baiduMessage_rawContent - The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

$sel:data':BaiduMessage', baiduMessage_data - The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

$sel:smallImageIconUrl:BaiduMessage', baiduMessage_smallImageIconUrl - The URL of the small icon image to display in the status bar and the content view of the push notification.

$sel:body:BaiduMessage', baiduMessage_body - The body of the notification message.

$sel:timeToLive:BaiduMessage', baiduMessage_timeToLive - The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).

$sel:url:BaiduMessage', baiduMessage_url - The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

$sel:sound:BaiduMessage', baiduMessage_sound - The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

$sel:action:BaiduMessage', baiduMessage_action - The action to occur if the recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

$sel:imageUrl:BaiduMessage', baiduMessage_imageUrl - The URL of an image to display in the push notification.

$sel:title:BaiduMessage', baiduMessage_title - The title to display above the notification message on the recipient's device.

$sel:iconReference:BaiduMessage', baiduMessage_iconReference - The icon image name of the asset saved in your app.

baiduMessage_substitutions :: Lens' BaiduMessage (Maybe (HashMap Text [Text])) Source #

The default message variables to use in the notification message. You can override the default variables with individual address variables.

baiduMessage_silentPush :: Lens' BaiduMessage (Maybe Bool) Source #

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

baiduMessage_imageIconUrl :: Lens' BaiduMessage (Maybe Text) Source #

The URL of the large icon image to display in the content view of the push notification.

baiduMessage_rawContent :: Lens' BaiduMessage (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

baiduMessage_data :: Lens' BaiduMessage (Maybe (HashMap Text Text)) Source #

The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

baiduMessage_smallImageIconUrl :: Lens' BaiduMessage (Maybe Text) Source #

The URL of the small icon image to display in the status bar and the content view of the push notification.

baiduMessage_body :: Lens' BaiduMessage (Maybe Text) Source #

The body of the notification message.

baiduMessage_timeToLive :: Lens' BaiduMessage (Maybe Int) Source #

The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).

baiduMessage_url :: Lens' BaiduMessage (Maybe Text) Source #

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

baiduMessage_sound :: Lens' BaiduMessage (Maybe Text) Source #

The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

baiduMessage_action :: Lens' BaiduMessage (Maybe Action) Source #

The action to occur if the recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

baiduMessage_imageUrl :: Lens' BaiduMessage (Maybe Text) Source #

The URL of an image to display in the push notification.

baiduMessage_title :: Lens' BaiduMessage (Maybe Text) Source #

The title to display above the notification message on the recipient's device.

baiduMessage_iconReference :: Lens' BaiduMessage (Maybe Text) Source #

The icon image name of the asset saved in your app.

BaseKpiResult

data BaseKpiResult Source #

Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

See: newBaseKpiResult smart constructor.

Constructors

BaseKpiResult' 

Fields

  • rows :: [ResultRow]

    An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

Instances

Instances details
Eq BaseKpiResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaseKpiResult

Read BaseKpiResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaseKpiResult

Show BaseKpiResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaseKpiResult

Generic BaseKpiResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaseKpiResult

Associated Types

type Rep BaseKpiResult :: Type -> Type #

NFData BaseKpiResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaseKpiResult

Methods

rnf :: BaseKpiResult -> () #

Hashable BaseKpiResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaseKpiResult

FromJSON BaseKpiResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaseKpiResult

type Rep BaseKpiResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.BaseKpiResult

type Rep BaseKpiResult = D1 ('MetaData "BaseKpiResult" "Amazonka.Pinpoint.Types.BaseKpiResult" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "BaseKpiResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ResultRow])))

newBaseKpiResult :: BaseKpiResult Source #

Create a value of BaseKpiResult 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:rows:BaseKpiResult', baseKpiResult_rows - An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

baseKpiResult_rows :: Lens' BaseKpiResult [ResultRow] Source #

An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

CampaignCustomMessage

data CampaignCustomMessage Source #

Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.

See: newCampaignCustomMessage smart constructor.

Constructors

CampaignCustomMessage' 

Fields

  • data' :: Maybe Text

    The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.

Instances

Instances details
Eq CampaignCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignCustomMessage

Read CampaignCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignCustomMessage

Show CampaignCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignCustomMessage

Generic CampaignCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignCustomMessage

Associated Types

type Rep CampaignCustomMessage :: Type -> Type #

NFData CampaignCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignCustomMessage

Methods

rnf :: CampaignCustomMessage -> () #

Hashable CampaignCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignCustomMessage

ToJSON CampaignCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignCustomMessage

FromJSON CampaignCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignCustomMessage

type Rep CampaignCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignCustomMessage

type Rep CampaignCustomMessage = D1 ('MetaData "CampaignCustomMessage" "Amazonka.Pinpoint.Types.CampaignCustomMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CampaignCustomMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newCampaignCustomMessage :: CampaignCustomMessage Source #

Create a value of CampaignCustomMessage 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:data':CampaignCustomMessage', campaignCustomMessage_data - The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.

campaignCustomMessage_data :: Lens' CampaignCustomMessage (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.

CampaignDateRangeKpiResponse

data CampaignDateRangeKpiResponse Source #

Provides the results of a query that retrieved the data for a standard metric that applies to a campaign, and provides information about that query.

See: newCampaignDateRangeKpiResponse smart constructor.

Constructors

CampaignDateRangeKpiResponse' 

Fields

  • nextToken :: Maybe Text

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.

  • kpiResult :: BaseKpiResult

    An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

  • kpiName :: Text

    The name of the metric, also referred to as a /key performance indicator (KPI)/, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

  • endTime :: POSIX

    The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

  • campaignId :: Text

    The unique identifier for the campaign that the metric applies to.

  • startTime :: POSIX

    The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

  • applicationId :: Text

    The unique identifier for the application that the metric applies to.

Instances

Instances details
Eq CampaignDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignDateRangeKpiResponse

Read CampaignDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignDateRangeKpiResponse

Show CampaignDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignDateRangeKpiResponse

Generic CampaignDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignDateRangeKpiResponse

Associated Types

type Rep CampaignDateRangeKpiResponse :: Type -> Type #

NFData CampaignDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignDateRangeKpiResponse

Hashable CampaignDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignDateRangeKpiResponse

FromJSON CampaignDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignDateRangeKpiResponse

type Rep CampaignDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignDateRangeKpiResponse

type Rep CampaignDateRangeKpiResponse = D1 ('MetaData "CampaignDateRangeKpiResponse" "Amazonka.Pinpoint.Types.CampaignDateRangeKpiResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CampaignDateRangeKpiResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "kpiResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BaseKpiResult) :*: S1 ('MetaSel ('Just "kpiName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "campaignId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCampaignDateRangeKpiResponse Source #

Create a value of CampaignDateRangeKpiResponse 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:nextToken:CampaignDateRangeKpiResponse', campaignDateRangeKpiResponse_nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.

$sel:kpiResult:CampaignDateRangeKpiResponse', campaignDateRangeKpiResponse_kpiResult - An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

$sel:kpiName:CampaignDateRangeKpiResponse', campaignDateRangeKpiResponse_kpiName - The name of the metric, also referred to as a /key performance indicator (KPI)/, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

$sel:endTime:CampaignDateRangeKpiResponse', campaignDateRangeKpiResponse_endTime - The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

$sel:campaignId:CampaignDateRangeKpiResponse', campaignDateRangeKpiResponse_campaignId - The unique identifier for the campaign that the metric applies to.

$sel:startTime:CampaignDateRangeKpiResponse', campaignDateRangeKpiResponse_startTime - The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

$sel:applicationId:CampaignDateRangeKpiResponse', campaignDateRangeKpiResponse_applicationId - The unique identifier for the application that the metric applies to.

campaignDateRangeKpiResponse_nextToken :: Lens' CampaignDateRangeKpiResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.

campaignDateRangeKpiResponse_kpiResult :: Lens' CampaignDateRangeKpiResponse BaseKpiResult Source #

An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

campaignDateRangeKpiResponse_kpiName :: Lens' CampaignDateRangeKpiResponse Text Source #

The name of the metric, also referred to as a /key performance indicator (KPI)/, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

campaignDateRangeKpiResponse_endTime :: Lens' CampaignDateRangeKpiResponse UTCTime Source #

The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

campaignDateRangeKpiResponse_campaignId :: Lens' CampaignDateRangeKpiResponse Text Source #

The unique identifier for the campaign that the metric applies to.

campaignDateRangeKpiResponse_startTime :: Lens' CampaignDateRangeKpiResponse UTCTime Source #

The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

campaignDateRangeKpiResponse_applicationId :: Lens' CampaignDateRangeKpiResponse Text Source #

The unique identifier for the application that the metric applies to.

CampaignEmailMessage

data CampaignEmailMessage Source #

Specifies the content and "From" address for an email message that's sent to recipients of a campaign.

See: newCampaignEmailMessage smart constructor.

Constructors

CampaignEmailMessage' 

Fields

  • body :: Maybe Text

    The body of the email for recipients whose email clients don't render HTML content.

  • fromAddress :: Maybe Text

    The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

  • htmlBody :: Maybe Text

    The body of the email, in HTML format, for recipients whose email clients render HTML content.

  • title :: Maybe Text

    The subject line, or title, of the email.

Instances

Instances details
Eq CampaignEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEmailMessage

Read CampaignEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEmailMessage

Show CampaignEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEmailMessage

Generic CampaignEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEmailMessage

Associated Types

type Rep CampaignEmailMessage :: Type -> Type #

NFData CampaignEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEmailMessage

Methods

rnf :: CampaignEmailMessage -> () #

Hashable CampaignEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEmailMessage

ToJSON CampaignEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEmailMessage

FromJSON CampaignEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEmailMessage

type Rep CampaignEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEmailMessage

type Rep CampaignEmailMessage = D1 ('MetaData "CampaignEmailMessage" "Amazonka.Pinpoint.Types.CampaignEmailMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CampaignEmailMessage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fromAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "htmlBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCampaignEmailMessage :: CampaignEmailMessage Source #

Create a value of CampaignEmailMessage 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:body:CampaignEmailMessage', campaignEmailMessage_body - The body of the email for recipients whose email clients don't render HTML content.

$sel:fromAddress:CampaignEmailMessage', campaignEmailMessage_fromAddress - The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

$sel:htmlBody:CampaignEmailMessage', campaignEmailMessage_htmlBody - The body of the email, in HTML format, for recipients whose email clients render HTML content.

$sel:title:CampaignEmailMessage', campaignEmailMessage_title - The subject line, or title, of the email.

campaignEmailMessage_body :: Lens' CampaignEmailMessage (Maybe Text) Source #

The body of the email for recipients whose email clients don't render HTML content.

campaignEmailMessage_fromAddress :: Lens' CampaignEmailMessage (Maybe Text) Source #

The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

campaignEmailMessage_htmlBody :: Lens' CampaignEmailMessage (Maybe Text) Source #

The body of the email, in HTML format, for recipients whose email clients render HTML content.

campaignEmailMessage_title :: Lens' CampaignEmailMessage (Maybe Text) Source #

The subject line, or title, of the email.

CampaignEventFilter

data CampaignEventFilter Source #

Specifies the settings for events that cause a campaign to be sent.

See: newCampaignEventFilter smart constructor.

Constructors

CampaignEventFilter' 

Fields

  • filterType :: FilterType

    The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.

  • dimensions :: EventDimensions

    The dimension settings of the event filter for the campaign.

Instances

Instances details
Eq CampaignEventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEventFilter

Read CampaignEventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEventFilter

Show CampaignEventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEventFilter

Generic CampaignEventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEventFilter

Associated Types

type Rep CampaignEventFilter :: Type -> Type #

NFData CampaignEventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEventFilter

Methods

rnf :: CampaignEventFilter -> () #

Hashable CampaignEventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEventFilter

ToJSON CampaignEventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEventFilter

FromJSON CampaignEventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEventFilter

type Rep CampaignEventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignEventFilter

type Rep CampaignEventFilter = D1 ('MetaData "CampaignEventFilter" "Amazonka.Pinpoint.Types.CampaignEventFilter" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CampaignEventFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filterType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilterType) :*: S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EventDimensions)))

newCampaignEventFilter Source #

Create a value of CampaignEventFilter 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:filterType:CampaignEventFilter', campaignEventFilter_filterType - The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.

$sel:dimensions:CampaignEventFilter', campaignEventFilter_dimensions - The dimension settings of the event filter for the campaign.

campaignEventFilter_filterType :: Lens' CampaignEventFilter FilterType Source #

The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.

campaignEventFilter_dimensions :: Lens' CampaignEventFilter EventDimensions Source #

The dimension settings of the event filter for the campaign.

CampaignHook

data CampaignHook Source #

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.

See: newCampaignHook smart constructor.

Constructors

CampaignHook' 

Fields

  • lambdaFunctionName :: Maybe Text

    The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

  • mode :: Maybe Mode

    The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:

    • FILTER - Invoke the function to customize the segment that's used by a campaign.
    • DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
  • webUrl :: Maybe Text

    The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

Instances

Instances details
Eq CampaignHook Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignHook

Read CampaignHook Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignHook

Show CampaignHook Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignHook

Generic CampaignHook Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignHook

Associated Types

type Rep CampaignHook :: Type -> Type #

NFData CampaignHook Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignHook

Methods

rnf :: CampaignHook -> () #

Hashable CampaignHook Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignHook

ToJSON CampaignHook Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignHook

FromJSON CampaignHook Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignHook

type Rep CampaignHook Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignHook

type Rep CampaignHook = D1 ('MetaData "CampaignHook" "Amazonka.Pinpoint.Types.CampaignHook" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CampaignHook'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lambdaFunctionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Mode)) :*: S1 ('MetaSel ('Just "webUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCampaignHook :: CampaignHook Source #

Create a value of CampaignHook 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:lambdaFunctionName:CampaignHook', campaignHook_lambdaFunctionName - The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

$sel:mode:CampaignHook', campaignHook_mode - The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:

  • FILTER - Invoke the function to customize the segment that's used by a campaign.
  • DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.

$sel:webUrl:CampaignHook', campaignHook_webUrl - The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

campaignHook_lambdaFunctionName :: Lens' CampaignHook (Maybe Text) Source #

The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

campaignHook_mode :: Lens' CampaignHook (Maybe Mode) Source #

The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:

  • FILTER - Invoke the function to customize the segment that's used by a campaign.
  • DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.

campaignHook_webUrl :: Lens' CampaignHook (Maybe Text) Source #

The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

CampaignInAppMessage

data CampaignInAppMessage Source #

In-app message configuration.

See: newCampaignInAppMessage smart constructor.

Constructors

CampaignInAppMessage' 

Fields

Instances

Instances details
Eq CampaignInAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignInAppMessage

Read CampaignInAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignInAppMessage

Show CampaignInAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignInAppMessage

Generic CampaignInAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignInAppMessage

Associated Types

type Rep CampaignInAppMessage :: Type -> Type #

NFData CampaignInAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignInAppMessage

Methods

rnf :: CampaignInAppMessage -> () #

Hashable CampaignInAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignInAppMessage

ToJSON CampaignInAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignInAppMessage

FromJSON CampaignInAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignInAppMessage

type Rep CampaignInAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignInAppMessage

type Rep CampaignInAppMessage = D1 ('MetaData "CampaignInAppMessage" "Amazonka.Pinpoint.Types.CampaignInAppMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CampaignInAppMessage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "layout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Layout)) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InAppMessageContent])) :*: S1 ('MetaSel ('Just "customConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))

newCampaignInAppMessage :: CampaignInAppMessage Source #

Create a value of CampaignInAppMessage 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:layout:CampaignInAppMessage', campaignInAppMessage_layout - In-app message layout.

$sel:body:CampaignInAppMessage', campaignInAppMessage_body - The message body of the notification, the email body or the text message.

$sel:content:CampaignInAppMessage', campaignInAppMessage_content - In-app message content.

$sel:customConfig:CampaignInAppMessage', campaignInAppMessage_customConfig - Custom config to be sent to client.

campaignInAppMessage_body :: Lens' CampaignInAppMessage (Maybe Text) Source #

The message body of the notification, the email body or the text message.

CampaignLimits

data CampaignLimits Source #

For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns in the application can send.

See: newCampaignLimits smart constructor.

Constructors

CampaignLimits' 

Fields

  • messagesPerSecond :: Maybe Int

    The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.

  • daily :: Maybe Int

    The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.

  • total :: Maybe Int

    The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.

  • session :: Maybe Int

    The maximum total number of messages that the campaign can send per user session.

  • maximumDuration :: Maybe Int

    The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

Instances

Instances details
Eq CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

Read CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

Show CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

Generic CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

Associated Types

type Rep CampaignLimits :: Type -> Type #

NFData CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

Methods

rnf :: CampaignLimits -> () #

Hashable CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

ToJSON CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

FromJSON CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

type Rep CampaignLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignLimits

type Rep CampaignLimits = D1 ('MetaData "CampaignLimits" "Amazonka.Pinpoint.Types.CampaignLimits" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CampaignLimits'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "messagesPerSecond") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "daily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "total") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "session") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "maximumDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newCampaignLimits :: CampaignLimits Source #

Create a value of CampaignLimits 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:messagesPerSecond:CampaignLimits', campaignLimits_messagesPerSecond - The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.

$sel:daily:CampaignLimits', campaignLimits_daily - The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.

$sel:total:CampaignLimits', campaignLimits_total - The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.

$sel:session:CampaignLimits', campaignLimits_session - The maximum total number of messages that the campaign can send per user session.

$sel:maximumDuration:CampaignLimits', campaignLimits_maximumDuration - The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

campaignLimits_messagesPerSecond :: Lens' CampaignLimits (Maybe Int) Source #

The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.

campaignLimits_daily :: Lens' CampaignLimits (Maybe Int) Source #

The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.

campaignLimits_total :: Lens' CampaignLimits (Maybe Int) Source #

The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.

campaignLimits_session :: Lens' CampaignLimits (Maybe Int) Source #

The maximum total number of messages that the campaign can send per user session.

campaignLimits_maximumDuration :: Lens' CampaignLimits (Maybe Int) Source #

The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

CampaignResponse

data CampaignResponse Source #

Provides information about the status, configuration, and other settings for a campaign.

See: newCampaignResponse smart constructor.

Constructors

CampaignResponse' 

Fields

Instances

Instances details
Eq CampaignResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignResponse

Read CampaignResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignResponse

Show CampaignResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignResponse

Generic CampaignResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignResponse

Associated Types

type Rep CampaignResponse :: Type -> Type #

NFData CampaignResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignResponse

Methods

rnf :: CampaignResponse -> () #

Hashable CampaignResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignResponse

FromJSON CampaignResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignResponse

type Rep CampaignResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignResponse

type Rep CampaignResponse = D1 ('MetaData "CampaignResponse" "Amazonka.Pinpoint.Types.CampaignResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CampaignResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "customDeliveryConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomDeliveryConfiguration)) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignState)) :*: S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Schedule)) :*: (S1 ('MetaSel ('Just "templateConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateConfiguration)) :*: S1 ('MetaSel ('Just "hook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignHook))))) :*: ((S1 ('MetaSel ('Just "treatmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "limits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignLimits)) :*: S1 ('MetaSel ('Just "isPaused") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "defaultState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignState)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))) :*: (((S1 ('MetaSel ('Just "holdoutPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "treatmentDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "messageConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageConfiguration)))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "additionalTreatments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TreatmentResource])) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))) :*: ((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "segmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "segmentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newCampaignResponse Source #

Create a value of CampaignResponse 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:customDeliveryConfiguration:CampaignResponse', campaignResponse_customDeliveryConfiguration - The delivery configuration settings for sending the campaign through a custom channel.

$sel:state:CampaignResponse', campaignResponse_state - The current status of the campaign.

$sel:priority:CampaignResponse', campaignResponse_priority - Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.

$sel:schedule:CampaignResponse', campaignResponse_schedule - The schedule settings for the campaign.

$sel:templateConfiguration:CampaignResponse', campaignResponse_templateConfiguration - The message template that’s used for the campaign.

$sel:hook:CampaignResponse', campaignResponse_hook - The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

$sel:treatmentName:CampaignResponse', campaignResponse_treatmentName - The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

$sel:limits:CampaignResponse', campaignResponse_limits - The messaging limits for the campaign.

$sel:isPaused:CampaignResponse', campaignResponse_isPaused - Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

$sel:defaultState:CampaignResponse', campaignResponse_defaultState - The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

$sel:name:CampaignResponse', campaignResponse_name - The name of the campaign.

$sel:version:CampaignResponse', campaignResponse_version - The version number of the campaign.

$sel:holdoutPercent:CampaignResponse', campaignResponse_holdoutPercent - The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

$sel:treatmentDescription:CampaignResponse', campaignResponse_treatmentDescription - The custom description of the default treatment for the campaign.

$sel:messageConfiguration:CampaignResponse', campaignResponse_messageConfiguration - The message configuration settings for the campaign.

$sel:description:CampaignResponse', campaignResponse_description - The custom description of the campaign.

$sel:additionalTreatments:CampaignResponse', campaignResponse_additionalTreatments - An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

$sel:tags:CampaignResponse', campaignResponse_tags - A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

$sel:lastModifiedDate:CampaignResponse', campaignResponse_lastModifiedDate - The date, in ISO 8601 format, when the campaign was last modified.

$sel:creationDate:CampaignResponse', campaignResponse_creationDate - The date, in ISO 8601 format, when the campaign was created.

$sel:segmentId:CampaignResponse', campaignResponse_segmentId - The unique identifier for the segment that's associated with the campaign.

$sel:segmentVersion:CampaignResponse', campaignResponse_segmentVersion - The version number of the segment that's associated with the campaign.

$sel:id:CampaignResponse', campaignResponse_id - The unique identifier for the campaign.

$sel:arn:CampaignResponse', campaignResponse_arn - The Amazon Resource Name (ARN) of the campaign.

$sel:applicationId:CampaignResponse', campaignResponse_applicationId - The unique identifier for the application that the campaign applies to.

campaignResponse_customDeliveryConfiguration :: Lens' CampaignResponse (Maybe CustomDeliveryConfiguration) Source #

The delivery configuration settings for sending the campaign through a custom channel.

campaignResponse_state :: Lens' CampaignResponse (Maybe CampaignState) Source #

The current status of the campaign.

campaignResponse_priority :: Lens' CampaignResponse (Maybe Int) Source #

Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.

campaignResponse_schedule :: Lens' CampaignResponse (Maybe Schedule) Source #

The schedule settings for the campaign.

campaignResponse_templateConfiguration :: Lens' CampaignResponse (Maybe TemplateConfiguration) Source #

The message template that’s used for the campaign.

campaignResponse_hook :: Lens' CampaignResponse (Maybe CampaignHook) Source #

The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

campaignResponse_treatmentName :: Lens' CampaignResponse (Maybe Text) Source #

The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

campaignResponse_limits :: Lens' CampaignResponse (Maybe CampaignLimits) Source #

The messaging limits for the campaign.

campaignResponse_isPaused :: Lens' CampaignResponse (Maybe Bool) Source #

Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

campaignResponse_defaultState :: Lens' CampaignResponse (Maybe CampaignState) Source #

The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

campaignResponse_version :: Lens' CampaignResponse (Maybe Int) Source #

The version number of the campaign.

campaignResponse_holdoutPercent :: Lens' CampaignResponse (Maybe Int) Source #

The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

campaignResponse_treatmentDescription :: Lens' CampaignResponse (Maybe Text) Source #

The custom description of the default treatment for the campaign.

campaignResponse_messageConfiguration :: Lens' CampaignResponse (Maybe MessageConfiguration) Source #

The message configuration settings for the campaign.

campaignResponse_description :: Lens' CampaignResponse (Maybe Text) Source #

The custom description of the campaign.

campaignResponse_additionalTreatments :: Lens' CampaignResponse (Maybe [TreatmentResource]) Source #

An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

campaignResponse_tags :: Lens' CampaignResponse (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

campaignResponse_lastModifiedDate :: Lens' CampaignResponse Text Source #

The date, in ISO 8601 format, when the campaign was last modified.

campaignResponse_creationDate :: Lens' CampaignResponse Text Source #

The date, in ISO 8601 format, when the campaign was created.

campaignResponse_segmentId :: Lens' CampaignResponse Text Source #

The unique identifier for the segment that's associated with the campaign.

campaignResponse_segmentVersion :: Lens' CampaignResponse Int Source #

The version number of the segment that's associated with the campaign.

campaignResponse_id :: Lens' CampaignResponse Text Source #

The unique identifier for the campaign.

campaignResponse_arn :: Lens' CampaignResponse Text Source #

The Amazon Resource Name (ARN) of the campaign.

campaignResponse_applicationId :: Lens' CampaignResponse Text Source #

The unique identifier for the application that the campaign applies to.

CampaignSmsMessage

data CampaignSmsMessage Source #

Specifies the content and settings for an SMS message that's sent to recipients of a campaign.

See: newCampaignSmsMessage smart constructor.

Constructors

CampaignSmsMessage' 

Fields

  • originationNumber :: Maybe Text

    The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

  • templateId :: Maybe Text

    The template ID received from the regulatory body for sending SMS in your country.

  • body :: Maybe Text

    The body of the SMS message.

  • messageType :: Maybe MessageType

    The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

  • senderId :: Maybe Text

    The sender ID to display on recipients' devices when they receive the SMS message.

  • entityId :: Maybe Text

    The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

Instances

Instances details
Eq CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

Read CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

Show CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

Generic CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

Associated Types

type Rep CampaignSmsMessage :: Type -> Type #

NFData CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

Methods

rnf :: CampaignSmsMessage -> () #

Hashable CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

ToJSON CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

FromJSON CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

type Rep CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

type Rep CampaignSmsMessage = D1 ('MetaData "CampaignSmsMessage" "Amazonka.Pinpoint.Types.CampaignSmsMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CampaignSmsMessage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "originationNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "templateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "messageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageType)) :*: (S1 ('MetaSel ('Just "senderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newCampaignSmsMessage :: CampaignSmsMessage Source #

Create a value of CampaignSmsMessage 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:originationNumber:CampaignSmsMessage', campaignSmsMessage_originationNumber - The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

$sel:templateId:CampaignSmsMessage', campaignSmsMessage_templateId - The template ID received from the regulatory body for sending SMS in your country.

$sel:body:CampaignSmsMessage', campaignSmsMessage_body - The body of the SMS message.

$sel:messageType:CampaignSmsMessage', campaignSmsMessage_messageType - The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

$sel:senderId:CampaignSmsMessage', campaignSmsMessage_senderId - The sender ID to display on recipients' devices when they receive the SMS message.

$sel:entityId:CampaignSmsMessage', campaignSmsMessage_entityId - The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

campaignSmsMessage_originationNumber :: Lens' CampaignSmsMessage (Maybe Text) Source #

The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

campaignSmsMessage_templateId :: Lens' CampaignSmsMessage (Maybe Text) Source #

The template ID received from the regulatory body for sending SMS in your country.

campaignSmsMessage_messageType :: Lens' CampaignSmsMessage (Maybe MessageType) Source #

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

campaignSmsMessage_senderId :: Lens' CampaignSmsMessage (Maybe Text) Source #

The sender ID to display on recipients' devices when they receive the SMS message.

campaignSmsMessage_entityId :: Lens' CampaignSmsMessage (Maybe Text) Source #

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

CampaignState

data CampaignState Source #

Provides information about the status of a campaign.

See: newCampaignState smart constructor.

Constructors

CampaignState' 

Fields

  • campaignStatus :: Maybe CampaignStatus

    The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

    If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

Instances

Instances details
Eq CampaignState Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignState

Read CampaignState Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignState

Show CampaignState Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignState

Generic CampaignState Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignState

Associated Types

type Rep CampaignState :: Type -> Type #

NFData CampaignState Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignState

Methods

rnf :: CampaignState -> () #

Hashable CampaignState Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignState

FromJSON CampaignState Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignState

type Rep CampaignState Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignState

type Rep CampaignState = D1 ('MetaData "CampaignState" "Amazonka.Pinpoint.Types.CampaignState" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CampaignState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "campaignStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignStatus))))

newCampaignState :: CampaignState Source #

Create a value of CampaignState 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:campaignStatus:CampaignState', campaignState_campaignStatus - The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

campaignState_campaignStatus :: Lens' CampaignState (Maybe CampaignStatus) Source #

The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

CampaignsResponse

data CampaignsResponse Source #

Provides information about the configuration and other settings for all the campaigns that are associated with an application.

See: newCampaignsResponse smart constructor.

Constructors

CampaignsResponse' 

Fields

  • nextToken :: Maybe Text

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

  • item :: [CampaignResponse]

    An array of responses, one for each campaign that's associated with the application.

Instances

Instances details
Eq CampaignsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignsResponse

Read CampaignsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignsResponse

Show CampaignsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignsResponse

Generic CampaignsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignsResponse

Associated Types

type Rep CampaignsResponse :: Type -> Type #

NFData CampaignsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignsResponse

Methods

rnf :: CampaignsResponse -> () #

Hashable CampaignsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignsResponse

FromJSON CampaignsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignsResponse

type Rep CampaignsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignsResponse

type Rep CampaignsResponse = D1 ('MetaData "CampaignsResponse" "Amazonka.Pinpoint.Types.CampaignsResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CampaignsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [CampaignResponse])))

newCampaignsResponse :: CampaignsResponse Source #

Create a value of CampaignsResponse 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:nextToken:CampaignsResponse', campaignsResponse_nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

$sel:item:CampaignsResponse', campaignsResponse_item - An array of responses, one for each campaign that's associated with the application.

campaignsResponse_nextToken :: Lens' CampaignsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

campaignsResponse_item :: Lens' CampaignsResponse [CampaignResponse] Source #

An array of responses, one for each campaign that's associated with the application.

ChannelResponse

data ChannelResponse Source #

Provides information about the general settings and status of a channel for an application.

See: newChannelResponse smart constructor.

Constructors

ChannelResponse' 

Fields

Instances

Instances details
Eq ChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelResponse

Read ChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelResponse

Show ChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelResponse

Generic ChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelResponse

Associated Types

type Rep ChannelResponse :: Type -> Type #

NFData ChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelResponse

Methods

rnf :: ChannelResponse -> () #

Hashable ChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelResponse

FromJSON ChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelResponse

type Rep ChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelResponse

newChannelResponse :: ChannelResponse Source #

Create a value of ChannelResponse 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:lastModifiedDate:ChannelResponse', channelResponse_lastModifiedDate - The date and time, in ISO 8601 format, when the channel was last modified.

$sel:enabled:ChannelResponse', channelResponse_enabled - Specifies whether the channel is enabled for the application.

$sel:isArchived:ChannelResponse', channelResponse_isArchived - Specifies whether the channel is archived.

$sel:applicationId:ChannelResponse', channelResponse_applicationId - The unique identifier for the application.

$sel:version:ChannelResponse', channelResponse_version - The current version of the channel.

$sel:id:ChannelResponse', channelResponse_id - (Deprecated) An identifier for the channel. This property is retained only for backward compatibility.

$sel:creationDate:ChannelResponse', channelResponse_creationDate - The date and time, in ISO 8601 format, when the channel was enabled.

$sel:lastModifiedBy:ChannelResponse', channelResponse_lastModifiedBy - The user who last modified the channel.

$sel:hasCredential:ChannelResponse', channelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.

channelResponse_lastModifiedDate :: Lens' ChannelResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the channel was last modified.

channelResponse_enabled :: Lens' ChannelResponse (Maybe Bool) Source #

Specifies whether the channel is enabled for the application.

channelResponse_isArchived :: Lens' ChannelResponse (Maybe Bool) Source #

Specifies whether the channel is archived.

channelResponse_applicationId :: Lens' ChannelResponse (Maybe Text) Source #

The unique identifier for the application.

channelResponse_version :: Lens' ChannelResponse (Maybe Int) Source #

The current version of the channel.

channelResponse_id :: Lens' ChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the channel. This property is retained only for backward compatibility.

channelResponse_creationDate :: Lens' ChannelResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the channel was enabled.

channelResponse_lastModifiedBy :: Lens' ChannelResponse (Maybe Text) Source #

The user who last modified the channel.

channelResponse_hasCredential :: Lens' ChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

ChannelsResponse

data ChannelsResponse Source #

Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.

See: newChannelsResponse smart constructor.

Constructors

ChannelsResponse' 

Fields

  • channels :: HashMap Text ChannelResponse

    A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value.

Instances

Instances details
Eq ChannelsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelsResponse

Read ChannelsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelsResponse

Show ChannelsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelsResponse

Generic ChannelsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelsResponse

Associated Types

type Rep ChannelsResponse :: Type -> Type #

NFData ChannelsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelsResponse

Methods

rnf :: ChannelsResponse -> () #

Hashable ChannelsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelsResponse

FromJSON ChannelsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelsResponse

type Rep ChannelsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ChannelsResponse

type Rep ChannelsResponse = D1 ('MetaData "ChannelsResponse" "Amazonka.Pinpoint.Types.ChannelsResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ChannelsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text ChannelResponse))))

newChannelsResponse :: ChannelsResponse Source #

Create a value of ChannelsResponse 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:channels:ChannelsResponse', channelsResponse_channels - A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value.

channelsResponse_channels :: Lens' ChannelsResponse (HashMap Text ChannelResponse) Source #

A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value.

Condition

data Condition Source #

Specifies the conditions to evaluate for an activity in a journey, and how to evaluate those conditions.

See: newCondition smart constructor.

Constructors

Condition' 

Fields

  • operator :: Maybe Operator

    Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.

  • conditions :: Maybe [SimpleCondition]

    The conditions to evaluate for the activity.

Instances

Instances details
Eq Condition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Condition

Read Condition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Condition

Show Condition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Condition

Generic Condition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Condition

Associated Types

type Rep Condition :: Type -> Type #

NFData Condition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Condition

Methods

rnf :: Condition -> () #

Hashable Condition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Condition

ToJSON Condition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Condition

FromJSON Condition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Condition

type Rep Condition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Condition

type Rep Condition = D1 ('MetaData "Condition" "Amazonka.Pinpoint.Types.Condition" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "Condition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Operator)) :*: S1 ('MetaSel ('Just "conditions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SimpleCondition]))))

newCondition :: Condition Source #

Create a value of Condition 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:operator:Condition', condition_operator - Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.

$sel:conditions:Condition', condition_conditions - The conditions to evaluate for the activity.

condition_operator :: Lens' Condition (Maybe Operator) Source #

Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.

condition_conditions :: Lens' Condition (Maybe [SimpleCondition]) Source #

The conditions to evaluate for the activity.

ConditionalSplitActivity

data ConditionalSplitActivity Source #

Specifies the settings for a yes/no split activity in a journey. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

To create yes/no split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.

See: newConditionalSplitActivity smart constructor.

Constructors

ConditionalSplitActivity' 

Fields

  • evaluationWaitTime :: Maybe WaitTime

    The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.

  • trueActivity :: Maybe Text

    The unique identifier for the activity to perform if the conditions are met.

  • falseActivity :: Maybe Text

    The unique identifier for the activity to perform if the conditions aren't met.

  • condition :: Maybe Condition

    The conditions that define the paths for the activity, and the relationship between the conditions.

Instances

Instances details
Eq ConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ConditionalSplitActivity

Read ConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ConditionalSplitActivity

Show ConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ConditionalSplitActivity

Generic ConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ConditionalSplitActivity

Associated Types

type Rep ConditionalSplitActivity :: Type -> Type #

NFData ConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ConditionalSplitActivity

Hashable ConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ConditionalSplitActivity

ToJSON ConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ConditionalSplitActivity

FromJSON ConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ConditionalSplitActivity

type Rep ConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ConditionalSplitActivity

type Rep ConditionalSplitActivity = D1 ('MetaData "ConditionalSplitActivity" "Amazonka.Pinpoint.Types.ConditionalSplitActivity" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ConditionalSplitActivity'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "evaluationWaitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WaitTime)) :*: S1 ('MetaSel ('Just "trueActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "falseActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "condition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Condition)))))

newConditionalSplitActivity :: ConditionalSplitActivity Source #

Create a value of ConditionalSplitActivity 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:evaluationWaitTime:ConditionalSplitActivity', conditionalSplitActivity_evaluationWaitTime - The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.

$sel:trueActivity:ConditionalSplitActivity', conditionalSplitActivity_trueActivity - The unique identifier for the activity to perform if the conditions are met.

$sel:falseActivity:ConditionalSplitActivity', conditionalSplitActivity_falseActivity - The unique identifier for the activity to perform if the conditions aren't met.

$sel:condition:ConditionalSplitActivity', conditionalSplitActivity_condition - The conditions that define the paths for the activity, and the relationship between the conditions.

conditionalSplitActivity_evaluationWaitTime :: Lens' ConditionalSplitActivity (Maybe WaitTime) Source #

The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.

conditionalSplitActivity_trueActivity :: Lens' ConditionalSplitActivity (Maybe Text) Source #

The unique identifier for the activity to perform if the conditions are met.

conditionalSplitActivity_falseActivity :: Lens' ConditionalSplitActivity (Maybe Text) Source #

The unique identifier for the activity to perform if the conditions aren't met.

conditionalSplitActivity_condition :: Lens' ConditionalSplitActivity (Maybe Condition) Source #

The conditions that define the paths for the activity, and the relationship between the conditions.

ContactCenterActivity

data ContactCenterActivity Source #

See: newContactCenterActivity smart constructor.

Constructors

ContactCenterActivity' 

Fields

  • nextActivity :: Maybe Text

    The unique identifier for the next activity to perform after the this activity.

Instances

Instances details
Eq ContactCenterActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ContactCenterActivity

Read ContactCenterActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ContactCenterActivity

Show ContactCenterActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ContactCenterActivity

Generic ContactCenterActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ContactCenterActivity

Associated Types

type Rep ContactCenterActivity :: Type -> Type #

NFData ContactCenterActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ContactCenterActivity

Methods

rnf :: ContactCenterActivity -> () #

Hashable ContactCenterActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ContactCenterActivity

ToJSON ContactCenterActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ContactCenterActivity

FromJSON ContactCenterActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ContactCenterActivity

type Rep ContactCenterActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ContactCenterActivity

type Rep ContactCenterActivity = D1 ('MetaData "ContactCenterActivity" "Amazonka.Pinpoint.Types.ContactCenterActivity" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ContactCenterActivity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newContactCenterActivity :: ContactCenterActivity Source #

Create a value of ContactCenterActivity 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:nextActivity:ContactCenterActivity', contactCenterActivity_nextActivity - The unique identifier for the next activity to perform after the this activity.

contactCenterActivity_nextActivity :: Lens' ContactCenterActivity (Maybe Text) Source #

The unique identifier for the next activity to perform after the this activity.

CreateApplicationRequest

data CreateApplicationRequest Source #

Specifies the display name of an application and the tags to associate with the application.

See: newCreateApplicationRequest smart constructor.

Constructors

CreateApplicationRequest' 

Fields

  • tags :: Maybe (HashMap Text Text)

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

  • name :: Text

    The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

Instances

Instances details
Eq CreateApplicationRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateApplicationRequest

Read CreateApplicationRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateApplicationRequest

Show CreateApplicationRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateApplicationRequest

Generic CreateApplicationRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateApplicationRequest

Associated Types

type Rep CreateApplicationRequest :: Type -> Type #

NFData CreateApplicationRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateApplicationRequest

Hashable CreateApplicationRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateApplicationRequest

ToJSON CreateApplicationRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateApplicationRequest

type Rep CreateApplicationRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateApplicationRequest

type Rep CreateApplicationRequest = D1 ('MetaData "CreateApplicationRequest" "Amazonka.Pinpoint.Types.CreateApplicationRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CreateApplicationRequest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateApplicationRequest Source #

Create a value of CreateApplicationRequest 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:tags:CreateApplicationRequest', createApplicationRequest_tags - A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.

$sel:name:CreateApplicationRequest', createApplicationRequest_name - The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

createApplicationRequest_tags :: Lens' CreateApplicationRequest (Maybe (HashMap Text Text)) Source #

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

createApplicationRequest_name :: Lens' CreateApplicationRequest Text Source #

The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

CreateRecommenderConfiguration

data CreateRecommenderConfiguration Source #

Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

See: newCreateRecommenderConfiguration smart constructor.

Constructors

CreateRecommenderConfiguration' 

Fields

  • recommendationTransformerUri :: Maybe Text

    The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.

  • recommendationsDisplayName :: Maybe Text

    A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

    This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

  • recommendationProviderIdType :: Maybe Text

    The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

    • PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
    • PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
  • attributes :: Maybe (HashMap Text Text)

    A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

    In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

    • An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
    • An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

    This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.

  • name :: Maybe Text

    A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

  • description :: Maybe Text

    A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.

  • recommendationsPerMessage :: Maybe Int

    The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

    To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

  • recommendationProviderUri :: Text

    The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.

  • recommendationProviderRoleArn :: Text

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

Instances

Instances details
Eq CreateRecommenderConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateRecommenderConfiguration

Read CreateRecommenderConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateRecommenderConfiguration

Show CreateRecommenderConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateRecommenderConfiguration

Generic CreateRecommenderConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateRecommenderConfiguration

Associated Types

type Rep CreateRecommenderConfiguration :: Type -> Type #

NFData CreateRecommenderConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateRecommenderConfiguration

Hashable CreateRecommenderConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateRecommenderConfiguration

ToJSON CreateRecommenderConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateRecommenderConfiguration

type Rep CreateRecommenderConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateRecommenderConfiguration

type Rep CreateRecommenderConfiguration = D1 ('MetaData "CreateRecommenderConfiguration" "Amazonka.Pinpoint.Types.CreateRecommenderConfiguration" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CreateRecommenderConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "recommendationTransformerUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "recommendationsDisplayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "recommendationProviderIdType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "recommendationsPerMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "recommendationProviderUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "recommendationProviderRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateRecommenderConfiguration Source #

Create a value of CreateRecommenderConfiguration 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:recommendationTransformerUri:CreateRecommenderConfiguration', createRecommenderConfiguration_recommendationTransformerUri - The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.

$sel:recommendationsDisplayName:CreateRecommenderConfiguration', createRecommenderConfiguration_recommendationsDisplayName - A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

$sel:recommendationProviderIdType:CreateRecommenderConfiguration', createRecommenderConfiguration_recommendationProviderIdType - The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

  • PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
  • PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

$sel:attributes:CreateRecommenderConfiguration', createRecommenderConfiguration_attributes - A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

  • An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
  • An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.

$sel:name:CreateRecommenderConfiguration', createRecommenderConfiguration_name - A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

$sel:description:CreateRecommenderConfiguration', createRecommenderConfiguration_description - A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.

$sel:recommendationsPerMessage:CreateRecommenderConfiguration', createRecommenderConfiguration_recommendationsPerMessage - The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

$sel:recommendationProviderUri:CreateRecommenderConfiguration', createRecommenderConfiguration_recommendationProviderUri - The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.

$sel:recommendationProviderRoleArn:CreateRecommenderConfiguration', createRecommenderConfiguration_recommendationProviderRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

createRecommenderConfiguration_recommendationTransformerUri :: Lens' CreateRecommenderConfiguration (Maybe Text) Source #

The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.

createRecommenderConfiguration_recommendationsDisplayName :: Lens' CreateRecommenderConfiguration (Maybe Text) Source #

A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

createRecommenderConfiguration_recommendationProviderIdType :: Lens' CreateRecommenderConfiguration (Maybe Text) Source #

The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

  • PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
  • PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

createRecommenderConfiguration_attributes :: Lens' CreateRecommenderConfiguration (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

  • An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
  • An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.

createRecommenderConfiguration_name :: Lens' CreateRecommenderConfiguration (Maybe Text) Source #

A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

createRecommenderConfiguration_description :: Lens' CreateRecommenderConfiguration (Maybe Text) Source #

A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.

createRecommenderConfiguration_recommendationsPerMessage :: Lens' CreateRecommenderConfiguration (Maybe Int) Source #

The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

createRecommenderConfiguration_recommendationProviderUri :: Lens' CreateRecommenderConfiguration Text Source #

The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.

createRecommenderConfiguration_recommendationProviderRoleArn :: Lens' CreateRecommenderConfiguration Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

CreateTemplateMessageBody

data CreateTemplateMessageBody Source #

Provides information about a request to create a message template.

See: newCreateTemplateMessageBody smart constructor.

Constructors

CreateTemplateMessageBody' 

Fields

  • requestID :: Maybe Text

    The unique identifier for the request to create the message template.

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the message template that was created.

  • message :: Maybe Text

    The message that's returned from the API for the request to create the message template.

Instances

Instances details
Eq CreateTemplateMessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateTemplateMessageBody

Read CreateTemplateMessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateTemplateMessageBody

Show CreateTemplateMessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateTemplateMessageBody

Generic CreateTemplateMessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateTemplateMessageBody

Associated Types

type Rep CreateTemplateMessageBody :: Type -> Type #

NFData CreateTemplateMessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateTemplateMessageBody

Hashable CreateTemplateMessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateTemplateMessageBody

FromJSON CreateTemplateMessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateTemplateMessageBody

type Rep CreateTemplateMessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CreateTemplateMessageBody

type Rep CreateTemplateMessageBody = D1 ('MetaData "CreateTemplateMessageBody" "Amazonka.Pinpoint.Types.CreateTemplateMessageBody" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CreateTemplateMessageBody'" 'PrefixI 'True) (S1 ('MetaSel ('Just "requestID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCreateTemplateMessageBody :: CreateTemplateMessageBody Source #

Create a value of CreateTemplateMessageBody 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:requestID:CreateTemplateMessageBody', createTemplateMessageBody_requestID - The unique identifier for the request to create the message template.

$sel:arn:CreateTemplateMessageBody', createTemplateMessageBody_arn - The Amazon Resource Name (ARN) of the message template that was created.

$sel:message:CreateTemplateMessageBody', createTemplateMessageBody_message - The message that's returned from the API for the request to create the message template.

createTemplateMessageBody_requestID :: Lens' CreateTemplateMessageBody (Maybe Text) Source #

The unique identifier for the request to create the message template.

createTemplateMessageBody_arn :: Lens' CreateTemplateMessageBody (Maybe Text) Source #

The Amazon Resource Name (ARN) of the message template that was created.

createTemplateMessageBody_message :: Lens' CreateTemplateMessageBody (Maybe Text) Source #

The message that's returned from the API for the request to create the message template.

CustomDeliveryConfiguration

data CustomDeliveryConfiguration Source #

Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. This object is required if you use the CampaignCustomMessage object to define the message to send for the campaign or campaign treatment.

See: newCustomDeliveryConfiguration smart constructor.

Constructors

CustomDeliveryConfiguration' 

Fields

  • endpointTypes :: Maybe [EndpointTypesElement]

    The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

  • deliveryUri :: Text

    The destination to send the campaign or treatment to. This value can be one of the following:

    • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
    • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

Instances

Instances details
Eq CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

Read CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

Show CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

Generic CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

Associated Types

type Rep CustomDeliveryConfiguration :: Type -> Type #

NFData CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

Hashable CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

ToJSON CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

FromJSON CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

type Rep CustomDeliveryConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomDeliveryConfiguration

type Rep CustomDeliveryConfiguration = D1 ('MetaData "CustomDeliveryConfiguration" "Amazonka.Pinpoint.Types.CustomDeliveryConfiguration" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CustomDeliveryConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EndpointTypesElement])) :*: S1 ('MetaSel ('Just "deliveryUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCustomDeliveryConfiguration Source #

Create a value of CustomDeliveryConfiguration 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:endpointTypes:CustomDeliveryConfiguration', customDeliveryConfiguration_endpointTypes - The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

$sel:deliveryUri:CustomDeliveryConfiguration', customDeliveryConfiguration_deliveryUri - The destination to send the campaign or treatment to. This value can be one of the following:

  • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
  • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

customDeliveryConfiguration_endpointTypes :: Lens' CustomDeliveryConfiguration (Maybe [EndpointTypesElement]) Source #

The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

customDeliveryConfiguration_deliveryUri :: Lens' CustomDeliveryConfiguration Text Source #

The destination to send the campaign or treatment to. This value can be one of the following:

  • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
  • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

CustomMessageActivity

data CustomMessageActivity Source #

The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

See: newCustomMessageActivity smart constructor.

Constructors

CustomMessageActivity' 

Fields

  • templateName :: Maybe Text

    The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.

  • templateVersion :: Maybe Text

    The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

  • endpointTypes :: Maybe [EndpointTypesElement]

    The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

  • nextActivity :: Maybe Text

    The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

  • deliveryUri :: Maybe Text

    The destination to send the campaign or treatment to. This value can be one of the following:

    • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
    • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
  • messageConfig :: Maybe JourneyCustomMessage

    Specifies the message data included in a custom channel message that's sent to participants in a journey.

Instances

Instances details
Eq CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

Read CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

Show CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

Generic CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

Associated Types

type Rep CustomMessageActivity :: Type -> Type #

NFData CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

Methods

rnf :: CustomMessageActivity -> () #

Hashable CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

ToJSON CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

FromJSON CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

type Rep CustomMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CustomMessageActivity

type Rep CustomMessageActivity = D1 ('MetaData "CustomMessageActivity" "Amazonka.Pinpoint.Types.CustomMessageActivity" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CustomMessageActivity'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "templateVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endpointTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EndpointTypesElement])))) :*: (S1 ('MetaSel ('Just "nextActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "deliveryUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "messageConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JourneyCustomMessage))))))

newCustomMessageActivity :: CustomMessageActivity Source #

Create a value of CustomMessageActivity 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:templateName:CustomMessageActivity', customMessageActivity_templateName - The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.

$sel:templateVersion:CustomMessageActivity', customMessageActivity_templateVersion - The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

$sel:endpointTypes:CustomMessageActivity', customMessageActivity_endpointTypes - The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

$sel:nextActivity:CustomMessageActivity', customMessageActivity_nextActivity - The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

$sel:deliveryUri:CustomMessageActivity', customMessageActivity_deliveryUri - The destination to send the campaign or treatment to. This value can be one of the following:

  • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
  • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

$sel:messageConfig:CustomMessageActivity', customMessageActivity_messageConfig - Specifies the message data included in a custom channel message that's sent to participants in a journey.

customMessageActivity_templateName :: Lens' CustomMessageActivity (Maybe Text) Source #

The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.

customMessageActivity_templateVersion :: Lens' CustomMessageActivity (Maybe Text) Source #

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

customMessageActivity_endpointTypes :: Lens' CustomMessageActivity (Maybe [EndpointTypesElement]) Source #

The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

customMessageActivity_nextActivity :: Lens' CustomMessageActivity (Maybe Text) Source #

The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.

customMessageActivity_deliveryUri :: Lens' CustomMessageActivity (Maybe Text) Source #

The destination to send the campaign or treatment to. This value can be one of the following:

  • The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
  • The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

customMessageActivity_messageConfig :: Lens' CustomMessageActivity (Maybe JourneyCustomMessage) Source #

Specifies the message data included in a custom channel message that's sent to participants in a journey.

DefaultButtonConfiguration

data DefaultButtonConfiguration Source #

Default button configuration.

See: newDefaultButtonConfiguration smart constructor.

Constructors

DefaultButtonConfiguration' 

Fields

Instances

Instances details
Eq DefaultButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultButtonConfiguration

Read DefaultButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultButtonConfiguration

Show DefaultButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultButtonConfiguration

Generic DefaultButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultButtonConfiguration

Associated Types

type Rep DefaultButtonConfiguration :: Type -> Type #

NFData DefaultButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultButtonConfiguration

Hashable DefaultButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultButtonConfiguration

ToJSON DefaultButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultButtonConfiguration

FromJSON DefaultButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultButtonConfiguration

type Rep DefaultButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultButtonConfiguration

type Rep DefaultButtonConfiguration = D1 ('MetaData "DefaultButtonConfiguration" "Amazonka.Pinpoint.Types.DefaultButtonConfiguration" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "DefaultButtonConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "link") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "backgroundColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "borderRadius") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "textColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "buttonAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ButtonAction) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

DefaultMessage

data DefaultMessage Source #

Specifies the default message for all channels.

See: newDefaultMessage smart constructor.

Constructors

DefaultMessage' 

Fields

Instances

Instances details
Eq DefaultMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultMessage

Read DefaultMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultMessage

Show DefaultMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultMessage

Generic DefaultMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultMessage

Associated Types

type Rep DefaultMessage :: Type -> Type #

NFData DefaultMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultMessage

Methods

rnf :: DefaultMessage -> () #

Hashable DefaultMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultMessage

ToJSON DefaultMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultMessage

type Rep DefaultMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultMessage

type Rep DefaultMessage = D1 ('MetaData "DefaultMessage" "Amazonka.Pinpoint.Types.DefaultMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "DefaultMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "substitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDefaultMessage :: DefaultMessage Source #

Create a value of DefaultMessage 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:substitutions:DefaultMessage', defaultMessage_substitutions - The default message variables to use in the message. You can override these default variables with individual address variables.

$sel:body:DefaultMessage', defaultMessage_body - The default body of the message.

defaultMessage_substitutions :: Lens' DefaultMessage (Maybe (HashMap Text [Text])) Source #

The default message variables to use in the message. You can override these default variables with individual address variables.

defaultMessage_body :: Lens' DefaultMessage (Maybe Text) Source #

The default body of the message.

DefaultPushNotificationMessage

data DefaultPushNotificationMessage Source #

Specifies the default settings and content for a push notification that's sent directly to an endpoint.

See: newDefaultPushNotificationMessage smart constructor.

Constructors

DefaultPushNotificationMessage' 

Fields

  • substitutions :: Maybe (HashMap Text [Text])

    The default message variables to use in the notification message. You can override the default variables with individual address variables.

  • silentPush :: Maybe Bool

    Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.

  • data' :: Maybe (HashMap Text Text)

    The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

  • body :: Maybe Text

    The default body of the notification message.

  • url :: Maybe Text

    The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

  • action :: Maybe Action

    The default action to occur if a recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
  • title :: Maybe Text

    The default title to display above the notification message on a recipient's device.

Instances

Instances details
Eq DefaultPushNotificationMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationMessage

Read DefaultPushNotificationMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationMessage

Show DefaultPushNotificationMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationMessage

Generic DefaultPushNotificationMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationMessage

Associated Types

type Rep DefaultPushNotificationMessage :: Type -> Type #

NFData DefaultPushNotificationMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationMessage

Hashable DefaultPushNotificationMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationMessage

ToJSON DefaultPushNotificationMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationMessage

type Rep DefaultPushNotificationMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationMessage

type Rep DefaultPushNotificationMessage = D1 ('MetaData "DefaultPushNotificationMessage" "Amazonka.Pinpoint.Types.DefaultPushNotificationMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "DefaultPushNotificationMessage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "substitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: (S1 ('MetaSel ('Just "silentPush") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: ((S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Action)) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDefaultPushNotificationMessage :: DefaultPushNotificationMessage Source #

Create a value of DefaultPushNotificationMessage 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:substitutions:DefaultPushNotificationMessage', defaultPushNotificationMessage_substitutions - The default message variables to use in the notification message. You can override the default variables with individual address variables.

$sel:silentPush:DefaultPushNotificationMessage', defaultPushNotificationMessage_silentPush - Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.

$sel:data':DefaultPushNotificationMessage', defaultPushNotificationMessage_data - The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

$sel:body:DefaultPushNotificationMessage', defaultPushNotificationMessage_body - The default body of the notification message.

$sel:url:DefaultPushNotificationMessage', defaultPushNotificationMessage_url - The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

$sel:action:DefaultPushNotificationMessage', defaultPushNotificationMessage_action - The default action to occur if a recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

$sel:title:DefaultPushNotificationMessage', defaultPushNotificationMessage_title - The default title to display above the notification message on a recipient's device.

defaultPushNotificationMessage_substitutions :: Lens' DefaultPushNotificationMessage (Maybe (HashMap Text [Text])) Source #

The default message variables to use in the notification message. You can override the default variables with individual address variables.

defaultPushNotificationMessage_silentPush :: Lens' DefaultPushNotificationMessage (Maybe Bool) Source #

Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.

defaultPushNotificationMessage_data :: Lens' DefaultPushNotificationMessage (Maybe (HashMap Text Text)) Source #

The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

defaultPushNotificationMessage_url :: Lens' DefaultPushNotificationMessage (Maybe Text) Source #

The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

defaultPushNotificationMessage_action :: Lens' DefaultPushNotificationMessage (Maybe Action) Source #

The default action to occur if a recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

defaultPushNotificationMessage_title :: Lens' DefaultPushNotificationMessage (Maybe Text) Source #

The default title to display above the notification message on a recipient's device.

DefaultPushNotificationTemplate

data DefaultPushNotificationTemplate Source #

Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.

See: newDefaultPushNotificationTemplate smart constructor.

Constructors

DefaultPushNotificationTemplate' 

Fields

  • body :: Maybe Text

    The message body to use in push notifications that are based on the message template.

  • url :: Maybe Text

    The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

  • sound :: Maybe Text

    The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

    For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

  • action :: Maybe Action

    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
  • title :: Maybe Text

    The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

Instances

Instances details
Eq DefaultPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationTemplate

Read DefaultPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationTemplate

Show DefaultPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationTemplate

Generic DefaultPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationTemplate

Associated Types

type Rep DefaultPushNotificationTemplate :: Type -> Type #

NFData DefaultPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationTemplate

Hashable DefaultPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationTemplate

ToJSON DefaultPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationTemplate

FromJSON DefaultPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationTemplate

type Rep DefaultPushNotificationTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DefaultPushNotificationTemplate

type Rep DefaultPushNotificationTemplate = D1 ('MetaData "DefaultPushNotificationTemplate" "Amazonka.Pinpoint.Types.DefaultPushNotificationTemplate" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "DefaultPushNotificationTemplate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Action)) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDefaultPushNotificationTemplate :: DefaultPushNotificationTemplate Source #

Create a value of DefaultPushNotificationTemplate 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:body:DefaultPushNotificationTemplate', defaultPushNotificationTemplate_body - The message body to use in push notifications that are based on the message template.

$sel:url:DefaultPushNotificationTemplate', defaultPushNotificationTemplate_url - The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

$sel:sound:DefaultPushNotificationTemplate', defaultPushNotificationTemplate_sound - The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

$sel:action:DefaultPushNotificationTemplate', defaultPushNotificationTemplate_action - The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

$sel:title:DefaultPushNotificationTemplate', defaultPushNotificationTemplate_title - The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

defaultPushNotificationTemplate_body :: Lens' DefaultPushNotificationTemplate (Maybe Text) Source #

The message body to use in push notifications that are based on the message template.

defaultPushNotificationTemplate_url :: Lens' DefaultPushNotificationTemplate (Maybe Text) Source #

The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

defaultPushNotificationTemplate_sound :: Lens' DefaultPushNotificationTemplate (Maybe Text) Source #

The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

defaultPushNotificationTemplate_action :: Lens' DefaultPushNotificationTemplate (Maybe Action) Source #

The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

defaultPushNotificationTemplate_title :: Lens' DefaultPushNotificationTemplate (Maybe Text) Source #

The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

DirectMessageConfiguration

data DirectMessageConfiguration Source #

Specifies the settings and content for the default message and any default messages that you tailored for specific channels.

See: newDirectMessageConfiguration smart constructor.

Constructors

DirectMessageConfiguration' 

Fields

  • aPNSMessage :: Maybe APNSMessage

    The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

  • gCMMessage :: Maybe GCMMessage

    The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage).

  • defaultMessage :: Maybe DefaultMessage

    The default message for all channels.

  • aDMMessage :: Maybe ADMMessage

    The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

  • sMSMessage :: Maybe SMSMessage

    The default message for the SMS channel. This message overrides the default message (DefaultMessage).

  • emailMessage :: Maybe EmailMessage

    The default message for the email channel. This message overrides the default message (DefaultMessage).

  • voiceMessage :: Maybe VoiceMessage

    The default message for the voice channel. This message overrides the default message (DefaultMessage).

  • baiduMessage :: Maybe BaiduMessage

    The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

  • defaultPushNotificationMessage :: Maybe DefaultPushNotificationMessage

    The default push notification message for all push notification channels.

Instances

Instances details
Eq DirectMessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DirectMessageConfiguration

Read DirectMessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DirectMessageConfiguration

Show DirectMessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DirectMessageConfiguration

Generic DirectMessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DirectMessageConfiguration

Associated Types

type Rep DirectMessageConfiguration :: Type -> Type #

NFData DirectMessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DirectMessageConfiguration

Hashable DirectMessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DirectMessageConfiguration

ToJSON DirectMessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DirectMessageConfiguration

type Rep DirectMessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.DirectMessageConfiguration

newDirectMessageConfiguration :: DirectMessageConfiguration Source #

Create a value of DirectMessageConfiguration 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:aPNSMessage:DirectMessageConfiguration', directMessageConfiguration_aPNSMessage - The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

$sel:gCMMessage:DirectMessageConfiguration', directMessageConfiguration_gCMMessage - The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage).

$sel:defaultMessage:DirectMessageConfiguration', directMessageConfiguration_defaultMessage - The default message for all channels.

$sel:aDMMessage:DirectMessageConfiguration', directMessageConfiguration_aDMMessage - The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

$sel:sMSMessage:DirectMessageConfiguration', directMessageConfiguration_sMSMessage - The default message for the SMS channel. This message overrides the default message (DefaultMessage).

$sel:emailMessage:DirectMessageConfiguration', directMessageConfiguration_emailMessage - The default message for the email channel. This message overrides the default message (DefaultMessage).

$sel:voiceMessage:DirectMessageConfiguration', directMessageConfiguration_voiceMessage - The default message for the voice channel. This message overrides the default message (DefaultMessage).

$sel:baiduMessage:DirectMessageConfiguration', directMessageConfiguration_baiduMessage - The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

$sel:defaultPushNotificationMessage:DirectMessageConfiguration', directMessageConfiguration_defaultPushNotificationMessage - The default push notification message for all push notification channels.

directMessageConfiguration_aPNSMessage :: Lens' DirectMessageConfiguration (Maybe APNSMessage) Source #

The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

directMessageConfiguration_gCMMessage :: Lens' DirectMessageConfiguration (Maybe GCMMessage) Source #

The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage).

directMessageConfiguration_aDMMessage :: Lens' DirectMessageConfiguration (Maybe ADMMessage) Source #

The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

directMessageConfiguration_sMSMessage :: Lens' DirectMessageConfiguration (Maybe SMSMessage) Source #

The default message for the SMS channel. This message overrides the default message (DefaultMessage).

directMessageConfiguration_emailMessage :: Lens' DirectMessageConfiguration (Maybe EmailMessage) Source #

The default message for the email channel. This message overrides the default message (DefaultMessage).

directMessageConfiguration_voiceMessage :: Lens' DirectMessageConfiguration (Maybe VoiceMessage) Source #

The default message for the voice channel. This message overrides the default message (DefaultMessage).

directMessageConfiguration_baiduMessage :: Lens' DirectMessageConfiguration (Maybe BaiduMessage) Source #

The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

EmailChannelRequest

data EmailChannelRequest Source #

Specifies the status and settings of the email channel for an application.

See: newEmailChannelRequest smart constructor.

Constructors

EmailChannelRequest' 

Fields

  • enabled :: Maybe Bool

    Specifies whether to enable the email channel for the application.

  • configurationSet :: Maybe Text

    The Amazon SES configuration set that you want to apply to messages that you send through the channel.

  • roleArn :: Maybe Text

    The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.

  • fromAddress :: Text

    The verified email address that you want to send email from when you send email through the channel.

  • identity :: Text

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.

Instances

Instances details
Eq EmailChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelRequest

Read EmailChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelRequest

Show EmailChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelRequest

Generic EmailChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelRequest

Associated Types

type Rep EmailChannelRequest :: Type -> Type #

NFData EmailChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelRequest

Methods

rnf :: EmailChannelRequest -> () #

Hashable EmailChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelRequest

ToJSON EmailChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelRequest

type Rep EmailChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelRequest

type Rep EmailChannelRequest = D1 ('MetaData "EmailChannelRequest" "Amazonka.Pinpoint.Types.EmailChannelRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EmailChannelRequest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "configurationSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "fromAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "identity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newEmailChannelRequest Source #

Create a value of EmailChannelRequest 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:enabled:EmailChannelRequest', emailChannelRequest_enabled - Specifies whether to enable the email channel for the application.

$sel:configurationSet:EmailChannelRequest', emailChannelRequest_configurationSet - The Amazon SES configuration set that you want to apply to messages that you send through the channel.

$sel:roleArn:EmailChannelRequest', emailChannelRequest_roleArn - The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.

$sel:fromAddress:EmailChannelRequest', emailChannelRequest_fromAddress - The verified email address that you want to send email from when you send email through the channel.

$sel:identity:EmailChannelRequest', emailChannelRequest_identity - The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.

emailChannelRequest_enabled :: Lens' EmailChannelRequest (Maybe Bool) Source #

Specifies whether to enable the email channel for the application.

emailChannelRequest_configurationSet :: Lens' EmailChannelRequest (Maybe Text) Source #

The Amazon SES configuration set that you want to apply to messages that you send through the channel.

emailChannelRequest_roleArn :: Lens' EmailChannelRequest (Maybe Text) Source #

The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.

emailChannelRequest_fromAddress :: Lens' EmailChannelRequest Text Source #

The verified email address that you want to send email from when you send email through the channel.

emailChannelRequest_identity :: Lens' EmailChannelRequest Text Source #

The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.

EmailChannelResponse

data EmailChannelResponse Source #

Provides information about the status and settings of the email channel for an application.

See: newEmailChannelResponse smart constructor.

Constructors

EmailChannelResponse' 

Fields

  • messagesPerSecond :: Maybe Int

    The maximum number of emails that can be sent through the channel each second.

  • lastModifiedDate :: Maybe Text

    The date and time, in ISO 8601 format, when the email channel was last modified.

  • enabled :: Maybe Bool

    Specifies whether the email channel is enabled for the application.

  • fromAddress :: Maybe Text

    The verified email address that email is sent from when you send email through the channel.

  • isArchived :: Maybe Bool

    Specifies whether the email channel is archived.

  • applicationId :: Maybe Text

    The unique identifier for the application that the email channel applies to.

  • version :: Maybe Int

    The current version of the email channel.

  • configurationSet :: Maybe Text

    The Amazon SES configuration set that's applied to messages that are sent through the channel.

  • id :: Maybe Text

    (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

  • creationDate :: Maybe Text

    The date and time, in ISO 8601 format, when the email channel was enabled.

  • lastModifiedBy :: Maybe Text

    The user who last modified the email channel.

  • identity :: Maybe Text

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.

  • hasCredential :: Maybe Bool

    (Not used) This property is retained only for backward compatibility.

  • roleArn :: Maybe Text

    The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

  • platform :: Text

    The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

Instances

Instances details
Eq EmailChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelResponse

Read EmailChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelResponse

Show EmailChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelResponse

Generic EmailChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelResponse

Associated Types

type Rep EmailChannelResponse :: Type -> Type #

NFData EmailChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelResponse

Methods

rnf :: EmailChannelResponse -> () #

Hashable EmailChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelResponse

FromJSON EmailChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelResponse

type Rep EmailChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelResponse

type Rep EmailChannelResponse = D1 ('MetaData "EmailChannelResponse" "Amazonka.Pinpoint.Types.EmailChannelResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EmailChannelResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "messagesPerSecond") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "fromAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "isArchived") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: (((S1 ('MetaSel ('Just "configurationSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "identity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hasCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newEmailChannelResponse Source #

Create a value of EmailChannelResponse 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:messagesPerSecond:EmailChannelResponse', emailChannelResponse_messagesPerSecond - The maximum number of emails that can be sent through the channel each second.

$sel:lastModifiedDate:EmailChannelResponse', emailChannelResponse_lastModifiedDate - The date and time, in ISO 8601 format, when the email channel was last modified.

$sel:enabled:EmailChannelResponse', emailChannelResponse_enabled - Specifies whether the email channel is enabled for the application.

$sel:fromAddress:EmailChannelResponse', emailChannelResponse_fromAddress - The verified email address that email is sent from when you send email through the channel.

$sel:isArchived:EmailChannelResponse', emailChannelResponse_isArchived - Specifies whether the email channel is archived.

$sel:applicationId:EmailChannelResponse', emailChannelResponse_applicationId - The unique identifier for the application that the email channel applies to.

$sel:version:EmailChannelResponse', emailChannelResponse_version - The current version of the email channel.

$sel:configurationSet:EmailChannelResponse', emailChannelResponse_configurationSet - The Amazon SES configuration set that's applied to messages that are sent through the channel.

$sel:id:EmailChannelResponse', emailChannelResponse_id - (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

$sel:creationDate:EmailChannelResponse', emailChannelResponse_creationDate - The date and time, in ISO 8601 format, when the email channel was enabled.

$sel:lastModifiedBy:EmailChannelResponse', emailChannelResponse_lastModifiedBy - The user who last modified the email channel.

$sel:identity:EmailChannelResponse', emailChannelResponse_identity - The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.

$sel:hasCredential:EmailChannelResponse', emailChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.

$sel:roleArn:EmailChannelResponse', emailChannelResponse_roleArn - The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

$sel:platform:EmailChannelResponse', emailChannelResponse_platform - The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

emailChannelResponse_messagesPerSecond :: Lens' EmailChannelResponse (Maybe Int) Source #

The maximum number of emails that can be sent through the channel each second.

emailChannelResponse_lastModifiedDate :: Lens' EmailChannelResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the email channel was last modified.

emailChannelResponse_enabled :: Lens' EmailChannelResponse (Maybe Bool) Source #

Specifies whether the email channel is enabled for the application.

emailChannelResponse_fromAddress :: Lens' EmailChannelResponse (Maybe Text) Source #

The verified email address that email is sent from when you send email through the channel.

emailChannelResponse_isArchived :: Lens' EmailChannelResponse (Maybe Bool) Source #

Specifies whether the email channel is archived.

emailChannelResponse_applicationId :: Lens' EmailChannelResponse (Maybe Text) Source #

The unique identifier for the application that the email channel applies to.

emailChannelResponse_version :: Lens' EmailChannelResponse (Maybe Int) Source #

The current version of the email channel.

emailChannelResponse_configurationSet :: Lens' EmailChannelResponse (Maybe Text) Source #

The Amazon SES configuration set that's applied to messages that are sent through the channel.

emailChannelResponse_id :: Lens' EmailChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

emailChannelResponse_creationDate :: Lens' EmailChannelResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the email channel was enabled.

emailChannelResponse_lastModifiedBy :: Lens' EmailChannelResponse (Maybe Text) Source #

The user who last modified the email channel.

emailChannelResponse_identity :: Lens' EmailChannelResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.

emailChannelResponse_hasCredential :: Lens' EmailChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

emailChannelResponse_roleArn :: Lens' EmailChannelResponse (Maybe Text) Source #

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

emailChannelResponse_platform :: Lens' EmailChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

EmailMessage

data EmailMessage Source #

Specifies the default settings and content for a one-time email message that's sent directly to an endpoint.

See: newEmailMessage smart constructor.

Constructors

EmailMessage' 

Fields

Instances

Instances details
Eq EmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessage

Read EmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessage

Show EmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessage

Generic EmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessage

Associated Types

type Rep EmailMessage :: Type -> Type #

NFData EmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessage

Methods

rnf :: EmailMessage -> () #

Hashable EmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessage

ToJSON EmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessage

type Rep EmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessage

type Rep EmailMessage = D1 ('MetaData "EmailMessage" "Amazonka.Pinpoint.Types.EmailMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EmailMessage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "substitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: (S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fromAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "rawEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RawEmail)) :*: S1 ('MetaSel ('Just "feedbackForwardingAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "simpleEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimpleEmail)) :*: S1 ('MetaSel ('Just "replyToAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newEmailMessage :: EmailMessage Source #

Create a value of EmailMessage 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:substitutions:EmailMessage', emailMessage_substitutions - The default message variables to use in the email message. You can override the default variables with individual address variables.

$sel:body:EmailMessage', emailMessage_body - The body of the email message.

$sel:fromAddress:EmailMessage', emailMessage_fromAddress - The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

$sel:rawEmail:EmailMessage', emailMessage_rawEmail - The email message, represented as a raw MIME message.

$sel:feedbackForwardingAddress:EmailMessage', emailMessage_feedbackForwardingAddress - The email address to forward bounces and complaints to, if feedback forwarding is enabled.

$sel:simpleEmail:EmailMessage', emailMessage_simpleEmail - The email message, composed of a subject, a text part, and an HTML part.

$sel:replyToAddresses:EmailMessage', emailMessage_replyToAddresses - The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.

emailMessage_substitutions :: Lens' EmailMessage (Maybe (HashMap Text [Text])) Source #

The default message variables to use in the email message. You can override the default variables with individual address variables.

emailMessage_body :: Lens' EmailMessage (Maybe Text) Source #

The body of the email message.

emailMessage_fromAddress :: Lens' EmailMessage (Maybe Text) Source #

The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

emailMessage_rawEmail :: Lens' EmailMessage (Maybe RawEmail) Source #

The email message, represented as a raw MIME message.

emailMessage_feedbackForwardingAddress :: Lens' EmailMessage (Maybe Text) Source #

The email address to forward bounces and complaints to, if feedback forwarding is enabled.

emailMessage_simpleEmail :: Lens' EmailMessage (Maybe SimpleEmail) Source #

The email message, composed of a subject, a text part, and an HTML part.

emailMessage_replyToAddresses :: Lens' EmailMessage (Maybe [Text]) Source #

The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.

EmailMessageActivity

data EmailMessageActivity Source #

Specifies the settings for an email activity in a journey. This type of activity sends an email message to participants.

See: newEmailMessageActivity smart constructor.

Constructors

EmailMessageActivity' 

Fields

  • templateName :: Maybe Text

    The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.

  • templateVersion :: Maybe Text

    The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

  • nextActivity :: Maybe Text

    The unique identifier for the next activity to perform, after the message is sent.

  • messageConfig :: Maybe JourneyEmailMessage

    Specifies the sender address for an email message that's sent to participants in the journey.

Instances

Instances details
Eq EmailMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessageActivity

Read EmailMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessageActivity

Show EmailMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessageActivity

Generic EmailMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessageActivity

Associated Types

type Rep EmailMessageActivity :: Type -> Type #

NFData EmailMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessageActivity

Methods

rnf :: EmailMessageActivity -> () #

Hashable EmailMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessageActivity

ToJSON EmailMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessageActivity

FromJSON EmailMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessageActivity

type Rep EmailMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailMessageActivity

type Rep EmailMessageActivity = D1 ('MetaData "EmailMessageActivity" "Amazonka.Pinpoint.Types.EmailMessageActivity" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EmailMessageActivity'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "nextActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "messageConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JourneyEmailMessage)))))

newEmailMessageActivity :: EmailMessageActivity Source #

Create a value of EmailMessageActivity 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:templateName:EmailMessageActivity', emailMessageActivity_templateName - The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.

$sel:templateVersion:EmailMessageActivity', emailMessageActivity_templateVersion - The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

$sel:nextActivity:EmailMessageActivity', emailMessageActivity_nextActivity - The unique identifier for the next activity to perform, after the message is sent.

$sel:messageConfig:EmailMessageActivity', emailMessageActivity_messageConfig - Specifies the sender address for an email message that's sent to participants in the journey.

emailMessageActivity_templateName :: Lens' EmailMessageActivity (Maybe Text) Source #

The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.

emailMessageActivity_templateVersion :: Lens' EmailMessageActivity (Maybe Text) Source #

The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

emailMessageActivity_nextActivity :: Lens' EmailMessageActivity (Maybe Text) Source #

The unique identifier for the next activity to perform, after the message is sent.

emailMessageActivity_messageConfig :: Lens' EmailMessageActivity (Maybe JourneyEmailMessage) Source #

Specifies the sender address for an email message that's sent to participants in the journey.

EmailTemplateRequest

data EmailTemplateRequest Source #

Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.

See: newEmailTemplateRequest smart constructor.

Constructors

EmailTemplateRequest' 

Fields

  • subject :: Maybe Text

    The subject line, or title, to use in email messages that are based on the message template.

  • textPart :: Maybe Text

    The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

  • templateDescription :: Maybe Text

    A custom description of the message template.

  • defaultSubstitutions :: Maybe Text

    A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

  • htmlPart :: Maybe Text

    The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

  • recommenderId :: Maybe Text

    The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

  • tags :: Maybe (HashMap Text Text)

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

Instances

Instances details
Eq EmailTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailTemplateRequest

Read EmailTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailTemplateRequest

Show EmailTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailTemplateRequest

Generic EmailTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailTemplateRequest

Associated Types

type Rep EmailTemplateRequest :: Type -> Type #

NFData EmailTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailTemplateRequest

Methods

rnf :: EmailTemplateRequest -> () #

Hashable EmailTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailTemplateRequest

ToJSON EmailTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailTemplateRequest

type Rep EmailTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailTemplateRequest

type Rep EmailTemplateRequest = D1 ('MetaData "EmailTemplateRequest" "Amazonka.Pinpoint.Types.EmailTemplateRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EmailTemplateRequest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "textPart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "defaultSubstitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "htmlPart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "recommenderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))

newEmailTemplateRequest :: EmailTemplateRequest Source #

Create a value of EmailTemplateRequest 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:subject:EmailTemplateRequest', emailTemplateRequest_subject - The subject line, or title, to use in email messages that are based on the message template.

$sel:textPart:EmailTemplateRequest', emailTemplateRequest_textPart - The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

$sel:templateDescription:EmailTemplateRequest', emailTemplateRequest_templateDescription - A custom description of the message template.

$sel:defaultSubstitutions:EmailTemplateRequest', emailTemplateRequest_defaultSubstitutions - A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

$sel:htmlPart:EmailTemplateRequest', emailTemplateRequest_htmlPart - The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

$sel:recommenderId:EmailTemplateRequest', emailTemplateRequest_recommenderId - The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

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

emailTemplateRequest_subject :: Lens' EmailTemplateRequest (Maybe Text) Source #

The subject line, or title, to use in email messages that are based on the message template.

emailTemplateRequest_textPart :: Lens' EmailTemplateRequest (Maybe Text) Source #

The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

emailTemplateRequest_templateDescription :: Lens' EmailTemplateRequest (Maybe Text) Source #

A custom description of the message template.

emailTemplateRequest_defaultSubstitutions :: Lens' EmailTemplateRequest (Maybe Text) Source #

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

emailTemplateRequest_htmlPart :: Lens' EmailTemplateRequest (Maybe Text) Source #

The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

emailTemplateRequest_recommenderId :: Lens' EmailTemplateRequest (Maybe Text) Source #

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

emailTemplateRequest_tags :: Lens' EmailTemplateRequest (Maybe (HashMap Text Text)) Source #

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

EmailTemplateResponse

data EmailTemplateResponse Source #

Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.

See: newEmailTemplateResponse smart constructor.

Constructors

EmailTemplateResponse' 

Fields

  • subject :: Maybe Text

    The subject line, or title, that's used in email messages that are based on the message template.

  • textPart :: Maybe Text

    The message body, in plain text format, that's used in email messages that are based on the message template.

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the message template.

  • templateDescription :: Maybe Text

    The custom description of the message template.

  • defaultSubstitutions :: Maybe Text

    The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

  • version :: Maybe Text

    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

  • htmlPart :: Maybe Text

    The message body, in HTML format, that's used in email messages that are based on the message template.

  • recommenderId :: Maybe Text

    The unique identifier for the recommender model that's used by the message template.

  • tags :: Maybe (HashMap Text Text)

    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

  • lastModifiedDate :: Text

    The date, in ISO 8601 format, when the message template was last modified.

  • creationDate :: Text

    The date, in ISO 8601 format, when the message template was created.

  • templateName :: Text

    The name of the message template.

  • templateType :: TemplateType

    The type of channel that the message template is designed for. For an email template, this value is EMAIL.

Instances

Instances details
Eq EmailTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailTemplateResponse

Read EmailTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailTemplateResponse

Show EmailTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailTemplateResponse

Generic EmailTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailTemplateResponse

Associated Types

type Rep EmailTemplateResponse :: Type -> Type #

NFData EmailTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailTemplateResponse

Methods

rnf :: EmailTemplateResponse -> () #

Hashable EmailTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailTemplateResponse

FromJSON EmailTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailTemplateResponse

type Rep EmailTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailTemplateResponse

type Rep EmailTemplateResponse = D1 ('MetaData "EmailTemplateResponse" "Amazonka.Pinpoint.Types.EmailTemplateResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EmailTemplateResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "textPart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "templateDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "defaultSubstitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "htmlPart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "recommenderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: ((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "templateType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TemplateType))))))

newEmailTemplateResponse Source #

Create a value of EmailTemplateResponse 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:subject:EmailTemplateResponse', emailTemplateResponse_subject - The subject line, or title, that's used in email messages that are based on the message template.

$sel:textPart:EmailTemplateResponse', emailTemplateResponse_textPart - The message body, in plain text format, that's used in email messages that are based on the message template.

$sel:arn:EmailTemplateResponse', emailTemplateResponse_arn - The Amazon Resource Name (ARN) of the message template.

$sel:templateDescription:EmailTemplateResponse', emailTemplateResponse_templateDescription - The custom description of the message template.

$sel:defaultSubstitutions:EmailTemplateResponse', emailTemplateResponse_defaultSubstitutions - The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

$sel:version:EmailTemplateResponse', emailTemplateResponse_version - The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

$sel:htmlPart:EmailTemplateResponse', emailTemplateResponse_htmlPart - The message body, in HTML format, that's used in email messages that are based on the message template.

$sel:recommenderId:EmailTemplateResponse', emailTemplateResponse_recommenderId - The unique identifier for the recommender model that's used by the message template.

$sel:tags:EmailTemplateResponse', emailTemplateResponse_tags - A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

$sel:lastModifiedDate:EmailTemplateResponse', emailTemplateResponse_lastModifiedDate - The date, in ISO 8601 format, when the message template was last modified.

$sel:creationDate:EmailTemplateResponse', emailTemplateResponse_creationDate - The date, in ISO 8601 format, when the message template was created.

$sel:templateName:EmailTemplateResponse', emailTemplateResponse_templateName - The name of the message template.

$sel:templateType:EmailTemplateResponse', emailTemplateResponse_templateType - The type of channel that the message template is designed for. For an email template, this value is EMAIL.

emailTemplateResponse_subject :: Lens' EmailTemplateResponse (Maybe Text) Source #

The subject line, or title, that's used in email messages that are based on the message template.

emailTemplateResponse_textPart :: Lens' EmailTemplateResponse (Maybe Text) Source #

The message body, in plain text format, that's used in email messages that are based on the message template.

emailTemplateResponse_arn :: Lens' EmailTemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the message template.

emailTemplateResponse_templateDescription :: Lens' EmailTemplateResponse (Maybe Text) Source #

The custom description of the message template.

emailTemplateResponse_defaultSubstitutions :: Lens' EmailTemplateResponse (Maybe Text) Source #

The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

emailTemplateResponse_version :: Lens' EmailTemplateResponse (Maybe Text) Source #

The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

emailTemplateResponse_htmlPart :: Lens' EmailTemplateResponse (Maybe Text) Source #

The message body, in HTML format, that's used in email messages that are based on the message template.

emailTemplateResponse_recommenderId :: Lens' EmailTemplateResponse (Maybe Text) Source #

The unique identifier for the recommender model that's used by the message template.

emailTemplateResponse_tags :: Lens' EmailTemplateResponse (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

emailTemplateResponse_lastModifiedDate :: Lens' EmailTemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was last modified.

emailTemplateResponse_creationDate :: Lens' EmailTemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was created.

emailTemplateResponse_templateType :: Lens' EmailTemplateResponse TemplateType Source #

The type of channel that the message template is designed for. For an email template, this value is EMAIL.

EndpointBatchItem

data EndpointBatchItem Source #

Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.

See: newEndpointBatchItem smart constructor.

Constructors

EndpointBatchItem' 

Fields

  • requestId :: Maybe Text

    The unique identifier for the request to create or update the endpoint.

  • metrics :: Maybe (HashMap Text Double)

    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

  • location :: Maybe EndpointLocation

    The geographic information for the endpoint.

  • demographic :: Maybe EndpointDemographic

    The demographic information for the endpoint, such as the time zone and platform.

  • address :: Maybe Text

    The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

  • effectiveDate :: Maybe Text

    The date and time, in ISO 8601 format, when the endpoint was created or updated.

  • user :: Maybe EndpointUser

    One or more custom attributes that describe the user who's associated with the endpoint.

  • attributes :: Maybe (HashMap Text [Text])

    One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

    An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

  • endpointStatus :: Maybe Text

    Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

  • optOut :: Maybe Text

    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

  • id :: Maybe Text

    The unique identifier for the endpoint in the context of the batch.

  • channelType :: Maybe ChannelType

    The channel to use when sending messages or push notifications to the endpoint.

Instances

Instances details
Eq EndpointBatchItem Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointBatchItem

Read EndpointBatchItem Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointBatchItem

Show EndpointBatchItem Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointBatchItem

Generic EndpointBatchItem Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointBatchItem

Associated Types

type Rep EndpointBatchItem :: Type -> Type #

NFData EndpointBatchItem Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointBatchItem

Methods

rnf :: EndpointBatchItem -> () #

Hashable EndpointBatchItem Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointBatchItem

ToJSON EndpointBatchItem Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointBatchItem

type Rep EndpointBatchItem Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointBatchItem

type Rep EndpointBatchItem = D1 ('MetaData "EndpointBatchItem" "Amazonka.Pinpoint.Types.EndpointBatchItem" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EndpointBatchItem'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Double))) :*: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointLocation)))) :*: (S1 ('MetaSel ('Just "demographic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointDemographic)) :*: (S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "effectiveDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointUser)) :*: (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "endpointStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "optOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "channelType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelType)))))))

newEndpointBatchItem :: EndpointBatchItem Source #

Create a value of EndpointBatchItem 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:requestId:EndpointBatchItem', endpointBatchItem_requestId - The unique identifier for the request to create or update the endpoint.

$sel:metrics:EndpointBatchItem', endpointBatchItem_metrics - One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

$sel:location:EndpointBatchItem', endpointBatchItem_location - The geographic information for the endpoint.

$sel:demographic:EndpointBatchItem', endpointBatchItem_demographic - The demographic information for the endpoint, such as the time zone and platform.

$sel:address:EndpointBatchItem', endpointBatchItem_address - The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

$sel:effectiveDate:EndpointBatchItem', endpointBatchItem_effectiveDate - The date and time, in ISO 8601 format, when the endpoint was created or updated.

$sel:user:EndpointBatchItem', endpointBatchItem_user - One or more custom attributes that describe the user who's associated with the endpoint.

$sel:attributes:EndpointBatchItem', endpointBatchItem_attributes - One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

$sel:endpointStatus:EndpointBatchItem', endpointBatchItem_endpointStatus - Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

$sel:optOut:EndpointBatchItem', endpointBatchItem_optOut - Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

$sel:id:EndpointBatchItem', endpointBatchItem_id - The unique identifier for the endpoint in the context of the batch.

$sel:channelType:EndpointBatchItem', endpointBatchItem_channelType - The channel to use when sending messages or push notifications to the endpoint.

endpointBatchItem_requestId :: Lens' EndpointBatchItem (Maybe Text) Source #

The unique identifier for the request to create or update the endpoint.

endpointBatchItem_metrics :: Lens' EndpointBatchItem (Maybe (HashMap Text Double)) Source #

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

endpointBatchItem_location :: Lens' EndpointBatchItem (Maybe EndpointLocation) Source #

The geographic information for the endpoint.

endpointBatchItem_demographic :: Lens' EndpointBatchItem (Maybe EndpointDemographic) Source #

The demographic information for the endpoint, such as the time zone and platform.

endpointBatchItem_address :: Lens' EndpointBatchItem (Maybe Text) Source #

The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

endpointBatchItem_effectiveDate :: Lens' EndpointBatchItem (Maybe Text) Source #

The date and time, in ISO 8601 format, when the endpoint was created or updated.

endpointBatchItem_user :: Lens' EndpointBatchItem (Maybe EndpointUser) Source #

One or more custom attributes that describe the user who's associated with the endpoint.

endpointBatchItem_attributes :: Lens' EndpointBatchItem (Maybe (HashMap Text [Text])) Source #

One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

endpointBatchItem_endpointStatus :: Lens' EndpointBatchItem (Maybe Text) Source #

Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

endpointBatchItem_optOut :: Lens' EndpointBatchItem (Maybe Text) Source #

Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

endpointBatchItem_id :: Lens' EndpointBatchItem (Maybe Text) Source #

The unique identifier for the endpoint in the context of the batch.

endpointBatchItem_channelType :: Lens' EndpointBatchItem (Maybe ChannelType) Source #

The channel to use when sending messages or push notifications to the endpoint.

EndpointBatchRequest

data EndpointBatchRequest Source #

Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.

See: newEndpointBatchRequest smart constructor.

Constructors

EndpointBatchRequest' 

Fields

  • item :: [EndpointBatchItem]

    An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change. An array can contain a maximum of 100 items.

Instances

Instances details
Eq EndpointBatchRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointBatchRequest

Read EndpointBatchRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointBatchRequest

Show EndpointBatchRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointBatchRequest

Generic EndpointBatchRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointBatchRequest

Associated Types

type Rep EndpointBatchRequest :: Type -> Type #

NFData EndpointBatchRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointBatchRequest

Methods

rnf :: EndpointBatchRequest -> () #

Hashable EndpointBatchRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointBatchRequest

ToJSON EndpointBatchRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointBatchRequest

type Rep EndpointBatchRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointBatchRequest

type Rep EndpointBatchRequest = D1 ('MetaData "EndpointBatchRequest" "Amazonka.Pinpoint.Types.EndpointBatchRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EndpointBatchRequest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [EndpointBatchItem])))

newEndpointBatchRequest :: EndpointBatchRequest Source #

Create a value of EndpointBatchRequest 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:item:EndpointBatchRequest', endpointBatchRequest_item - An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change. An array can contain a maximum of 100 items.

endpointBatchRequest_item :: Lens' EndpointBatchRequest [EndpointBatchItem] Source #

An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change. An array can contain a maximum of 100 items.

EndpointDemographic

data EndpointDemographic Source #

Specifies demographic information about an endpoint, such as the applicable time zone and platform.

See: newEndpointDemographic smart constructor.

Constructors

EndpointDemographic' 

Fields

  • platform :: Maybe Text

    The platform of the endpoint device, such as ios.

  • platformVersion :: Maybe Text

    The platform version of the endpoint device.

  • locale :: Maybe Text

    The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.

  • appVersion :: Maybe Text

    The version of the app that's associated with the endpoint.

  • model :: Maybe Text

    The model name or number of the endpoint device, such as iPhone or SM-G900F.

  • make :: Maybe Text

    The manufacturer of the endpoint device, such as apple or samsung.

  • modelVersion :: Maybe Text

    The model version of the endpoint device.

  • timezone :: Maybe Text

    The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.

Instances

Instances details
Eq EndpointDemographic Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointDemographic

Read EndpointDemographic Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointDemographic

Show EndpointDemographic Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointDemographic

Generic EndpointDemographic Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointDemographic

Associated Types

type Rep EndpointDemographic :: Type -> Type #

NFData EndpointDemographic Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointDemographic

Methods

rnf :: EndpointDemographic -> () #

Hashable EndpointDemographic Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointDemographic

ToJSON EndpointDemographic Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointDemographic

FromJSON EndpointDemographic Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointDemographic

type Rep EndpointDemographic Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointDemographic

newEndpointDemographic :: EndpointDemographic Source #

Create a value of EndpointDemographic 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:platform:EndpointDemographic', endpointDemographic_platform - The platform of the endpoint device, such as ios.

$sel:platformVersion:EndpointDemographic', endpointDemographic_platformVersion - The platform version of the endpoint device.

$sel:locale:EndpointDemographic', endpointDemographic_locale - The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.

$sel:appVersion:EndpointDemographic', endpointDemographic_appVersion - The version of the app that's associated with the endpoint.

$sel:model:EndpointDemographic', endpointDemographic_model - The model name or number of the endpoint device, such as iPhone or SM-G900F.

$sel:make:EndpointDemographic', endpointDemographic_make - The manufacturer of the endpoint device, such as apple or samsung.

$sel:modelVersion:EndpointDemographic', endpointDemographic_modelVersion - The model version of the endpoint device.

$sel:timezone:EndpointDemographic', endpointDemographic_timezone - The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.

endpointDemographic_platform :: Lens' EndpointDemographic (Maybe Text) Source #

The platform of the endpoint device, such as ios.

endpointDemographic_platformVersion :: Lens' EndpointDemographic (Maybe Text) Source #

The platform version of the endpoint device.

endpointDemographic_locale :: Lens' EndpointDemographic (Maybe Text) Source #

The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.

endpointDemographic_appVersion :: Lens' EndpointDemographic (Maybe Text) Source #

The version of the app that's associated with the endpoint.

endpointDemographic_model :: Lens' EndpointDemographic (Maybe Text) Source #

The model name or number of the endpoint device, such as iPhone or SM-G900F.

endpointDemographic_make :: Lens' EndpointDemographic (Maybe Text) Source #

The manufacturer of the endpoint device, such as apple or samsung.

endpointDemographic_modelVersion :: Lens' EndpointDemographic (Maybe Text) Source #

The model version of the endpoint device.

endpointDemographic_timezone :: Lens' EndpointDemographic (Maybe Text) Source #

The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.

EndpointItemResponse

data EndpointItemResponse Source #

Provides the status code and message that result from processing data for an endpoint.

See: newEndpointItemResponse smart constructor.

Constructors

EndpointItemResponse' 

Fields

  • message :: Maybe Text

    The custom message that's returned in the response as a result of processing the endpoint data.

  • statusCode :: Maybe Int

    The status code that's returned in the response as a result of processing the endpoint data.

Instances

Instances details
Eq EndpointItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointItemResponse

Read EndpointItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointItemResponse

Show EndpointItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointItemResponse

Generic EndpointItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointItemResponse

Associated Types

type Rep EndpointItemResponse :: Type -> Type #

NFData EndpointItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointItemResponse

Methods

rnf :: EndpointItemResponse -> () #

Hashable EndpointItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointItemResponse

FromJSON EndpointItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointItemResponse

type Rep EndpointItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointItemResponse

type Rep EndpointItemResponse = D1 ('MetaData "EndpointItemResponse" "Amazonka.Pinpoint.Types.EndpointItemResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EndpointItemResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newEndpointItemResponse :: EndpointItemResponse Source #

Create a value of EndpointItemResponse 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:message:EndpointItemResponse', endpointItemResponse_message - The custom message that's returned in the response as a result of processing the endpoint data.

$sel:statusCode:EndpointItemResponse', endpointItemResponse_statusCode - The status code that's returned in the response as a result of processing the endpoint data.

endpointItemResponse_message :: Lens' EndpointItemResponse (Maybe Text) Source #

The custom message that's returned in the response as a result of processing the endpoint data.

endpointItemResponse_statusCode :: Lens' EndpointItemResponse (Maybe Int) Source #

The status code that's returned in the response as a result of processing the endpoint data.

EndpointLocation

data EndpointLocation Source #

Specifies geographic information about an endpoint.

See: newEndpointLocation smart constructor.

Constructors

EndpointLocation' 

Fields

  • postalCode :: Maybe Text

    The postal or ZIP code for the area where the endpoint is located.

  • latitude :: Maybe Double

    The latitude coordinate of the endpoint location, rounded to one decimal place.

  • country :: Maybe Text

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.

  • city :: Maybe Text

    The name of the city where the endpoint is located.

  • region :: Maybe Text

    The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.

  • longitude :: Maybe Double

    The longitude coordinate of the endpoint location, rounded to one decimal place.

Instances

Instances details
Eq EndpointLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointLocation

Read EndpointLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointLocation

Show EndpointLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointLocation

Generic EndpointLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointLocation

Associated Types

type Rep EndpointLocation :: Type -> Type #

NFData EndpointLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointLocation

Methods

rnf :: EndpointLocation -> () #

Hashable EndpointLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointLocation

ToJSON EndpointLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointLocation

FromJSON EndpointLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointLocation

type Rep EndpointLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointLocation

type Rep EndpointLocation = D1 ('MetaData "EndpointLocation" "Amazonka.Pinpoint.Types.EndpointLocation" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EndpointLocation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "postalCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "latitude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "country") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "city") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "longitude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))))

newEndpointLocation :: EndpointLocation Source #

Create a value of EndpointLocation 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:postalCode:EndpointLocation', endpointLocation_postalCode - The postal or ZIP code for the area where the endpoint is located.

$sel:latitude:EndpointLocation', endpointLocation_latitude - The latitude coordinate of the endpoint location, rounded to one decimal place.

$sel:country:EndpointLocation', endpointLocation_country - The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.

$sel:city:EndpointLocation', endpointLocation_city - The name of the city where the endpoint is located.

$sel:region:EndpointLocation', endpointLocation_region - The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.

$sel:longitude:EndpointLocation', endpointLocation_longitude - The longitude coordinate of the endpoint location, rounded to one decimal place.

endpointLocation_postalCode :: Lens' EndpointLocation (Maybe Text) Source #

The postal or ZIP code for the area where the endpoint is located.

endpointLocation_latitude :: Lens' EndpointLocation (Maybe Double) Source #

The latitude coordinate of the endpoint location, rounded to one decimal place.

endpointLocation_country :: Lens' EndpointLocation (Maybe Text) Source #

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.

endpointLocation_city :: Lens' EndpointLocation (Maybe Text) Source #

The name of the city where the endpoint is located.

endpointLocation_region :: Lens' EndpointLocation (Maybe Text) Source #

The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.

endpointLocation_longitude :: Lens' EndpointLocation (Maybe Double) Source #

The longitude coordinate of the endpoint location, rounded to one decimal place.

EndpointMessageResult

data EndpointMessageResult Source #

Provides information about the delivery status and results of sending a message directly to an endpoint.

See: newEndpointMessageResult smart constructor.

Constructors

EndpointMessageResult' 

Fields

  • address :: Maybe Text

    The endpoint address that the message was delivered to.

  • statusMessage :: Maybe Text

    The status message for delivering the message.

  • updatedToken :: Maybe Text

    For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

  • messageId :: Maybe Text

    The unique identifier for the message that was sent.

  • deliveryStatus :: DeliveryStatus

    The delivery status of the message. Possible values are:

    • DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
    • OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
    • PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
    • SUCCESSFUL - The message was successfully delivered to the endpoint.
    • TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
    • THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.
    • TIMEOUT - The message couldn't be sent within the timeout period.
    • UNKNOWN_FAILURE - An unknown error occurred.
  • statusCode :: Int

    The downstream service status code for delivering the message.

Instances

Instances details
Eq EndpointMessageResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointMessageResult

Read EndpointMessageResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointMessageResult

Show EndpointMessageResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointMessageResult

Generic EndpointMessageResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointMessageResult

Associated Types

type Rep EndpointMessageResult :: Type -> Type #

NFData EndpointMessageResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointMessageResult

Methods

rnf :: EndpointMessageResult -> () #

Hashable EndpointMessageResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointMessageResult

FromJSON EndpointMessageResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointMessageResult

type Rep EndpointMessageResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointMessageResult

type Rep EndpointMessageResult = D1 ('MetaData "EndpointMessageResult" "Amazonka.Pinpoint.Types.EndpointMessageResult" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EndpointMessageResult'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "updatedToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "messageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "deliveryStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeliveryStatus) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newEndpointMessageResult Source #

Create a value of EndpointMessageResult 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:address:EndpointMessageResult', endpointMessageResult_address - The endpoint address that the message was delivered to.

$sel:statusMessage:EndpointMessageResult', endpointMessageResult_statusMessage - The status message for delivering the message.

$sel:updatedToken:EndpointMessageResult', endpointMessageResult_updatedToken - For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

$sel:messageId:EndpointMessageResult', endpointMessageResult_messageId - The unique identifier for the message that was sent.

$sel:deliveryStatus:EndpointMessageResult', endpointMessageResult_deliveryStatus - The delivery status of the message. Possible values are:

  • DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
  • OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
  • PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
  • SUCCESSFUL - The message was successfully delivered to the endpoint.
  • TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
  • THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.
  • TIMEOUT - The message couldn't be sent within the timeout period.
  • UNKNOWN_FAILURE - An unknown error occurred.

$sel:statusCode:EndpointMessageResult', endpointMessageResult_statusCode - The downstream service status code for delivering the message.

endpointMessageResult_address :: Lens' EndpointMessageResult (Maybe Text) Source #

The endpoint address that the message was delivered to.

endpointMessageResult_statusMessage :: Lens' EndpointMessageResult (Maybe Text) Source #

The status message for delivering the message.

endpointMessageResult_updatedToken :: Lens' EndpointMessageResult (Maybe Text) Source #

For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

endpointMessageResult_messageId :: Lens' EndpointMessageResult (Maybe Text) Source #

The unique identifier for the message that was sent.

endpointMessageResult_deliveryStatus :: Lens' EndpointMessageResult DeliveryStatus Source #

The delivery status of the message. Possible values are:

  • DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
  • OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
  • PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
  • SUCCESSFUL - The message was successfully delivered to the endpoint.
  • TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
  • THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.
  • TIMEOUT - The message couldn't be sent within the timeout period.
  • UNKNOWN_FAILURE - An unknown error occurred.

endpointMessageResult_statusCode :: Lens' EndpointMessageResult Int Source #

The downstream service status code for delivering the message.

EndpointRequest

data EndpointRequest Source #

Specifies the channel type and other settings for an endpoint.

See: newEndpointRequest smart constructor.

Constructors

EndpointRequest' 

Fields

  • requestId :: Maybe Text

    The unique identifier for the most recent request to update the endpoint.

  • metrics :: Maybe (HashMap Text Double)

    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

  • location :: Maybe EndpointLocation

    The geographic information for the endpoint.

  • demographic :: Maybe EndpointDemographic

    The demographic information for the endpoint, such as the time zone and platform.

  • address :: Maybe Text

    The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

  • effectiveDate :: Maybe Text

    The date and time, in ISO 8601 format, when the endpoint is updated.

  • user :: Maybe EndpointUser

    One or more custom attributes that describe the user who's associated with the endpoint.

  • attributes :: Maybe (HashMap Text [Text])

    One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

    An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

  • endpointStatus :: Maybe Text

    Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

  • optOut :: Maybe Text

    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

  • channelType :: Maybe ChannelType

    The channel to use when sending messages or push notifications to the endpoint.

Instances

Instances details
Eq EndpointRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointRequest

Read EndpointRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointRequest

Show EndpointRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointRequest

Generic EndpointRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointRequest

Associated Types

type Rep EndpointRequest :: Type -> Type #

NFData EndpointRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointRequest

Methods

rnf :: EndpointRequest -> () #

Hashable EndpointRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointRequest

ToJSON EndpointRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointRequest

type Rep EndpointRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointRequest

type Rep EndpointRequest = D1 ('MetaData "EndpointRequest" "Amazonka.Pinpoint.Types.EndpointRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EndpointRequest'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Double)))) :*: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointLocation)) :*: (S1 ('MetaSel ('Just "demographic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointDemographic)) :*: S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "effectiveDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointUser)) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))))) :*: (S1 ('MetaSel ('Just "endpointStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "optOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "channelType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelType)))))))

newEndpointRequest :: EndpointRequest Source #

Create a value of EndpointRequest 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:requestId:EndpointRequest', endpointRequest_requestId - The unique identifier for the most recent request to update the endpoint.

$sel:metrics:EndpointRequest', endpointRequest_metrics - One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

$sel:location:EndpointRequest', endpointRequest_location - The geographic information for the endpoint.

$sel:demographic:EndpointRequest', endpointRequest_demographic - The demographic information for the endpoint, such as the time zone and platform.

$sel:address:EndpointRequest', endpointRequest_address - The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

$sel:effectiveDate:EndpointRequest', endpointRequest_effectiveDate - The date and time, in ISO 8601 format, when the endpoint is updated.

$sel:user:EndpointRequest', endpointRequest_user - One or more custom attributes that describe the user who's associated with the endpoint.

$sel:attributes:EndpointRequest', endpointRequest_attributes - One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

$sel:endpointStatus:EndpointRequest', endpointRequest_endpointStatus - Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

$sel:optOut:EndpointRequest', endpointRequest_optOut - Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

$sel:channelType:EndpointRequest', endpointRequest_channelType - The channel to use when sending messages or push notifications to the endpoint.

endpointRequest_requestId :: Lens' EndpointRequest (Maybe Text) Source #

The unique identifier for the most recent request to update the endpoint.

endpointRequest_metrics :: Lens' EndpointRequest (Maybe (HashMap Text Double)) Source #

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

endpointRequest_location :: Lens' EndpointRequest (Maybe EndpointLocation) Source #

The geographic information for the endpoint.

endpointRequest_demographic :: Lens' EndpointRequest (Maybe EndpointDemographic) Source #

The demographic information for the endpoint, such as the time zone and platform.

endpointRequest_address :: Lens' EndpointRequest (Maybe Text) Source #

The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

endpointRequest_effectiveDate :: Lens' EndpointRequest (Maybe Text) Source #

The date and time, in ISO 8601 format, when the endpoint is updated.

endpointRequest_user :: Lens' EndpointRequest (Maybe EndpointUser) Source #

One or more custom attributes that describe the user who's associated with the endpoint.

endpointRequest_attributes :: Lens' EndpointRequest (Maybe (HashMap Text [Text])) Source #

One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

endpointRequest_endpointStatus :: Lens' EndpointRequest (Maybe Text) Source #

Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

endpointRequest_optOut :: Lens' EndpointRequest (Maybe Text) Source #

Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

endpointRequest_channelType :: Lens' EndpointRequest (Maybe ChannelType) Source #

The channel to use when sending messages or push notifications to the endpoint.

EndpointResponse

data EndpointResponse Source #

Provides information about the channel type and other settings for an endpoint.

See: newEndpointResponse smart constructor.

Constructors

EndpointResponse' 

Fields

  • requestId :: Maybe Text

    The unique identifier for the most recent request to update the endpoint.

  • metrics :: Maybe (HashMap Text Double)

    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

  • location :: Maybe EndpointLocation

    The geographic information for the endpoint.

  • demographic :: Maybe EndpointDemographic

    The demographic information for the endpoint, such as the time zone and platform.

  • cohortId :: Maybe Text

    A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.

  • address :: Maybe Text

    The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.

  • effectiveDate :: Maybe Text

    The date and time, in ISO 8601 format, when the endpoint was last updated.

  • user :: Maybe EndpointUser

    One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

  • applicationId :: Maybe Text

    The unique identifier for the application that's associated with the endpoint.

  • attributes :: Maybe (HashMap Text [Text])

    One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments.

  • endpointStatus :: Maybe Text

    Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

  • optOut :: Maybe Text

    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

  • id :: Maybe Text

    The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.

  • creationDate :: Maybe Text

    The date and time, in ISO 8601 format, when the endpoint was created.

  • channelType :: Maybe ChannelType

    The channel that's used when sending messages or push notifications to the endpoint.

Instances

Instances details
Eq EndpointResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointResponse

Read EndpointResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointResponse

Show EndpointResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointResponse

Generic EndpointResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointResponse

Associated Types

type Rep EndpointResponse :: Type -> Type #

NFData EndpointResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointResponse

Methods

rnf :: EndpointResponse -> () #

Hashable EndpointResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointResponse

FromJSON EndpointResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointResponse

type Rep EndpointResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointResponse

type Rep EndpointResponse = D1 ('MetaData "EndpointResponse" "Amazonka.Pinpoint.Types.EndpointResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EndpointResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Double))) :*: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointLocation)))) :*: ((S1 ('MetaSel ('Just "demographic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointDemographic)) :*: S1 ('MetaSel ('Just "cohortId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "effectiveDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointUser)) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "endpointStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "optOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "channelType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelType)))))))

newEndpointResponse :: EndpointResponse Source #

Create a value of EndpointResponse 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:requestId:EndpointResponse', endpointResponse_requestId - The unique identifier for the most recent request to update the endpoint.

$sel:metrics:EndpointResponse', endpointResponse_metrics - One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

$sel:location:EndpointResponse', endpointResponse_location - The geographic information for the endpoint.

$sel:demographic:EndpointResponse', endpointResponse_demographic - The demographic information for the endpoint, such as the time zone and platform.

$sel:cohortId:EndpointResponse', endpointResponse_cohortId - A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.

$sel:address:EndpointResponse', endpointResponse_address - The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.

$sel:effectiveDate:EndpointResponse', endpointResponse_effectiveDate - The date and time, in ISO 8601 format, when the endpoint was last updated.

$sel:user:EndpointResponse', endpointResponse_user - One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

$sel:applicationId:EndpointResponse', endpointResponse_applicationId - The unique identifier for the application that's associated with the endpoint.

$sel:attributes:EndpointResponse', endpointResponse_attributes - One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments.

$sel:endpointStatus:EndpointResponse', endpointResponse_endpointStatus - Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

$sel:optOut:EndpointResponse', endpointResponse_optOut - Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

$sel:id:EndpointResponse', endpointResponse_id - The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.

$sel:creationDate:EndpointResponse', endpointResponse_creationDate - The date and time, in ISO 8601 format, when the endpoint was created.

$sel:channelType:EndpointResponse', endpointResponse_channelType - The channel that's used when sending messages or push notifications to the endpoint.

endpointResponse_requestId :: Lens' EndpointResponse (Maybe Text) Source #

The unique identifier for the most recent request to update the endpoint.

endpointResponse_metrics :: Lens' EndpointResponse (Maybe (HashMap Text Double)) Source #

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

endpointResponse_location :: Lens' EndpointResponse (Maybe EndpointLocation) Source #

The geographic information for the endpoint.

endpointResponse_demographic :: Lens' EndpointResponse (Maybe EndpointDemographic) Source #

The demographic information for the endpoint, such as the time zone and platform.

endpointResponse_cohortId :: Lens' EndpointResponse (Maybe Text) Source #

A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.

endpointResponse_address :: Lens' EndpointResponse (Maybe Text) Source #

The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.

endpointResponse_effectiveDate :: Lens' EndpointResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the endpoint was last updated.

endpointResponse_user :: Lens' EndpointResponse (Maybe EndpointUser) Source #

One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

endpointResponse_applicationId :: Lens' EndpointResponse (Maybe Text) Source #

The unique identifier for the application that's associated with the endpoint.

endpointResponse_attributes :: Lens' EndpointResponse (Maybe (HashMap Text [Text])) Source #

One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments.

endpointResponse_endpointStatus :: Lens' EndpointResponse (Maybe Text) Source #

Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

endpointResponse_optOut :: Lens' EndpointResponse (Maybe Text) Source #

Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

endpointResponse_id :: Lens' EndpointResponse (Maybe Text) Source #

The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.

endpointResponse_creationDate :: Lens' EndpointResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the endpoint was created.

endpointResponse_channelType :: Lens' EndpointResponse (Maybe ChannelType) Source #

The channel that's used when sending messages or push notifications to the endpoint.

EndpointSendConfiguration

data EndpointSendConfiguration Source #

Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.

See: newEndpointSendConfiguration smart constructor.

Constructors

EndpointSendConfiguration' 

Fields

  • substitutions :: Maybe (HashMap Text [Text])

    A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.

  • titleOverride :: Maybe Text

    The title or subject line of the message. If specified, this value overrides the default message title or subject line.

  • context :: Maybe (HashMap Text Text)

    A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.

    For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

  • rawContent :: Maybe Text

    The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

  • bodyOverride :: Maybe Text

    The body of the message. If specified, this value overrides the default message body.

Instances

Instances details
Eq EndpointSendConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointSendConfiguration

Read EndpointSendConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointSendConfiguration

Show EndpointSendConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointSendConfiguration

Generic EndpointSendConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointSendConfiguration

Associated Types

type Rep EndpointSendConfiguration :: Type -> Type #

NFData EndpointSendConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointSendConfiguration

Hashable EndpointSendConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointSendConfiguration

ToJSON EndpointSendConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointSendConfiguration

type Rep EndpointSendConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointSendConfiguration

type Rep EndpointSendConfiguration = D1 ('MetaData "EndpointSendConfiguration" "Amazonka.Pinpoint.Types.EndpointSendConfiguration" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EndpointSendConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "substitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "titleOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "context") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "rawContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "bodyOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newEndpointSendConfiguration :: EndpointSendConfiguration Source #

Create a value of EndpointSendConfiguration 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:substitutions:EndpointSendConfiguration', endpointSendConfiguration_substitutions - A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.

$sel:titleOverride:EndpointSendConfiguration', endpointSendConfiguration_titleOverride - The title or subject line of the message. If specified, this value overrides the default message title or subject line.

$sel:context:EndpointSendConfiguration', endpointSendConfiguration_context - A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.

For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

$sel:rawContent:EndpointSendConfiguration', endpointSendConfiguration_rawContent - The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

$sel:bodyOverride:EndpointSendConfiguration', endpointSendConfiguration_bodyOverride - The body of the message. If specified, this value overrides the default message body.

endpointSendConfiguration_substitutions :: Lens' EndpointSendConfiguration (Maybe (HashMap Text [Text])) Source #

A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.

endpointSendConfiguration_titleOverride :: Lens' EndpointSendConfiguration (Maybe Text) Source #

The title or subject line of the message. If specified, this value overrides the default message title or subject line.

endpointSendConfiguration_context :: Lens' EndpointSendConfiguration (Maybe (HashMap Text Text)) Source #

A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.

For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

endpointSendConfiguration_rawContent :: Lens' EndpointSendConfiguration (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

endpointSendConfiguration_bodyOverride :: Lens' EndpointSendConfiguration (Maybe Text) Source #

The body of the message. If specified, this value overrides the default message body.

EndpointUser

data EndpointUser Source #

Specifies data for one or more attributes that describe the user who's associated with an endpoint.

See: newEndpointUser smart constructor.

Constructors

EndpointUser' 

Fields

  • userAttributes :: Maybe (HashMap Text [Text])

    One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

    An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

  • userId :: Maybe Text

    The unique identifier for the user.

Instances

Instances details
Eq EndpointUser Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointUser

Read EndpointUser Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointUser

Show EndpointUser Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointUser

Generic EndpointUser Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointUser

Associated Types

type Rep EndpointUser :: Type -> Type #

NFData EndpointUser Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointUser

Methods

rnf :: EndpointUser -> () #

Hashable EndpointUser Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointUser

ToJSON EndpointUser Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointUser

FromJSON EndpointUser Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointUser

type Rep EndpointUser Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointUser

type Rep EndpointUser = D1 ('MetaData "EndpointUser" "Amazonka.Pinpoint.Types.EndpointUser" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EndpointUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newEndpointUser :: EndpointUser Source #

Create a value of EndpointUser 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:userAttributes:EndpointUser', endpointUser_userAttributes - One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

$sel:userId:EndpointUser', endpointUser_userId - The unique identifier for the user.

endpointUser_userAttributes :: Lens' EndpointUser (Maybe (HashMap Text [Text])) Source #

One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

endpointUser_userId :: Lens' EndpointUser (Maybe Text) Source #

The unique identifier for the user.

EndpointsResponse

data EndpointsResponse Source #

Provides information about all the endpoints that are associated with a user ID.

See: newEndpointsResponse smart constructor.

Constructors

EndpointsResponse' 

Fields

  • item :: [EndpointResponse]

    An array of responses, one for each endpoint that's associated with the user ID.

Instances

Instances details
Eq EndpointsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointsResponse

Read EndpointsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointsResponse

Show EndpointsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointsResponse

Generic EndpointsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointsResponse

Associated Types

type Rep EndpointsResponse :: Type -> Type #

NFData EndpointsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointsResponse

Methods

rnf :: EndpointsResponse -> () #

Hashable EndpointsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointsResponse

FromJSON EndpointsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointsResponse

type Rep EndpointsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EndpointsResponse

type Rep EndpointsResponse = D1 ('MetaData "EndpointsResponse" "Amazonka.Pinpoint.Types.EndpointsResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EndpointsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [EndpointResponse])))

newEndpointsResponse :: EndpointsResponse Source #

Create a value of EndpointsResponse 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:item:EndpointsResponse', endpointsResponse_item - An array of responses, one for each endpoint that's associated with the user ID.

endpointsResponse_item :: Lens' EndpointsResponse [EndpointResponse] Source #

An array of responses, one for each endpoint that's associated with the user ID.

Event

data Event Source #

Specifies information about an event that reports data to Amazon Pinpoint.

See: newEvent smart constructor.

Constructors

Event' 

Fields

Instances

Instances details
Eq Event Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Event

Methods

(==) :: Event -> Event -> Bool #

(/=) :: Event -> Event -> Bool #

Read Event Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Event

Show Event Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Event

Methods

showsPrec :: Int -> Event -> ShowS #

show :: Event -> String #

showList :: [Event] -> ShowS #

Generic Event Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Event

Associated Types

type Rep Event :: Type -> Type #

Methods

from :: Event -> Rep Event x #

to :: Rep Event x -> Event #

NFData Event Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Event

Methods

rnf :: Event -> () #

Hashable Event Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Event

Methods

hashWithSalt :: Int -> Event -> Int #

hash :: Event -> Int #

ToJSON Event Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Event

type Rep Event Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Event

newEvent Source #

Create a value of Event 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:clientSdkVersion:Event', event_clientSdkVersion - The version of the SDK that's running on the client device.

$sel:metrics:Event', event_metrics - One or more custom metrics that are associated with the event.

$sel:appVersionCode:Event', event_appVersionCode - The version number of the app that's recording the event.

$sel:appTitle:Event', event_appTitle - The title of the app that's recording the event.

$sel:appPackageName:Event', event_appPackageName - The package name of the app that's recording the event.

$sel:attributes:Event', event_attributes - One or more custom attributes that are associated with the event.

$sel:sdkName:Event', event_sdkName - The name of the SDK that's being used to record the event.

$sel:session:Event', event_session - Information about the session in which the event occurred.

$sel:eventType:Event', event_eventType - The name of the event.

$sel:timestamp:Event', event_timestamp - The date and time, in ISO 8601 format, when the event occurred.

event_clientSdkVersion :: Lens' Event (Maybe Text) Source #

The version of the SDK that's running on the client device.

event_metrics :: Lens' Event (Maybe (HashMap Text Double)) Source #

One or more custom metrics that are associated with the event.

event_appVersionCode :: Lens' Event (Maybe Text) Source #

The version number of the app that's recording the event.

event_appTitle :: Lens' Event (Maybe Text) Source #

The title of the app that's recording the event.

event_appPackageName :: Lens' Event (Maybe Text) Source #

The package name of the app that's recording the event.

event_attributes :: Lens' Event (Maybe (HashMap Text Text)) Source #

One or more custom attributes that are associated with the event.

event_sdkName :: Lens' Event (Maybe Text) Source #

The name of the SDK that's being used to record the event.

event_session :: Lens' Event (Maybe Session) Source #

Information about the session in which the event occurred.

event_eventType :: Lens' Event Text Source #

The name of the event.

event_timestamp :: Lens' Event Text Source #

The date and time, in ISO 8601 format, when the event occurred.

EventCondition

data EventCondition Source #

Specifies the conditions to evaluate for an event that applies to an activity in a journey.

See: newEventCondition smart constructor.

Constructors

EventCondition' 

Fields

Instances

Instances details
Eq EventCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventCondition

Read EventCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventCondition

Show EventCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventCondition

Generic EventCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventCondition

Associated Types

type Rep EventCondition :: Type -> Type #

NFData EventCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventCondition

Methods

rnf :: EventCondition -> () #

Hashable EventCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventCondition

ToJSON EventCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventCondition

FromJSON EventCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventCondition

type Rep EventCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventCondition

type Rep EventCondition = D1 ('MetaData "EventCondition" "Amazonka.Pinpoint.Types.EventCondition" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EventCondition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventDimensions)) :*: S1 ('MetaSel ('Just "messageActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newEventCondition :: EventCondition Source #

Create a value of EventCondition 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:EventCondition', eventCondition_dimensions - The dimensions for the event filter to use for the activity.

$sel:messageActivity:EventCondition', eventCondition_messageActivity - The message identifier (message_id) for the message to use when determining whether message events meet the condition.

eventCondition_dimensions :: Lens' EventCondition (Maybe EventDimensions) Source #

The dimensions for the event filter to use for the activity.

eventCondition_messageActivity :: Lens' EventCondition (Maybe Text) Source #

The message identifier (message_id) for the message to use when determining whether message events meet the condition.

EventDimensions

data EventDimensions Source #

Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.

See: newEventDimensions smart constructor.

Constructors

EventDimensions' 

Fields

  • metrics :: Maybe (HashMap Text MetricDimension)

    One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

  • eventType :: Maybe SetDimension

    The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide.

  • attributes :: Maybe (HashMap Text AttributeDimension)

    One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

Instances

Instances details
Eq EventDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventDimensions

Read EventDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventDimensions

Show EventDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventDimensions

Generic EventDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventDimensions

Associated Types

type Rep EventDimensions :: Type -> Type #

NFData EventDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventDimensions

Methods

rnf :: EventDimensions -> () #

Hashable EventDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventDimensions

ToJSON EventDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventDimensions

FromJSON EventDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventDimensions

type Rep EventDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventDimensions

type Rep EventDimensions = D1 ('MetaData "EventDimensions" "Amazonka.Pinpoint.Types.EventDimensions" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EventDimensions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text MetricDimension))) :*: (S1 ('MetaSel ('Just "eventType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SetDimension)) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text AttributeDimension))))))

newEventDimensions :: EventDimensions Source #

Create a value of EventDimensions 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:metrics:EventDimensions', eventDimensions_metrics - One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

$sel:eventType:EventDimensions', eventDimensions_eventType - The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide.

$sel:attributes:EventDimensions', eventDimensions_attributes - One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

eventDimensions_metrics :: Lens' EventDimensions (Maybe (HashMap Text MetricDimension)) Source #

One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

eventDimensions_eventType :: Lens' EventDimensions (Maybe SetDimension) Source #

The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide.

eventDimensions_attributes :: Lens' EventDimensions (Maybe (HashMap Text AttributeDimension)) Source #

One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

EventFilter

data EventFilter Source #

Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.

See: newEventFilter smart constructor.

Constructors

EventFilter' 

Fields

  • filterType :: FilterType

    The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.

  • dimensions :: EventDimensions

    The dimensions for the event filter to use for the campaign or the journey activity.

Instances

Instances details
Eq EventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventFilter

Read EventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventFilter

Show EventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventFilter

Generic EventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventFilter

Associated Types

type Rep EventFilter :: Type -> Type #

NFData EventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventFilter

Methods

rnf :: EventFilter -> () #

Hashable EventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventFilter

ToJSON EventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventFilter

FromJSON EventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventFilter

type Rep EventFilter Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventFilter

type Rep EventFilter = D1 ('MetaData "EventFilter" "Amazonka.Pinpoint.Types.EventFilter" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EventFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filterType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilterType) :*: S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EventDimensions)))

newEventFilter Source #

Create a value of EventFilter 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:filterType:EventFilter', eventFilter_filterType - The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.

$sel:dimensions:EventFilter', eventFilter_dimensions - The dimensions for the event filter to use for the campaign or the journey activity.

eventFilter_filterType :: Lens' EventFilter FilterType Source #

The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.

eventFilter_dimensions :: Lens' EventFilter EventDimensions Source #

The dimensions for the event filter to use for the campaign or the journey activity.

EventItemResponse

data EventItemResponse Source #

Provides the status code and message that result from processing an event.

See: newEventItemResponse smart constructor.

Constructors

EventItemResponse' 

Fields

  • message :: Maybe Text

    A custom message that's returned in the response as a result of processing the event.

  • statusCode :: Maybe Int

    The status code that's returned in the response as a result of processing the event. Possible values are: 202, for events that were accepted; and, 400, for events that weren't valid.

Instances

Instances details
Eq EventItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventItemResponse

Read EventItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventItemResponse

Show EventItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventItemResponse

Generic EventItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventItemResponse

Associated Types

type Rep EventItemResponse :: Type -> Type #

NFData EventItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventItemResponse

Methods

rnf :: EventItemResponse -> () #

Hashable EventItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventItemResponse

FromJSON EventItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventItemResponse

type Rep EventItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventItemResponse

type Rep EventItemResponse = D1 ('MetaData "EventItemResponse" "Amazonka.Pinpoint.Types.EventItemResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EventItemResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newEventItemResponse :: EventItemResponse Source #

Create a value of EventItemResponse 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:message:EventItemResponse', eventItemResponse_message - A custom message that's returned in the response as a result of processing the event.

$sel:statusCode:EventItemResponse', eventItemResponse_statusCode - The status code that's returned in the response as a result of processing the event. Possible values are: 202, for events that were accepted; and, 400, for events that weren't valid.

eventItemResponse_message :: Lens' EventItemResponse (Maybe Text) Source #

A custom message that's returned in the response as a result of processing the event.

eventItemResponse_statusCode :: Lens' EventItemResponse (Maybe Int) Source #

The status code that's returned in the response as a result of processing the event. Possible values are: 202, for events that were accepted; and, 400, for events that weren't valid.

EventStartCondition

data EventStartCondition Source #

Specifies the settings for an event that causes a journey activity to start.

See: newEventStartCondition smart constructor.

Instances

Instances details
Eq EventStartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStartCondition

Read EventStartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStartCondition

Show EventStartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStartCondition

Generic EventStartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStartCondition

Associated Types

type Rep EventStartCondition :: Type -> Type #

NFData EventStartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStartCondition

Methods

rnf :: EventStartCondition -> () #

Hashable EventStartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStartCondition

ToJSON EventStartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStartCondition

FromJSON EventStartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStartCondition

type Rep EventStartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStartCondition

type Rep EventStartCondition = D1 ('MetaData "EventStartCondition" "Amazonka.Pinpoint.Types.EventStartCondition" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EventStartCondition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventFilter)) :*: S1 ('MetaSel ('Just "segmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newEventStartCondition :: EventStartCondition Source #

Create a value of EventStartCondition 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:eventFilter:EventStartCondition', eventStartCondition_eventFilter - Undocumented member.

$sel:segmentId:EventStartCondition', eventStartCondition_segmentId - Undocumented member.

EventStream

data EventStream Source #

Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.

See: newEventStream smart constructor.

Constructors

EventStream' 

Fields

  • lastUpdatedBy :: Maybe Text

    The IAM user who last modified the event stream.

  • lastModifiedDate :: Maybe Text

    The date, in ISO 8601 format, when the event stream was last modified.

  • externalId :: Maybe Text

    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

  • applicationId :: Text

    The unique identifier for the application to publish event data for.

  • roleArn :: Text

    The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

  • destinationStreamArn :: Text

    The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.

    For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name

    For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

Instances

Instances details
Eq EventStream Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStream

Read EventStream Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStream

Show EventStream Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStream

Generic EventStream Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStream

Associated Types

type Rep EventStream :: Type -> Type #

NFData EventStream Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStream

Methods

rnf :: EventStream -> () #

Hashable EventStream Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStream

FromJSON EventStream Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStream

type Rep EventStream Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventStream

type Rep EventStream = D1 ('MetaData "EventStream" "Amazonka.Pinpoint.Types.EventStream" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EventStream'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lastUpdatedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "destinationStreamArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newEventStream Source #

Create a value of EventStream 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:lastUpdatedBy:EventStream', eventStream_lastUpdatedBy - The IAM user who last modified the event stream.

$sel:lastModifiedDate:EventStream', eventStream_lastModifiedDate - The date, in ISO 8601 format, when the event stream was last modified.

$sel:externalId:EventStream', eventStream_externalId - (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

$sel:applicationId:EventStream', eventStream_applicationId - The unique identifier for the application to publish event data for.

$sel:roleArn:EventStream', eventStream_roleArn - The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

$sel:destinationStreamArn:EventStream', eventStream_destinationStreamArn - The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.

For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name

For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

eventStream_lastUpdatedBy :: Lens' EventStream (Maybe Text) Source #

The IAM user who last modified the event stream.

eventStream_lastModifiedDate :: Lens' EventStream (Maybe Text) Source #

The date, in ISO 8601 format, when the event stream was last modified.

eventStream_externalId :: Lens' EventStream (Maybe Text) Source #

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

eventStream_applicationId :: Lens' EventStream Text Source #

The unique identifier for the application to publish event data for.

eventStream_roleArn :: Lens' EventStream Text Source #

The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

eventStream_destinationStreamArn :: Lens' EventStream Text Source #

The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.

For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name

For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

EventsBatch

data EventsBatch Source #

Specifies a batch of endpoints and events to process.

See: newEventsBatch smart constructor.

Constructors

EventsBatch' 

Fields

Instances

Instances details
Eq EventsBatch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsBatch

Read EventsBatch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsBatch

Show EventsBatch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsBatch

Generic EventsBatch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsBatch

Associated Types

type Rep EventsBatch :: Type -> Type #

NFData EventsBatch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsBatch

Methods

rnf :: EventsBatch -> () #

Hashable EventsBatch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsBatch

ToJSON EventsBatch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsBatch

type Rep EventsBatch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsBatch

type Rep EventsBatch = D1 ('MetaData "EventsBatch" "Amazonka.Pinpoint.Types.EventsBatch" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EventsBatch'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PublicEndpoint) :*: S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Event))))

newEventsBatch Source #

Create a value of EventsBatch 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:endpoint:EventsBatch', eventsBatch_endpoint - A set of properties and attributes that are associated with the endpoint.

$sel:events:EventsBatch', eventsBatch_events - A set of properties that are associated with the event.

eventsBatch_endpoint :: Lens' EventsBatch PublicEndpoint Source #

A set of properties and attributes that are associated with the endpoint.

eventsBatch_events :: Lens' EventsBatch (HashMap Text Event) Source #

A set of properties that are associated with the event.

EventsRequest

data EventsRequest Source #

Specifies a batch of events to process.

See: newEventsRequest smart constructor.

Constructors

EventsRequest' 

Fields

  • batchItem :: HashMap Text EventsBatch

    The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value.

Instances

Instances details
Eq EventsRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsRequest

Read EventsRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsRequest

Show EventsRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsRequest

Generic EventsRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsRequest

Associated Types

type Rep EventsRequest :: Type -> Type #

NFData EventsRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsRequest

Methods

rnf :: EventsRequest -> () #

Hashable EventsRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsRequest

ToJSON EventsRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsRequest

type Rep EventsRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsRequest

type Rep EventsRequest = D1 ('MetaData "EventsRequest" "Amazonka.Pinpoint.Types.EventsRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EventsRequest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "batchItem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text EventsBatch))))

newEventsRequest :: EventsRequest Source #

Create a value of EventsRequest 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:batchItem:EventsRequest', eventsRequest_batchItem - The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value.

eventsRequest_batchItem :: Lens' EventsRequest (HashMap Text EventsBatch) Source #

The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value.

EventsResponse

data EventsResponse Source #

Provides information about endpoints and the events that they're associated with.

See: newEventsResponse smart constructor.

Constructors

EventsResponse' 

Fields

  • results :: Maybe (HashMap Text ItemResponse)

    A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn't valid or required fields were missing.

Instances

Instances details
Eq EventsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsResponse

Read EventsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsResponse

Show EventsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsResponse

Generic EventsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsResponse

Associated Types

type Rep EventsResponse :: Type -> Type #

NFData EventsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsResponse

Methods

rnf :: EventsResponse -> () #

Hashable EventsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsResponse

FromJSON EventsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsResponse

type Rep EventsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EventsResponse

type Rep EventsResponse = D1 ('MetaData "EventsResponse" "Amazonka.Pinpoint.Types.EventsResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text ItemResponse)))))

newEventsResponse :: EventsResponse Source #

Create a value of EventsResponse 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:results:EventsResponse', eventsResponse_results - A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn't valid or required fields were missing.

eventsResponse_results :: Lens' EventsResponse (Maybe (HashMap Text ItemResponse)) Source #

A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn't valid or required fields were missing.

ExportJobRequest

data ExportJobRequest Source #

Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.

See: newExportJobRequest smart constructor.

Constructors

ExportJobRequest' 

Fields

  • segmentId :: Maybe Text

    The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.

  • segmentVersion :: Maybe Int

    The version of the segment to export endpoint definitions from, if specified.

  • s3UrlPrefix :: Text

    The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

  • roleArn :: Text

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.

Instances

Instances details
Eq ExportJobRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobRequest

Read ExportJobRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobRequest

Show ExportJobRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobRequest

Generic ExportJobRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobRequest

Associated Types

type Rep ExportJobRequest :: Type -> Type #

NFData ExportJobRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobRequest

Methods

rnf :: ExportJobRequest -> () #

Hashable ExportJobRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobRequest

ToJSON ExportJobRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobRequest

type Rep ExportJobRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobRequest

type Rep ExportJobRequest = D1 ('MetaData "ExportJobRequest" "Amazonka.Pinpoint.Types.ExportJobRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ExportJobRequest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "segmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "segmentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "s3UrlPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newExportJobRequest Source #

Create a value of ExportJobRequest 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:segmentId:ExportJobRequest', exportJobRequest_segmentId - The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.

$sel:segmentVersion:ExportJobRequest', exportJobRequest_segmentVersion - The version of the segment to export endpoint definitions from, if specified.

$sel:s3UrlPrefix:ExportJobRequest', exportJobRequest_s3UrlPrefix - The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

$sel:roleArn:ExportJobRequest', exportJobRequest_roleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.

exportJobRequest_segmentId :: Lens' ExportJobRequest (Maybe Text) Source #

The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.

exportJobRequest_segmentVersion :: Lens' ExportJobRequest (Maybe Int) Source #

The version of the segment to export endpoint definitions from, if specified.

exportJobRequest_s3UrlPrefix :: Lens' ExportJobRequest Text Source #

The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

exportJobRequest_roleArn :: Lens' ExportJobRequest Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.

ExportJobResource

data ExportJobResource Source #

Provides information about the resource settings for a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

See: newExportJobResource smart constructor.

Constructors

ExportJobResource' 

Fields

  • segmentId :: Maybe Text

    The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

  • segmentVersion :: Maybe Int

    The version of the segment that the endpoint definitions were exported from.

  • s3UrlPrefix :: Text

    The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

  • roleArn :: Text

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.

Instances

Instances details
Eq ExportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobResource

Read ExportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobResource

Show ExportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobResource

Generic ExportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobResource

Associated Types

type Rep ExportJobResource :: Type -> Type #

NFData ExportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobResource

Methods

rnf :: ExportJobResource -> () #

Hashable ExportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobResource

FromJSON ExportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobResource

type Rep ExportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobResource

type Rep ExportJobResource = D1 ('MetaData "ExportJobResource" "Amazonka.Pinpoint.Types.ExportJobResource" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ExportJobResource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "segmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "segmentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "s3UrlPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newExportJobResource Source #

Create a value of ExportJobResource 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:segmentId:ExportJobResource', exportJobResource_segmentId - The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

$sel:segmentVersion:ExportJobResource', exportJobResource_segmentVersion - The version of the segment that the endpoint definitions were exported from.

$sel:s3UrlPrefix:ExportJobResource', exportJobResource_s3UrlPrefix - The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

$sel:roleArn:ExportJobResource', exportJobResource_roleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.

exportJobResource_segmentId :: Lens' ExportJobResource (Maybe Text) Source #

The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

exportJobResource_segmentVersion :: Lens' ExportJobResource (Maybe Int) Source #

The version of the segment that the endpoint definitions were exported from.

exportJobResource_s3UrlPrefix :: Lens' ExportJobResource Text Source #

The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

exportJobResource_roleArn :: Lens' ExportJobResource Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.

ExportJobResponse

data ExportJobResponse Source #

Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

See: newExportJobResponse smart constructor.

Constructors

ExportJobResponse' 

Fields

  • completedPieces :: Maybe Int

    The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.

  • failedPieces :: Maybe Int

    The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.

  • totalProcessed :: Maybe Int

    The total number of endpoint definitions that were processed by the export job.

  • failures :: Maybe [Text]

    An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.

  • totalPieces :: Maybe Int

    The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.

  • completionDate :: Maybe Text

    The date, in ISO 8601 format, when the export job was completed.

  • totalFailures :: Maybe Int

    The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.

  • jobStatus :: JobStatus

    The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

  • creationDate :: Text

    The date, in ISO 8601 format, when the export job was created.

  • type' :: Text

    The job type. This value is EXPORT for export jobs.

  • definition :: ExportJobResource

    The resource settings that apply to the export job.

  • id :: Text

    The unique identifier for the export job.

  • applicationId :: Text

    The unique identifier for the application that's associated with the export job.

Instances

Instances details
Eq ExportJobResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobResponse

Read ExportJobResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobResponse

Show ExportJobResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobResponse

Generic ExportJobResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobResponse

Associated Types

type Rep ExportJobResponse :: Type -> Type #

NFData ExportJobResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobResponse

Methods

rnf :: ExportJobResponse -> () #

Hashable ExportJobResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobResponse

FromJSON ExportJobResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobResponse

type Rep ExportJobResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobResponse

type Rep ExportJobResponse = D1 ('MetaData "ExportJobResponse" "Amazonka.Pinpoint.Types.ExportJobResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ExportJobResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "completedPieces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "failedPieces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "totalProcessed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "failures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "totalPieces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "completionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "totalFailures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobStatus) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "definition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExportJobResource)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newExportJobResponse Source #

Create a value of ExportJobResponse 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:completedPieces:ExportJobResponse', exportJobResponse_completedPieces - The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.

$sel:failedPieces:ExportJobResponse', exportJobResponse_failedPieces - The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.

$sel:totalProcessed:ExportJobResponse', exportJobResponse_totalProcessed - The total number of endpoint definitions that were processed by the export job.

$sel:failures:ExportJobResponse', exportJobResponse_failures - An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.

$sel:totalPieces:ExportJobResponse', exportJobResponse_totalPieces - The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.

$sel:completionDate:ExportJobResponse', exportJobResponse_completionDate - The date, in ISO 8601 format, when the export job was completed.

$sel:totalFailures:ExportJobResponse', exportJobResponse_totalFailures - The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.

$sel:jobStatus:ExportJobResponse', exportJobResponse_jobStatus - The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

$sel:creationDate:ExportJobResponse', exportJobResponse_creationDate - The date, in ISO 8601 format, when the export job was created.

$sel:type':ExportJobResponse', exportJobResponse_type - The job type. This value is EXPORT for export jobs.

$sel:definition:ExportJobResponse', exportJobResponse_definition - The resource settings that apply to the export job.

$sel:id:ExportJobResponse', exportJobResponse_id - The unique identifier for the export job.

$sel:applicationId:ExportJobResponse', exportJobResponse_applicationId - The unique identifier for the application that's associated with the export job.

exportJobResponse_completedPieces :: Lens' ExportJobResponse (Maybe Int) Source #

The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.

exportJobResponse_failedPieces :: Lens' ExportJobResponse (Maybe Int) Source #

The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.

exportJobResponse_totalProcessed :: Lens' ExportJobResponse (Maybe Int) Source #

The total number of endpoint definitions that were processed by the export job.

exportJobResponse_failures :: Lens' ExportJobResponse (Maybe [Text]) Source #

An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.

exportJobResponse_totalPieces :: Lens' ExportJobResponse (Maybe Int) Source #

The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.

exportJobResponse_completionDate :: Lens' ExportJobResponse (Maybe Text) Source #

The date, in ISO 8601 format, when the export job was completed.

exportJobResponse_totalFailures :: Lens' ExportJobResponse (Maybe Int) Source #

The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.

exportJobResponse_jobStatus :: Lens' ExportJobResponse JobStatus Source #

The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

exportJobResponse_creationDate :: Lens' ExportJobResponse Text Source #

The date, in ISO 8601 format, when the export job was created.

exportJobResponse_type :: Lens' ExportJobResponse Text Source #

The job type. This value is EXPORT for export jobs.

exportJobResponse_definition :: Lens' ExportJobResponse ExportJobResource Source #

The resource settings that apply to the export job.

exportJobResponse_id :: Lens' ExportJobResponse Text Source #

The unique identifier for the export job.

exportJobResponse_applicationId :: Lens' ExportJobResponse Text Source #

The unique identifier for the application that's associated with the export job.

ExportJobsResponse

data ExportJobsResponse Source #

Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.

See: newExportJobsResponse smart constructor.

Constructors

ExportJobsResponse' 

Fields

  • nextToken :: Maybe Text

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

  • item :: [ExportJobResponse]

    An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).

Instances

Instances details
Eq ExportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobsResponse

Read ExportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobsResponse

Show ExportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobsResponse

Generic ExportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobsResponse

Associated Types

type Rep ExportJobsResponse :: Type -> Type #

NFData ExportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobsResponse

Methods

rnf :: ExportJobsResponse -> () #

Hashable ExportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobsResponse

FromJSON ExportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobsResponse

type Rep ExportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ExportJobsResponse

type Rep ExportJobsResponse = D1 ('MetaData "ExportJobsResponse" "Amazonka.Pinpoint.Types.ExportJobsResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ExportJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ExportJobResponse])))

newExportJobsResponse :: ExportJobsResponse Source #

Create a value of ExportJobsResponse 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:nextToken:ExportJobsResponse', exportJobsResponse_nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

$sel:item:ExportJobsResponse', exportJobsResponse_item - An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).

exportJobsResponse_nextToken :: Lens' ExportJobsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

exportJobsResponse_item :: Lens' ExportJobsResponse [ExportJobResponse] Source #

An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).

GCMChannelRequest

data GCMChannelRequest Source #

Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

See: newGCMChannelRequest smart constructor.

Constructors

GCMChannelRequest' 

Fields

  • enabled :: Maybe Bool

    Specifies whether to enable the GCM channel for the application.

  • apiKey :: Text

    The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

Instances

Instances details
Eq GCMChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMChannelRequest

Read GCMChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMChannelRequest

Show GCMChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMChannelRequest

Generic GCMChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMChannelRequest

Associated Types

type Rep GCMChannelRequest :: Type -> Type #

NFData GCMChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMChannelRequest

Methods

rnf :: GCMChannelRequest -> () #

Hashable GCMChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMChannelRequest

ToJSON GCMChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMChannelRequest

type Rep GCMChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMChannelRequest

type Rep GCMChannelRequest = D1 ('MetaData "GCMChannelRequest" "Amazonka.Pinpoint.Types.GCMChannelRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GCMChannelRequest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "apiKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGCMChannelRequest Source #

Create a value of GCMChannelRequest 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:enabled:GCMChannelRequest', gCMChannelRequest_enabled - Specifies whether to enable the GCM channel for the application.

$sel:apiKey:GCMChannelRequest', gCMChannelRequest_apiKey - The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

gCMChannelRequest_enabled :: Lens' GCMChannelRequest (Maybe Bool) Source #

Specifies whether to enable the GCM channel for the application.

gCMChannelRequest_apiKey :: Lens' GCMChannelRequest Text Source #

The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

GCMChannelResponse

data GCMChannelResponse Source #

Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

See: newGCMChannelResponse smart constructor.

Constructors

GCMChannelResponse' 

Fields

  • lastModifiedDate :: Maybe Text

    The date and time when the GCM channel was last modified.

  • enabled :: Maybe Bool

    Specifies whether the GCM channel is enabled for the application.

  • isArchived :: Maybe Bool

    Specifies whether the GCM channel is archived.

  • applicationId :: Maybe Text

    The unique identifier for the application that the GCM channel applies to.

  • version :: Maybe Int

    The current version of the GCM channel.

  • id :: Maybe Text

    (Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.

  • creationDate :: Maybe Text

    The date and time when the GCM channel was enabled.

  • lastModifiedBy :: Maybe Text

    The user who last modified the GCM channel.

  • hasCredential :: Maybe Bool

    (Not used) This property is retained only for backward compatibility.

  • credential :: Text

    The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

  • platform :: Text

    The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.

Instances

Instances details
Eq GCMChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMChannelResponse

Read GCMChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMChannelResponse

Show GCMChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMChannelResponse

Generic GCMChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMChannelResponse

Associated Types

type Rep GCMChannelResponse :: Type -> Type #

NFData GCMChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMChannelResponse

Methods

rnf :: GCMChannelResponse -> () #

Hashable GCMChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMChannelResponse

FromJSON GCMChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMChannelResponse

type Rep GCMChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMChannelResponse

type Rep GCMChannelResponse = D1 ('MetaData "GCMChannelResponse" "Amazonka.Pinpoint.Types.GCMChannelResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GCMChannelResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "isArchived") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "hasCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "credential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newGCMChannelResponse Source #

Create a value of GCMChannelResponse 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:lastModifiedDate:GCMChannelResponse', gCMChannelResponse_lastModifiedDate - The date and time when the GCM channel was last modified.

$sel:enabled:GCMChannelResponse', gCMChannelResponse_enabled - Specifies whether the GCM channel is enabled for the application.

$sel:isArchived:GCMChannelResponse', gCMChannelResponse_isArchived - Specifies whether the GCM channel is archived.

$sel:applicationId:GCMChannelResponse', gCMChannelResponse_applicationId - The unique identifier for the application that the GCM channel applies to.

$sel:version:GCMChannelResponse', gCMChannelResponse_version - The current version of the GCM channel.

$sel:id:GCMChannelResponse', gCMChannelResponse_id - (Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.

$sel:creationDate:GCMChannelResponse', gCMChannelResponse_creationDate - The date and time when the GCM channel was enabled.

$sel:lastModifiedBy:GCMChannelResponse', gCMChannelResponse_lastModifiedBy - The user who last modified the GCM channel.

$sel:hasCredential:GCMChannelResponse', gCMChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.

$sel:credential:GCMChannelResponse', gCMChannelResponse_credential - The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

$sel:platform:GCMChannelResponse', gCMChannelResponse_platform - The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.

gCMChannelResponse_lastModifiedDate :: Lens' GCMChannelResponse (Maybe Text) Source #

The date and time when the GCM channel was last modified.

gCMChannelResponse_enabled :: Lens' GCMChannelResponse (Maybe Bool) Source #

Specifies whether the GCM channel is enabled for the application.

gCMChannelResponse_isArchived :: Lens' GCMChannelResponse (Maybe Bool) Source #

Specifies whether the GCM channel is archived.

gCMChannelResponse_applicationId :: Lens' GCMChannelResponse (Maybe Text) Source #

The unique identifier for the application that the GCM channel applies to.

gCMChannelResponse_version :: Lens' GCMChannelResponse (Maybe Int) Source #

The current version of the GCM channel.

gCMChannelResponse_id :: Lens' GCMChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.

gCMChannelResponse_creationDate :: Lens' GCMChannelResponse (Maybe Text) Source #

The date and time when the GCM channel was enabled.

gCMChannelResponse_lastModifiedBy :: Lens' GCMChannelResponse (Maybe Text) Source #

The user who last modified the GCM channel.

gCMChannelResponse_hasCredential :: Lens' GCMChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

gCMChannelResponse_credential :: Lens' GCMChannelResponse Text Source #

The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

gCMChannelResponse_platform :: Lens' GCMChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.

GCMMessage

data GCMMessage Source #

Specifies the settings for a one-time message that's sent directly to an endpoint through the GCM channel. The GCM channel enables Amazon Pinpoint to send messages to the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

See: newGCMMessage smart constructor.

Constructors

GCMMessage' 

Fields

  • substitutions :: Maybe (HashMap Text [Text])

    The default message variables to use in the notification message. You can override the default variables with individual address variables.

  • silentPush :: Maybe Bool

    Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

  • imageIconUrl :: Maybe Text

    The URL of the large icon image to display in the content view of the push notification.

  • priority :: Maybe Text

    para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.

    /listitem>

    high - The notification is sent immediately and might wake a sleeping device.

    /para>

    Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.

    The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.

  • rawContent :: Maybe Text

    The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

  • data' :: Maybe (HashMap Text Text)

    The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

  • restrictedPackageName :: Maybe Text

    The package name of the application where registration tokens must match in order for the recipient to receive the message.

  • smallImageIconUrl :: Maybe Text

    The URL of the small icon image to display in the status bar and the content view of the push notification.

  • body :: Maybe Text

    The body of the notification message.

  • timeToLive :: Maybe Int

    The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).

    Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.

  • url :: Maybe Text

    The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

  • sound :: Maybe Text

    The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

  • action :: Maybe Action

    The action to occur if the recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
  • collapseKey :: Maybe Text

    An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.

    Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.

  • imageUrl :: Maybe Text

    The URL of an image to display in the push notification.

  • title :: Maybe Text

    The title to display above the notification message on the recipient's device.

  • iconReference :: Maybe Text

    The icon image name of the asset saved in your app.

Instances

Instances details
Eq GCMMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMMessage

Read GCMMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMMessage

Show GCMMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMMessage

Generic GCMMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMMessage

Associated Types

type Rep GCMMessage :: Type -> Type #

NFData GCMMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMMessage

Methods

rnf :: GCMMessage -> () #

Hashable GCMMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMMessage

ToJSON GCMMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMMessage

type Rep GCMMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GCMMessage

type Rep GCMMessage = D1 ('MetaData "GCMMessage" "Amazonka.Pinpoint.Types.GCMMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GCMMessage'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "substitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "silentPush") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "imageIconUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "rawContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "restrictedPackageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "smallImageIconUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "timeToLive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Action)) :*: S1 ('MetaSel ('Just "collapseKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "imageUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iconReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newGCMMessage :: GCMMessage Source #

Create a value of GCMMessage 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:substitutions:GCMMessage', gCMMessage_substitutions - The default message variables to use in the notification message. You can override the default variables with individual address variables.

$sel:silentPush:GCMMessage', gCMMessage_silentPush - Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

$sel:imageIconUrl:GCMMessage', gCMMessage_imageIconUrl - The URL of the large icon image to display in the content view of the push notification.

$sel:priority:GCMMessage', gCMMessage_priority - para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.

/listitem>

high - The notification is sent immediately and might wake a sleeping device.

/para>

Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.

The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.

$sel:rawContent:GCMMessage', gCMMessage_rawContent - The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

$sel:data':GCMMessage', gCMMessage_data - The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

$sel:restrictedPackageName:GCMMessage', gCMMessage_restrictedPackageName - The package name of the application where registration tokens must match in order for the recipient to receive the message.

$sel:smallImageIconUrl:GCMMessage', gCMMessage_smallImageIconUrl - The URL of the small icon image to display in the status bar and the content view of the push notification.

$sel:body:GCMMessage', gCMMessage_body - The body of the notification message.

$sel:timeToLive:GCMMessage', gCMMessage_timeToLive - The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).

Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.

$sel:url:GCMMessage', gCMMessage_url - The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

$sel:sound:GCMMessage', gCMMessage_sound - The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

$sel:action:GCMMessage', gCMMessage_action - The action to occur if the recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

$sel:collapseKey:GCMMessage', gCMMessage_collapseKey - An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.

Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.

$sel:imageUrl:GCMMessage', gCMMessage_imageUrl - The URL of an image to display in the push notification.

$sel:title:GCMMessage', gCMMessage_title - The title to display above the notification message on the recipient's device.

$sel:iconReference:GCMMessage', gCMMessage_iconReference - The icon image name of the asset saved in your app.

gCMMessage_substitutions :: Lens' GCMMessage (Maybe (HashMap Text [Text])) Source #

The default message variables to use in the notification message. You can override the default variables with individual address variables.

gCMMessage_silentPush :: Lens' GCMMessage (Maybe Bool) Source #

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

gCMMessage_imageIconUrl :: Lens' GCMMessage (Maybe Text) Source #

The URL of the large icon image to display in the content view of the push notification.

gCMMessage_priority :: Lens' GCMMessage (Maybe Text) Source #

para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.

/listitem>

high - The notification is sent immediately and might wake a sleeping device.

/para>

Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.

The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.

gCMMessage_rawContent :: Lens' GCMMessage (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

gCMMessage_data :: Lens' GCMMessage (Maybe (HashMap Text Text)) Source #

The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

gCMMessage_restrictedPackageName :: Lens' GCMMessage (Maybe Text) Source #

The package name of the application where registration tokens must match in order for the recipient to receive the message.

gCMMessage_smallImageIconUrl :: Lens' GCMMessage (Maybe Text) Source #

The URL of the small icon image to display in the status bar and the content view of the push notification.

gCMMessage_body :: Lens' GCMMessage (Maybe Text) Source #

The body of the notification message.

gCMMessage_timeToLive :: Lens' GCMMessage (Maybe Int) Source #

The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).

Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.

gCMMessage_url :: Lens' GCMMessage (Maybe Text) Source #

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

gCMMessage_sound :: Lens' GCMMessage (Maybe Text) Source #

The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

gCMMessage_action :: Lens' GCMMessage (Maybe Action) Source #

The action to occur if the recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

gCMMessage_collapseKey :: Lens' GCMMessage (Maybe Text) Source #

An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.

Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.

gCMMessage_imageUrl :: Lens' GCMMessage (Maybe Text) Source #

The URL of an image to display in the push notification.

gCMMessage_title :: Lens' GCMMessage (Maybe Text) Source #

The title to display above the notification message on the recipient's device.

gCMMessage_iconReference :: Lens' GCMMessage (Maybe Text) Source #

The icon image name of the asset saved in your app.

GPSCoordinates

data GPSCoordinates Source #

Specifies the GPS coordinates of a location.

See: newGPSCoordinates smart constructor.

Constructors

GPSCoordinates' 

Fields

Instances

Instances details
Eq GPSCoordinates Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSCoordinates

Read GPSCoordinates Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSCoordinates

Show GPSCoordinates Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSCoordinates

Generic GPSCoordinates Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSCoordinates

Associated Types

type Rep GPSCoordinates :: Type -> Type #

NFData GPSCoordinates Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSCoordinates

Methods

rnf :: GPSCoordinates -> () #

Hashable GPSCoordinates Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSCoordinates

ToJSON GPSCoordinates Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSCoordinates

FromJSON GPSCoordinates Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSCoordinates

type Rep GPSCoordinates Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSCoordinates

type Rep GPSCoordinates = D1 ('MetaData "GPSCoordinates" "Amazonka.Pinpoint.Types.GPSCoordinates" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GPSCoordinates'" 'PrefixI 'True) (S1 ('MetaSel ('Just "latitude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "longitude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)))

newGPSCoordinates Source #

Create a value of GPSCoordinates 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:latitude:GPSCoordinates', gPSCoordinates_latitude - The latitude coordinate of the location.

$sel:longitude:GPSCoordinates', gPSCoordinates_longitude - The longitude coordinate of the location.

gPSCoordinates_latitude :: Lens' GPSCoordinates Double Source #

The latitude coordinate of the location.

gPSCoordinates_longitude :: Lens' GPSCoordinates Double Source #

The longitude coordinate of the location.

GPSPointDimension

data GPSPointDimension Source #

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

See: newGPSPointDimension smart constructor.

Constructors

GPSPointDimension' 

Fields

Instances

Instances details
Eq GPSPointDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSPointDimension

Read GPSPointDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSPointDimension

Show GPSPointDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSPointDimension

Generic GPSPointDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSPointDimension

Associated Types

type Rep GPSPointDimension :: Type -> Type #

NFData GPSPointDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSPointDimension

Methods

rnf :: GPSPointDimension -> () #

Hashable GPSPointDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSPointDimension

ToJSON GPSPointDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSPointDimension

FromJSON GPSPointDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSPointDimension

type Rep GPSPointDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.GPSPointDimension

type Rep GPSPointDimension = D1 ('MetaData "GPSPointDimension" "Amazonka.Pinpoint.Types.GPSPointDimension" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GPSPointDimension'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rangeInKilometers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "coordinates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GPSCoordinates)))

newGPSPointDimension Source #

Create a value of GPSPointDimension 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:rangeInKilometers:GPSPointDimension', gPSPointDimension_rangeInKilometers - The range, in kilometers, from the GPS coordinates.

$sel:coordinates:GPSPointDimension', gPSPointDimension_coordinates - The GPS coordinates to measure distance from.

gPSPointDimension_rangeInKilometers :: Lens' GPSPointDimension (Maybe Double) Source #

The range, in kilometers, from the GPS coordinates.

gPSPointDimension_coordinates :: Lens' GPSPointDimension GPSCoordinates Source #

The GPS coordinates to measure distance from.

HoldoutActivity

data HoldoutActivity Source #

Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants.

See: newHoldoutActivity smart constructor.

Constructors

HoldoutActivity' 

Fields

  • nextActivity :: Maybe Text

    The unique identifier for the next activity to perform, after performing the holdout activity.

  • percentage :: Int

    The percentage of participants who shouldn't continue the journey.

    To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.

Instances

Instances details
Eq HoldoutActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.HoldoutActivity

Read HoldoutActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.HoldoutActivity

Show HoldoutActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.HoldoutActivity

Generic HoldoutActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.HoldoutActivity

Associated Types

type Rep HoldoutActivity :: Type -> Type #

NFData HoldoutActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.HoldoutActivity

Methods

rnf :: HoldoutActivity -> () #

Hashable HoldoutActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.HoldoutActivity

ToJSON HoldoutActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.HoldoutActivity

FromJSON HoldoutActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.HoldoutActivity

type Rep HoldoutActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.HoldoutActivity

type Rep HoldoutActivity = D1 ('MetaData "HoldoutActivity" "Amazonka.Pinpoint.Types.HoldoutActivity" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "HoldoutActivity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "percentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newHoldoutActivity Source #

Create a value of HoldoutActivity 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:nextActivity:HoldoutActivity', holdoutActivity_nextActivity - The unique identifier for the next activity to perform, after performing the holdout activity.

$sel:percentage:HoldoutActivity', holdoutActivity_percentage - The percentage of participants who shouldn't continue the journey.

To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.

holdoutActivity_nextActivity :: Lens' HoldoutActivity (Maybe Text) Source #

The unique identifier for the next activity to perform, after performing the holdout activity.

holdoutActivity_percentage :: Lens' HoldoutActivity Int Source #

The percentage of participants who shouldn't continue the journey.

To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.

ImportJobRequest

data ImportJobRequest Source #

Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.

See: newImportJobRequest smart constructor.

Constructors

ImportJobRequest' 

Fields

  • segmentName :: Maybe Text

    A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

  • defineSegment :: Maybe Bool

    Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.

  • registerEndpoints :: Maybe Bool

    Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

  • externalId :: Maybe Text

    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

  • segmentId :: Maybe Text

    The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.

  • format :: DefinitionFormat

    The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

  • s3Url :: Text

    The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

    The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

  • roleArn :: Text

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

Instances

Instances details
Eq ImportJobRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobRequest

Read ImportJobRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobRequest

Show ImportJobRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobRequest

Generic ImportJobRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobRequest

Associated Types

type Rep ImportJobRequest :: Type -> Type #

NFData ImportJobRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobRequest

Methods

rnf :: ImportJobRequest -> () #

Hashable ImportJobRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobRequest

ToJSON ImportJobRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobRequest

type Rep ImportJobRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobRequest

newImportJobRequest Source #

Create a value of ImportJobRequest 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:segmentName:ImportJobRequest', importJobRequest_segmentName - A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

$sel:defineSegment:ImportJobRequest', importJobRequest_defineSegment - Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.

$sel:registerEndpoints:ImportJobRequest', importJobRequest_registerEndpoints - Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

$sel:externalId:ImportJobRequest', importJobRequest_externalId - (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

$sel:segmentId:ImportJobRequest', importJobRequest_segmentId - The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.

$sel:format:ImportJobRequest', importJobRequest_format - The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

$sel:s3Url:ImportJobRequest', importJobRequest_s3Url - The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

$sel:roleArn:ImportJobRequest', importJobRequest_roleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

importJobRequest_segmentName :: Lens' ImportJobRequest (Maybe Text) Source #

A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

importJobRequest_defineSegment :: Lens' ImportJobRequest (Maybe Bool) Source #

Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.

importJobRequest_registerEndpoints :: Lens' ImportJobRequest (Maybe Bool) Source #

Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

importJobRequest_externalId :: Lens' ImportJobRequest (Maybe Text) Source #

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

importJobRequest_segmentId :: Lens' ImportJobRequest (Maybe Text) Source #

The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.

importJobRequest_format :: Lens' ImportJobRequest DefinitionFormat Source #

The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

importJobRequest_s3Url :: Lens' ImportJobRequest Text Source #

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

importJobRequest_roleArn :: Lens' ImportJobRequest Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

ImportJobResource

data ImportJobResource Source #

Provides information about the resource settings for a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.

See: newImportJobResource smart constructor.

Constructors

ImportJobResource' 

Fields

  • segmentName :: Maybe Text

    The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

  • defineSegment :: Maybe Bool

    Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.

  • registerEndpoints :: Maybe Bool

    Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

  • externalId :: Maybe Text

    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

  • segmentId :: Maybe Text

    The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.

  • format :: DefinitionFormat

    The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

    If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

  • s3Url :: Text

    The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

    The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

  • roleArn :: Text

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

Instances

Instances details
Eq ImportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResource

Read ImportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResource

Show ImportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResource

Generic ImportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResource

Associated Types

type Rep ImportJobResource :: Type -> Type #

NFData ImportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResource

Methods

rnf :: ImportJobResource -> () #

Hashable ImportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResource

FromJSON ImportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResource

type Rep ImportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResource

newImportJobResource Source #

Create a value of ImportJobResource 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:segmentName:ImportJobResource', importJobResource_segmentName - The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

$sel:defineSegment:ImportJobResource', importJobResource_defineSegment - Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.

$sel:registerEndpoints:ImportJobResource', importJobResource_registerEndpoints - Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

$sel:externalId:ImportJobResource', importJobResource_externalId - (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

$sel:segmentId:ImportJobResource', importJobResource_segmentId - The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.

$sel:format:ImportJobResource', importJobResource_format - The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

$sel:s3Url:ImportJobResource', importJobResource_s3Url - The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

$sel:roleArn:ImportJobResource', importJobResource_roleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

importJobResource_segmentName :: Lens' ImportJobResource (Maybe Text) Source #

The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

importJobResource_defineSegment :: Lens' ImportJobResource (Maybe Bool) Source #

Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.

importJobResource_registerEndpoints :: Lens' ImportJobResource (Maybe Bool) Source #

Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

importJobResource_externalId :: Lens' ImportJobResource (Maybe Text) Source #

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

importJobResource_segmentId :: Lens' ImportJobResource (Maybe Text) Source #

The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.

importJobResource_format :: Lens' ImportJobResource DefinitionFormat Source #

The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

importJobResource_s3Url :: Lens' ImportJobResource Text Source #

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

importJobResource_roleArn :: Lens' ImportJobResource Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

ImportJobResponse

data ImportJobResponse Source #

Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.

See: newImportJobResponse smart constructor.

Constructors

ImportJobResponse' 

Fields

  • completedPieces :: Maybe Int

    The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.

  • failedPieces :: Maybe Int

    The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.

  • totalProcessed :: Maybe Int

    The total number of endpoint definitions that were processed by the import job.

  • failures :: Maybe [Text]

    An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.

  • totalPieces :: Maybe Int

    The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.

  • completionDate :: Maybe Text

    The date, in ISO 8601 format, when the import job was completed.

  • totalFailures :: Maybe Int

    The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.

  • jobStatus :: JobStatus

    The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

  • creationDate :: Text

    The date, in ISO 8601 format, when the import job was created.

  • type' :: Text

    The job type. This value is IMPORT for import jobs.

  • definition :: ImportJobResource

    The resource settings that apply to the import job.

  • id :: Text

    The unique identifier for the import job.

  • applicationId :: Text

    The unique identifier for the application that's associated with the import job.

Instances

Instances details
Eq ImportJobResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResponse

Read ImportJobResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResponse

Show ImportJobResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResponse

Generic ImportJobResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResponse

Associated Types

type Rep ImportJobResponse :: Type -> Type #

NFData ImportJobResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResponse

Methods

rnf :: ImportJobResponse -> () #

Hashable ImportJobResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResponse

FromJSON ImportJobResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResponse

type Rep ImportJobResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResponse

type Rep ImportJobResponse = D1 ('MetaData "ImportJobResponse" "Amazonka.Pinpoint.Types.ImportJobResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ImportJobResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "completedPieces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "failedPieces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "totalProcessed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "failures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "totalPieces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "completionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "totalFailures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobStatus) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "definition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ImportJobResource)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newImportJobResponse Source #

Create a value of ImportJobResponse 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:completedPieces:ImportJobResponse', importJobResponse_completedPieces - The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.

$sel:failedPieces:ImportJobResponse', importJobResponse_failedPieces - The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.

$sel:totalProcessed:ImportJobResponse', importJobResponse_totalProcessed - The total number of endpoint definitions that were processed by the import job.

$sel:failures:ImportJobResponse', importJobResponse_failures - An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.

$sel:totalPieces:ImportJobResponse', importJobResponse_totalPieces - The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.

$sel:completionDate:ImportJobResponse', importJobResponse_completionDate - The date, in ISO 8601 format, when the import job was completed.

$sel:totalFailures:ImportJobResponse', importJobResponse_totalFailures - The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.

$sel:jobStatus:ImportJobResponse', importJobResponse_jobStatus - The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

$sel:creationDate:ImportJobResponse', importJobResponse_creationDate - The date, in ISO 8601 format, when the import job was created.

$sel:type':ImportJobResponse', importJobResponse_type - The job type. This value is IMPORT for import jobs.

$sel:definition:ImportJobResponse', importJobResponse_definition - The resource settings that apply to the import job.

$sel:id:ImportJobResponse', importJobResponse_id - The unique identifier for the import job.

$sel:applicationId:ImportJobResponse', importJobResponse_applicationId - The unique identifier for the application that's associated with the import job.

importJobResponse_completedPieces :: Lens' ImportJobResponse (Maybe Int) Source #

The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.

importJobResponse_failedPieces :: Lens' ImportJobResponse (Maybe Int) Source #

The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.

importJobResponse_totalProcessed :: Lens' ImportJobResponse (Maybe Int) Source #

The total number of endpoint definitions that were processed by the import job.

importJobResponse_failures :: Lens' ImportJobResponse (Maybe [Text]) Source #

An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.

importJobResponse_totalPieces :: Lens' ImportJobResponse (Maybe Int) Source #

The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.

importJobResponse_completionDate :: Lens' ImportJobResponse (Maybe Text) Source #

The date, in ISO 8601 format, when the import job was completed.

importJobResponse_totalFailures :: Lens' ImportJobResponse (Maybe Int) Source #

The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.

importJobResponse_jobStatus :: Lens' ImportJobResponse JobStatus Source #

The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

importJobResponse_creationDate :: Lens' ImportJobResponse Text Source #

The date, in ISO 8601 format, when the import job was created.

importJobResponse_type :: Lens' ImportJobResponse Text Source #

The job type. This value is IMPORT for import jobs.

importJobResponse_definition :: Lens' ImportJobResponse ImportJobResource Source #

The resource settings that apply to the import job.

importJobResponse_id :: Lens' ImportJobResponse Text Source #

The unique identifier for the import job.

importJobResponse_applicationId :: Lens' ImportJobResponse Text Source #

The unique identifier for the application that's associated with the import job.

ImportJobsResponse

data ImportJobsResponse Source #

Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.

See: newImportJobsResponse smart constructor.

Constructors

ImportJobsResponse' 

Fields

  • nextToken :: Maybe Text

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

  • item :: [ImportJobResponse]

    An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).

Instances

Instances details
Eq ImportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobsResponse

Read ImportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobsResponse

Show ImportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobsResponse

Generic ImportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobsResponse

Associated Types

type Rep ImportJobsResponse :: Type -> Type #

NFData ImportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobsResponse

Methods

rnf :: ImportJobsResponse -> () #

Hashable ImportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobsResponse

FromJSON ImportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobsResponse

type Rep ImportJobsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobsResponse

type Rep ImportJobsResponse = D1 ('MetaData "ImportJobsResponse" "Amazonka.Pinpoint.Types.ImportJobsResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ImportJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ImportJobResponse])))

newImportJobsResponse :: ImportJobsResponse Source #

Create a value of ImportJobsResponse 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:nextToken:ImportJobsResponse', importJobsResponse_nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

$sel:item:ImportJobsResponse', importJobsResponse_item - An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).

importJobsResponse_nextToken :: Lens' ImportJobsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

importJobsResponse_item :: Lens' ImportJobsResponse [ImportJobResponse] Source #

An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).

InAppCampaignSchedule

data InAppCampaignSchedule Source #

Schedule of the campaign.

See: newInAppCampaignSchedule smart constructor.

Constructors

InAppCampaignSchedule' 

Fields

Instances

Instances details
Eq InAppCampaignSchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppCampaignSchedule

Read InAppCampaignSchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppCampaignSchedule

Show InAppCampaignSchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppCampaignSchedule

Generic InAppCampaignSchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppCampaignSchedule

Associated Types

type Rep InAppCampaignSchedule :: Type -> Type #

NFData InAppCampaignSchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppCampaignSchedule

Methods

rnf :: InAppCampaignSchedule -> () #

Hashable InAppCampaignSchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppCampaignSchedule

FromJSON InAppCampaignSchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppCampaignSchedule

type Rep InAppCampaignSchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppCampaignSchedule

type Rep InAppCampaignSchedule = D1 ('MetaData "InAppCampaignSchedule" "Amazonka.Pinpoint.Types.InAppCampaignSchedule" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "InAppCampaignSchedule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "quietTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuietTime)) :*: S1 ('MetaSel ('Just "eventFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignEventFilter)))))

newInAppCampaignSchedule :: InAppCampaignSchedule Source #

Create a value of InAppCampaignSchedule 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:endDate:InAppCampaignSchedule', inAppCampaignSchedule_endDate - The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.

$sel:quietTime:InAppCampaignSchedule', inAppCampaignSchedule_quietTime - Time during which the in-app message should not be shown to the user.

$sel:eventFilter:InAppCampaignSchedule', inAppCampaignSchedule_eventFilter - The event filter the SDK has to use to show the in-app message in the application.

inAppCampaignSchedule_endDate :: Lens' InAppCampaignSchedule (Maybe Text) Source #

The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.

inAppCampaignSchedule_quietTime :: Lens' InAppCampaignSchedule (Maybe QuietTime) Source #

Time during which the in-app message should not be shown to the user.

inAppCampaignSchedule_eventFilter :: Lens' InAppCampaignSchedule (Maybe CampaignEventFilter) Source #

The event filter the SDK has to use to show the in-app message in the application.

InAppMessage

data InAppMessage Source #

Provides all fields required for building an in-app message.

See: newInAppMessage smart constructor.

Constructors

InAppMessage' 

Fields

Instances

Instances details
Eq InAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessage

Read InAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessage

Show InAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessage

Generic InAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessage

Associated Types

type Rep InAppMessage :: Type -> Type #

NFData InAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessage

Methods

rnf :: InAppMessage -> () #

Hashable InAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessage

FromJSON InAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessage

type Rep InAppMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessage

type Rep InAppMessage = D1 ('MetaData "InAppMessage" "Amazonka.Pinpoint.Types.InAppMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "InAppMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "layout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Layout)) :*: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InAppMessageContent])) :*: S1 ('MetaSel ('Just "customConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))

newInAppMessage :: InAppMessage Source #

Create a value of InAppMessage 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:layout:InAppMessage', inAppMessage_layout - The layout of the message.

$sel:content:InAppMessage', inAppMessage_content - In-app message content.

$sel:customConfig:InAppMessage', inAppMessage_customConfig - Custom config to be sent to SDK.

inAppMessage_layout :: Lens' InAppMessage (Maybe Layout) Source #

The layout of the message.

inAppMessage_customConfig :: Lens' InAppMessage (Maybe (HashMap Text Text)) Source #

Custom config to be sent to SDK.

InAppMessageBodyConfig

data InAppMessageBodyConfig Source #

Text config for Message Body.

See: newInAppMessageBodyConfig smart constructor.

Constructors

InAppMessageBodyConfig' 

Fields

Instances

Instances details
Eq InAppMessageBodyConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageBodyConfig

Read InAppMessageBodyConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageBodyConfig

Show InAppMessageBodyConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageBodyConfig

Generic InAppMessageBodyConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageBodyConfig

Associated Types

type Rep InAppMessageBodyConfig :: Type -> Type #

NFData InAppMessageBodyConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageBodyConfig

Methods

rnf :: InAppMessageBodyConfig -> () #

Hashable InAppMessageBodyConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageBodyConfig

ToJSON InAppMessageBodyConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageBodyConfig

FromJSON InAppMessageBodyConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageBodyConfig

type Rep InAppMessageBodyConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageBodyConfig

type Rep InAppMessageBodyConfig = D1 ('MetaData "InAppMessageBodyConfig" "Amazonka.Pinpoint.Types.InAppMessageBodyConfig" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "InAppMessageBodyConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alignment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Alignment) :*: (S1 ('MetaSel ('Just "textColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newInAppMessageBodyConfig Source #

Create a value of InAppMessageBodyConfig 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:alignment:InAppMessageBodyConfig', inAppMessageBodyConfig_alignment - The alignment of the text. Valid values: LEFT, CENTER, RIGHT.

$sel:textColor:InAppMessageBodyConfig', inAppMessageBodyConfig_textColor - The text color.

$sel:body:InAppMessageBodyConfig', inAppMessageBodyConfig_body - Message Body.

inAppMessageBodyConfig_alignment :: Lens' InAppMessageBodyConfig Alignment Source #

The alignment of the text. Valid values: LEFT, CENTER, RIGHT.

InAppMessageButton

data InAppMessageButton Source #

Button Config for an in-app message.

See: newInAppMessageButton smart constructor.

Constructors

InAppMessageButton' 

Fields

Instances

Instances details
Eq InAppMessageButton Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageButton

Read InAppMessageButton Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageButton

Show InAppMessageButton Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageButton

Generic InAppMessageButton Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageButton

Associated Types

type Rep InAppMessageButton :: Type -> Type #

NFData InAppMessageButton Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageButton

Methods

rnf :: InAppMessageButton -> () #

Hashable InAppMessageButton Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageButton

ToJSON InAppMessageButton Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageButton

FromJSON InAppMessageButton Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageButton

type Rep InAppMessageButton Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageButton

newInAppMessageButton :: InAppMessageButton Source #

Create a value of InAppMessageButton 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:ios:InAppMessageButton', inAppMessageButton_ios - Default button content.

$sel:defaultConfig:InAppMessageButton', inAppMessageButton_defaultConfig - Default button content.

$sel:web:InAppMessageButton', inAppMessageButton_web - Default button content.

$sel:android:InAppMessageButton', inAppMessageButton_android - Default button content.

InAppMessageCampaign

data InAppMessageCampaign Source #

Targeted in-app message campaign.

See: newInAppMessageCampaign smart constructor.

Constructors

InAppMessageCampaign' 

Fields

Instances

Instances details
Eq InAppMessageCampaign Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageCampaign

Read InAppMessageCampaign Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageCampaign

Show InAppMessageCampaign Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageCampaign

Generic InAppMessageCampaign Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageCampaign

Associated Types

type Rep InAppMessageCampaign :: Type -> Type #

NFData InAppMessageCampaign Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageCampaign

Methods

rnf :: InAppMessageCampaign -> () #

Hashable InAppMessageCampaign Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageCampaign

FromJSON InAppMessageCampaign Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageCampaign

type Rep InAppMessageCampaign Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageCampaign

newInAppMessageCampaign :: InAppMessageCampaign Source #

Create a value of InAppMessageCampaign 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:sessionCap:InAppMessageCampaign', inAppMessageCampaign_sessionCap - Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.

$sel:priority:InAppMessageCampaign', inAppMessageCampaign_priority - Priority of the in-app message.

$sel:schedule:InAppMessageCampaign', inAppMessageCampaign_schedule - Schedule of the campaign.

$sel:campaignId:InAppMessageCampaign', inAppMessageCampaign_campaignId - Campaign id of the corresponding campaign.

$sel:treatmentId:InAppMessageCampaign', inAppMessageCampaign_treatmentId - Treatment id of the campaign.

$sel:inAppMessage:InAppMessageCampaign', inAppMessageCampaign_inAppMessage - In-app message content with all fields required for rendering an in-app message.

$sel:totalCap:InAppMessageCampaign', inAppMessageCampaign_totalCap - Total cap which controls the number of times an in-app message can be shown to the endpoint.

$sel:dailyCap:InAppMessageCampaign', inAppMessageCampaign_dailyCap - Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.

inAppMessageCampaign_sessionCap :: Lens' InAppMessageCampaign (Maybe Int) Source #

Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.

inAppMessageCampaign_campaignId :: Lens' InAppMessageCampaign (Maybe Text) Source #

Campaign id of the corresponding campaign.

inAppMessageCampaign_inAppMessage :: Lens' InAppMessageCampaign (Maybe InAppMessage) Source #

In-app message content with all fields required for rendering an in-app message.

inAppMessageCampaign_totalCap :: Lens' InAppMessageCampaign (Maybe Int) Source #

Total cap which controls the number of times an in-app message can be shown to the endpoint.

inAppMessageCampaign_dailyCap :: Lens' InAppMessageCampaign (Maybe Int) Source #

Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.

InAppMessageContent

data InAppMessageContent Source #

The configuration for the message content.

See: newInAppMessageContent smart constructor.

Constructors

InAppMessageContent' 

Fields

Instances

Instances details
Eq InAppMessageContent Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageContent

Read InAppMessageContent Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageContent

Show InAppMessageContent Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageContent

Generic InAppMessageContent Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageContent

Associated Types

type Rep InAppMessageContent :: Type -> Type #

NFData InAppMessageContent Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageContent

Methods

rnf :: InAppMessageContent -> () #

Hashable InAppMessageContent Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageContent

ToJSON InAppMessageContent Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageContent

FromJSON InAppMessageContent Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageContent

type Rep InAppMessageContent Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageContent

type Rep InAppMessageContent = D1 ('MetaData "InAppMessageContent" "Amazonka.Pinpoint.Types.InAppMessageContent" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "InAppMessageContent'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "primaryBtn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InAppMessageButton)) :*: (S1 ('MetaSel ('Just "bodyConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InAppMessageBodyConfig)) :*: S1 ('MetaSel ('Just "backgroundColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "imageUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "secondaryBtn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InAppMessageButton)) :*: S1 ('MetaSel ('Just "headerConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InAppMessageHeaderConfig))))))

newInAppMessageContent :: InAppMessageContent Source #

Create a value of InAppMessageContent 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:primaryBtn:InAppMessageContent', inAppMessageContent_primaryBtn - The first button inside the message.

$sel:bodyConfig:InAppMessageContent', inAppMessageContent_bodyConfig - The configuration for the message body.

$sel:backgroundColor:InAppMessageContent', inAppMessageContent_backgroundColor - The background color for the message.

$sel:imageUrl:InAppMessageContent', inAppMessageContent_imageUrl - The image url for the background of message.

$sel:secondaryBtn:InAppMessageContent', inAppMessageContent_secondaryBtn - The second button inside message.

$sel:headerConfig:InAppMessageContent', inAppMessageContent_headerConfig - The configuration for the message header.

inAppMessageContent_imageUrl :: Lens' InAppMessageContent (Maybe Text) Source #

The image url for the background of message.

InAppMessageHeaderConfig

data InAppMessageHeaderConfig Source #

Text config for Message Header.

See: newInAppMessageHeaderConfig smart constructor.

Constructors

InAppMessageHeaderConfig' 

Fields

Instances

Instances details
Eq InAppMessageHeaderConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageHeaderConfig

Read InAppMessageHeaderConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageHeaderConfig

Show InAppMessageHeaderConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageHeaderConfig

Generic InAppMessageHeaderConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageHeaderConfig

Associated Types

type Rep InAppMessageHeaderConfig :: Type -> Type #

NFData InAppMessageHeaderConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageHeaderConfig

Hashable InAppMessageHeaderConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageHeaderConfig

ToJSON InAppMessageHeaderConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageHeaderConfig

FromJSON InAppMessageHeaderConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageHeaderConfig

type Rep InAppMessageHeaderConfig Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessageHeaderConfig

type Rep InAppMessageHeaderConfig = D1 ('MetaData "InAppMessageHeaderConfig" "Amazonka.Pinpoint.Types.InAppMessageHeaderConfig" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "InAppMessageHeaderConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alignment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Alignment) :*: (S1 ('MetaSel ('Just "header") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "textColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newInAppMessageHeaderConfig Source #

Create a value of InAppMessageHeaderConfig 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:alignment:InAppMessageHeaderConfig', inAppMessageHeaderConfig_alignment - The alignment of the text. Valid values: LEFT, CENTER, RIGHT.

$sel:header:InAppMessageHeaderConfig', inAppMessageHeaderConfig_header - Message Header.

$sel:textColor:InAppMessageHeaderConfig', inAppMessageHeaderConfig_textColor - The text color.

inAppMessageHeaderConfig_alignment :: Lens' InAppMessageHeaderConfig Alignment Source #

The alignment of the text. Valid values: LEFT, CENTER, RIGHT.

InAppMessagesResponse

data InAppMessagesResponse Source #

Get in-app messages response object.

See: newInAppMessagesResponse smart constructor.

Constructors

InAppMessagesResponse' 

Fields

Instances

Instances details
Eq InAppMessagesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessagesResponse

Read InAppMessagesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessagesResponse

Show InAppMessagesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessagesResponse

Generic InAppMessagesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessagesResponse

Associated Types

type Rep InAppMessagesResponse :: Type -> Type #

NFData InAppMessagesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessagesResponse

Methods

rnf :: InAppMessagesResponse -> () #

Hashable InAppMessagesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessagesResponse

FromJSON InAppMessagesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessagesResponse

type Rep InAppMessagesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppMessagesResponse

type Rep InAppMessagesResponse = D1 ('MetaData "InAppMessagesResponse" "Amazonka.Pinpoint.Types.InAppMessagesResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "InAppMessagesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "inAppMessageCampaigns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InAppMessageCampaign]))))

newInAppMessagesResponse :: InAppMessagesResponse Source #

Create a value of InAppMessagesResponse 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:inAppMessageCampaigns:InAppMessagesResponse', inAppMessagesResponse_inAppMessageCampaigns - List of targeted in-app message campaigns.

InAppTemplateRequest

data InAppTemplateRequest Source #

InApp Template Request.

See: newInAppTemplateRequest smart constructor.

Constructors

InAppTemplateRequest' 

Fields

Instances

Instances details
Eq InAppTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppTemplateRequest

Read InAppTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppTemplateRequest

Show InAppTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppTemplateRequest

Generic InAppTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppTemplateRequest

Associated Types

type Rep InAppTemplateRequest :: Type -> Type #

NFData InAppTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppTemplateRequest

Methods

rnf :: InAppTemplateRequest -> () #

Hashable InAppTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppTemplateRequest

ToJSON InAppTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppTemplateRequest

type Rep InAppTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppTemplateRequest

type Rep InAppTemplateRequest = D1 ('MetaData "InAppTemplateRequest" "Amazonka.Pinpoint.Types.InAppTemplateRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "InAppTemplateRequest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "layout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Layout)) :*: S1 ('MetaSel ('Just "templateDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InAppMessageContent])) :*: (S1 ('MetaSel ('Just "customConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))

newInAppTemplateRequest :: InAppTemplateRequest Source #

Create a value of InAppTemplateRequest 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:layout:InAppTemplateRequest', inAppTemplateRequest_layout - The layout of the message.

$sel:templateDescription:InAppTemplateRequest', inAppTemplateRequest_templateDescription - The description of the template.

$sel:content:InAppTemplateRequest', inAppTemplateRequest_content - The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.

$sel:customConfig:InAppTemplateRequest', inAppTemplateRequest_customConfig - Custom config to be sent to client.

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

inAppTemplateRequest_content :: Lens' InAppTemplateRequest (Maybe [InAppMessageContent]) Source #

The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.

inAppTemplateRequest_tags :: Lens' InAppTemplateRequest (Maybe (HashMap Text Text)) Source #

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

InAppTemplateResponse

data InAppTemplateResponse Source #

In-App Template Response.

See: newInAppTemplateResponse smart constructor.

Constructors

InAppTemplateResponse' 

Fields

Instances

Instances details
Eq InAppTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppTemplateResponse

Read InAppTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppTemplateResponse

Show InAppTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppTemplateResponse

Generic InAppTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppTemplateResponse

Associated Types

type Rep InAppTemplateResponse :: Type -> Type #

NFData InAppTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppTemplateResponse

Methods

rnf :: InAppTemplateResponse -> () #

Hashable InAppTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppTemplateResponse

FromJSON InAppTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppTemplateResponse

type Rep InAppTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.InAppTemplateResponse

type Rep InAppTemplateResponse = D1 ('MetaData "InAppTemplateResponse" "Amazonka.Pinpoint.Types.InAppTemplateResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "InAppTemplateResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "layout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Layout)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "templateDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InAppMessageContent])) :*: S1 ('MetaSel ('Just "customConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))) :*: ((S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "templateType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TemplateType))))))

newInAppTemplateResponse Source #

Create a value of InAppTemplateResponse 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:layout:InAppTemplateResponse', inAppTemplateResponse_layout - The layout of the message.

$sel:arn:InAppTemplateResponse', inAppTemplateResponse_arn - The resource arn of the template.

$sel:templateDescription:InAppTemplateResponse', inAppTemplateResponse_templateDescription - The description of the template.

$sel:content:InAppTemplateResponse', inAppTemplateResponse_content - The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.

$sel:customConfig:InAppTemplateResponse', inAppTemplateResponse_customConfig - Custom config to be sent to client.

$sel:version:InAppTemplateResponse', inAppTemplateResponse_version - The version id of the template.

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

$sel:lastModifiedDate:InAppTemplateResponse', inAppTemplateResponse_lastModifiedDate - The last modified date of the template.

$sel:creationDate:InAppTemplateResponse', inAppTemplateResponse_creationDate - The creation date of the template.

$sel:templateName:InAppTemplateResponse', inAppTemplateResponse_templateName - The name of the template.

$sel:templateType:InAppTemplateResponse', inAppTemplateResponse_templateType - The type of the template.

inAppTemplateResponse_content :: Lens' InAppTemplateResponse (Maybe [InAppMessageContent]) Source #

The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.

inAppTemplateResponse_tags :: Lens' InAppTemplateResponse (Maybe (HashMap Text Text)) Source #

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

ItemResponse

data ItemResponse Source #

Provides information about the results of a request to create or update an endpoint that's associated with an event.

See: newItemResponse smart constructor.

Constructors

ItemResponse' 

Fields

Instances

Instances details
Eq ItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ItemResponse

Read ItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ItemResponse

Show ItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ItemResponse

Generic ItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ItemResponse

Associated Types

type Rep ItemResponse :: Type -> Type #

NFData ItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ItemResponse

Methods

rnf :: ItemResponse -> () #

Hashable ItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ItemResponse

FromJSON ItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ItemResponse

type Rep ItemResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ItemResponse

type Rep ItemResponse = D1 ('MetaData "ItemResponse" "Amazonka.Pinpoint.Types.ItemResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ItemResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointItemResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointItemResponse)) :*: S1 ('MetaSel ('Just "eventsItemResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text EventItemResponse)))))

newItemResponse :: ItemResponse Source #

Create a value of ItemResponse 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:endpointItemResponse:ItemResponse', itemResponse_endpointItemResponse - The response that was received after the endpoint data was accepted.

$sel:eventsItemResponse:ItemResponse', itemResponse_eventsItemResponse - A multipart response object that contains a key and a value for each event in the request. In each object, the event ID is the key and an EventItemResponse object is the value.

itemResponse_endpointItemResponse :: Lens' ItemResponse (Maybe EndpointItemResponse) Source #

The response that was received after the endpoint data was accepted.

itemResponse_eventsItemResponse :: Lens' ItemResponse (Maybe (HashMap Text EventItemResponse)) Source #

A multipart response object that contains a key and a value for each event in the request. In each object, the event ID is the key and an EventItemResponse object is the value.

JourneyChannelSettings

data JourneyChannelSettings Source #

The channel-specific configurations for the journey.

See: newJourneyChannelSettings smart constructor.

Constructors

JourneyChannelSettings' 

Fields

Instances

Instances details
Eq JourneyChannelSettings Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyChannelSettings

Read JourneyChannelSettings Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyChannelSettings

Show JourneyChannelSettings Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyChannelSettings

Generic JourneyChannelSettings Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyChannelSettings

Associated Types

type Rep JourneyChannelSettings :: Type -> Type #

NFData JourneyChannelSettings Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyChannelSettings

Methods

rnf :: JourneyChannelSettings -> () #

Hashable JourneyChannelSettings Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyChannelSettings

FromJSON JourneyChannelSettings Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyChannelSettings

type Rep JourneyChannelSettings Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyChannelSettings

type Rep JourneyChannelSettings = D1 ('MetaData "JourneyChannelSettings" "Amazonka.Pinpoint.Types.JourneyChannelSettings" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "JourneyChannelSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectCampaignArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "connectCampaignExecutionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newJourneyChannelSettings :: JourneyChannelSettings Source #

Create a value of JourneyChannelSettings 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:connectCampaignArn:JourneyChannelSettings', journeyChannelSettings_connectCampaignArn - Amazon Resource Name (ARN) of the Connect Campaign.

$sel:connectCampaignExecutionRoleArn:JourneyChannelSettings', journeyChannelSettings_connectCampaignExecutionRoleArn - IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.

journeyChannelSettings_connectCampaignArn :: Lens' JourneyChannelSettings (Maybe Text) Source #

Amazon Resource Name (ARN) of the Connect Campaign.

journeyChannelSettings_connectCampaignExecutionRoleArn :: Lens' JourneyChannelSettings (Maybe Text) Source #

IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.

JourneyCustomMessage

data JourneyCustomMessage Source #

Specifies the message content for a custom channel message that's sent to participants in a journey.

See: newJourneyCustomMessage smart constructor.

Constructors

JourneyCustomMessage' 

Fields

  • data' :: Maybe Text

    The message content that's passed to an AWS Lambda function or to a web hook.

Instances

Instances details
Eq JourneyCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyCustomMessage

Read JourneyCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyCustomMessage

Show JourneyCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyCustomMessage

Generic JourneyCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyCustomMessage

Associated Types

type Rep JourneyCustomMessage :: Type -> Type #

NFData JourneyCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyCustomMessage

Methods

rnf :: JourneyCustomMessage -> () #

Hashable JourneyCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyCustomMessage

ToJSON JourneyCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyCustomMessage

FromJSON JourneyCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyCustomMessage

type Rep JourneyCustomMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyCustomMessage

type Rep JourneyCustomMessage = D1 ('MetaData "JourneyCustomMessage" "Amazonka.Pinpoint.Types.JourneyCustomMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "JourneyCustomMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newJourneyCustomMessage :: JourneyCustomMessage Source #

Create a value of JourneyCustomMessage 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:data':JourneyCustomMessage', journeyCustomMessage_data - The message content that's passed to an AWS Lambda function or to a web hook.

journeyCustomMessage_data :: Lens' JourneyCustomMessage (Maybe Text) Source #

The message content that's passed to an AWS Lambda function or to a web hook.

JourneyDateRangeKpiResponse

data JourneyDateRangeKpiResponse Source #

Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query.

See: newJourneyDateRangeKpiResponse smart constructor.

Constructors

JourneyDateRangeKpiResponse' 

Fields

  • nextToken :: Maybe Text

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.

  • kpiResult :: BaseKpiResult

    An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

  • kpiName :: Text

    The name of the metric, also referred to as a /key performance indicator (KPI)/, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

  • journeyId :: Text

    The unique identifier for the journey that the metric applies to.

  • endTime :: POSIX

    The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

  • startTime :: POSIX

    The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

  • applicationId :: Text

    The unique identifier for the application that the metric applies to.

Instances

Instances details
Eq JourneyDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

Read JourneyDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

Show JourneyDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

Generic JourneyDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

Associated Types

type Rep JourneyDateRangeKpiResponse :: Type -> Type #

NFData JourneyDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

Hashable JourneyDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

FromJSON JourneyDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

type Rep JourneyDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

type Rep JourneyDateRangeKpiResponse = D1 ('MetaData "JourneyDateRangeKpiResponse" "Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "JourneyDateRangeKpiResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "kpiResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BaseKpiResult) :*: S1 ('MetaSel ('Just "kpiName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "journeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newJourneyDateRangeKpiResponse Source #

Create a value of JourneyDateRangeKpiResponse 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:nextToken:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.

$sel:kpiResult:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_kpiResult - An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

$sel:kpiName:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_kpiName - The name of the metric, also referred to as a /key performance indicator (KPI)/, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

$sel:journeyId:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_journeyId - The unique identifier for the journey that the metric applies to.

$sel:endTime:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_endTime - The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

$sel:startTime:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_startTime - The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

$sel:applicationId:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_applicationId - The unique identifier for the application that the metric applies to.

journeyDateRangeKpiResponse_nextToken :: Lens' JourneyDateRangeKpiResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.

journeyDateRangeKpiResponse_kpiResult :: Lens' JourneyDateRangeKpiResponse BaseKpiResult Source #

An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

journeyDateRangeKpiResponse_kpiName :: Lens' JourneyDateRangeKpiResponse Text Source #

The name of the metric, also referred to as a /key performance indicator (KPI)/, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

journeyDateRangeKpiResponse_journeyId :: Lens' JourneyDateRangeKpiResponse Text Source #

The unique identifier for the journey that the metric applies to.

journeyDateRangeKpiResponse_endTime :: Lens' JourneyDateRangeKpiResponse UTCTime Source #

The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

journeyDateRangeKpiResponse_startTime :: Lens' JourneyDateRangeKpiResponse UTCTime Source #

The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

journeyDateRangeKpiResponse_applicationId :: Lens' JourneyDateRangeKpiResponse Text Source #

The unique identifier for the application that the metric applies to.

JourneyEmailMessage

data JourneyEmailMessage Source #

Specifies the "From" address for an email message that's sent to participants in a journey.

See: newJourneyEmailMessage smart constructor.

Constructors

JourneyEmailMessage' 

Fields

  • fromAddress :: Maybe Text

    The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.

Instances

Instances details
Eq JourneyEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyEmailMessage

Read JourneyEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyEmailMessage

Show JourneyEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyEmailMessage

Generic JourneyEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyEmailMessage

Associated Types

type Rep JourneyEmailMessage :: Type -> Type #

NFData JourneyEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyEmailMessage

Methods

rnf :: JourneyEmailMessage -> () #

Hashable JourneyEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyEmailMessage

ToJSON JourneyEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyEmailMessage

FromJSON JourneyEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyEmailMessage

type Rep JourneyEmailMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyEmailMessage

type Rep JourneyEmailMessage = D1 ('MetaData "JourneyEmailMessage" "Amazonka.Pinpoint.Types.JourneyEmailMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "JourneyEmailMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newJourneyEmailMessage :: JourneyEmailMessage Source #

Create a value of JourneyEmailMessage 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:fromAddress:JourneyEmailMessage', journeyEmailMessage_fromAddress - The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.

journeyEmailMessage_fromAddress :: Lens' JourneyEmailMessage (Maybe Text) Source #

The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.

JourneyExecutionActivityMetricsResponse

data JourneyExecutionActivityMetricsResponse Source #

Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.

See: newJourneyExecutionActivityMetricsResponse smart constructor.

Constructors

JourneyExecutionActivityMetricsResponse' 

Fields

  • metrics :: HashMap Text Text

    A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

  • journeyId :: Text

    The unique identifier for the journey that the metric applies to.

  • lastEvaluatedTime :: Text

    The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.

  • journeyActivityId :: Text

    The unique identifier for the activity that the metric applies to.

  • activityType :: Text

    The type of activity that the metric applies to. Possible values are:

    • CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.
    • HOLDOUT - For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.
    • MESSAGE - For an email activity, which is an activity that sends an email message to participants.
    • MULTI_CONDITIONAL_SPLIT - For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.
    • RANDOM_SPLIT - For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.
    • WAIT - For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
  • applicationId :: Text

    The unique identifier for the application that the metric applies to.

Instances

Instances details
Eq JourneyExecutionActivityMetricsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse

Read JourneyExecutionActivityMetricsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse

Show JourneyExecutionActivityMetricsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse

Generic JourneyExecutionActivityMetricsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse

NFData JourneyExecutionActivityMetricsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse

Hashable JourneyExecutionActivityMetricsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse

FromJSON JourneyExecutionActivityMetricsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse

type Rep JourneyExecutionActivityMetricsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse

type Rep JourneyExecutionActivityMetricsResponse = D1 ('MetaData "JourneyExecutionActivityMetricsResponse" "Amazonka.Pinpoint.Types.JourneyExecutionActivityMetricsResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "JourneyExecutionActivityMetricsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)) :*: (S1 ('MetaSel ('Just "journeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "lastEvaluatedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "journeyActivityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "activityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newJourneyExecutionActivityMetricsResponse Source #

Create a value of JourneyExecutionActivityMetricsResponse 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:metrics:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_metrics - A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

$sel:journeyId:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_journeyId - The unique identifier for the journey that the metric applies to.

$sel:lastEvaluatedTime:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_lastEvaluatedTime - The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.

$sel:journeyActivityId:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_journeyActivityId - The unique identifier for the activity that the metric applies to.

$sel:activityType:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_activityType - The type of activity that the metric applies to. Possible values are:

  • CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.
  • HOLDOUT - For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.
  • MESSAGE - For an email activity, which is an activity that sends an email message to participants.
  • MULTI_CONDITIONAL_SPLIT - For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.
  • RANDOM_SPLIT - For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.
  • WAIT - For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

$sel:applicationId:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_applicationId - The unique identifier for the application that the metric applies to.

journeyExecutionActivityMetricsResponse_metrics :: Lens' JourneyExecutionActivityMetricsResponse (HashMap Text Text) Source #

A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

journeyExecutionActivityMetricsResponse_journeyId :: Lens' JourneyExecutionActivityMetricsResponse Text Source #

The unique identifier for the journey that the metric applies to.

journeyExecutionActivityMetricsResponse_lastEvaluatedTime :: Lens' JourneyExecutionActivityMetricsResponse Text Source #

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.

journeyExecutionActivityMetricsResponse_activityType :: Lens' JourneyExecutionActivityMetricsResponse Text Source #

The type of activity that the metric applies to. Possible values are:

  • CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.
  • HOLDOUT - For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.
  • MESSAGE - For an email activity, which is an activity that sends an email message to participants.
  • MULTI_CONDITIONAL_SPLIT - For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.
  • RANDOM_SPLIT - For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.
  • WAIT - For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

journeyExecutionActivityMetricsResponse_applicationId :: Lens' JourneyExecutionActivityMetricsResponse Text Source #

The unique identifier for the application that the metric applies to.

JourneyExecutionMetricsResponse

data JourneyExecutionMetricsResponse Source #

Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.

See: newJourneyExecutionMetricsResponse smart constructor.

Constructors

JourneyExecutionMetricsResponse' 

Fields

Instances

Instances details
Eq JourneyExecutionMetricsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyExecutionMetricsResponse

Read JourneyExecutionMetricsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyExecutionMetricsResponse

Show JourneyExecutionMetricsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyExecutionMetricsResponse

Generic JourneyExecutionMetricsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyExecutionMetricsResponse

Associated Types

type Rep JourneyExecutionMetricsResponse :: Type -> Type #

NFData JourneyExecutionMetricsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyExecutionMetricsResponse

Hashable JourneyExecutionMetricsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyExecutionMetricsResponse

FromJSON JourneyExecutionMetricsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyExecutionMetricsResponse

type Rep JourneyExecutionMetricsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyExecutionMetricsResponse

type Rep JourneyExecutionMetricsResponse = D1 ('MetaData "JourneyExecutionMetricsResponse" "Amazonka.Pinpoint.Types.JourneyExecutionMetricsResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "JourneyExecutionMetricsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)) :*: S1 ('MetaSel ('Just "journeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "lastEvaluatedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newJourneyExecutionMetricsResponse Source #

Create a value of JourneyExecutionMetricsResponse 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:metrics:JourneyExecutionMetricsResponse', journeyExecutionMetricsResponse_metrics - A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

$sel:journeyId:JourneyExecutionMetricsResponse', journeyExecutionMetricsResponse_journeyId - The unique identifier for the journey that the metric applies to.

$sel:lastEvaluatedTime:JourneyExecutionMetricsResponse', journeyExecutionMetricsResponse_lastEvaluatedTime - The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.

$sel:applicationId:JourneyExecutionMetricsResponse', journeyExecutionMetricsResponse_applicationId - The unique identifier for the application that the metric applies to.

journeyExecutionMetricsResponse_metrics :: Lens' JourneyExecutionMetricsResponse (HashMap Text Text) Source #

A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

journeyExecutionMetricsResponse_journeyId :: Lens' JourneyExecutionMetricsResponse Text Source #

The unique identifier for the journey that the metric applies to.

journeyExecutionMetricsResponse_lastEvaluatedTime :: Lens' JourneyExecutionMetricsResponse Text Source #

The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.

journeyExecutionMetricsResponse_applicationId :: Lens' JourneyExecutionMetricsResponse Text Source #

The unique identifier for the application that the metric applies to.

JourneyLimits

data JourneyLimits Source #

Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.

See: newJourneyLimits smart constructor.

Constructors

JourneyLimits' 

Fields

  • messagesPerSecond :: Maybe Int

    The maximum number of messages that the journey can send each second.

  • endpointReentryCap :: Maybe Int

    The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

  • endpointReentryInterval :: Maybe Text

    Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.

  • dailyCap :: Maybe Int

    The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

Instances

Instances details
Eq JourneyLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyLimits

Read JourneyLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyLimits

Show JourneyLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyLimits

Generic JourneyLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyLimits

Associated Types

type Rep JourneyLimits :: Type -> Type #

NFData JourneyLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyLimits

Methods

rnf :: JourneyLimits -> () #

Hashable JourneyLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyLimits

ToJSON JourneyLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyLimits

FromJSON JourneyLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyLimits

type Rep JourneyLimits Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyLimits

type Rep JourneyLimits = D1 ('MetaData "JourneyLimits" "Amazonka.Pinpoint.Types.JourneyLimits" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "JourneyLimits'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "messagesPerSecond") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "endpointReentryCap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "endpointReentryInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dailyCap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newJourneyLimits :: JourneyLimits Source #

Create a value of JourneyLimits 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:messagesPerSecond:JourneyLimits', journeyLimits_messagesPerSecond - The maximum number of messages that the journey can send each second.

$sel:endpointReentryCap:JourneyLimits', journeyLimits_endpointReentryCap - The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

$sel:endpointReentryInterval:JourneyLimits', journeyLimits_endpointReentryInterval - Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.

$sel:dailyCap:JourneyLimits', journeyLimits_dailyCap - The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

journeyLimits_messagesPerSecond :: Lens' JourneyLimits (Maybe Int) Source #

The maximum number of messages that the journey can send each second.

journeyLimits_endpointReentryCap :: Lens' JourneyLimits (Maybe Int) Source #

The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

journeyLimits_endpointReentryInterval :: Lens' JourneyLimits (Maybe Text) Source #

Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.

journeyLimits_dailyCap :: Lens' JourneyLimits (Maybe Int) Source #

The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

JourneyPushMessage

data JourneyPushMessage Source #

Specifies the message configuration for a push notification that's sent to participants in a journey.

See: newJourneyPushMessage smart constructor.

Constructors

JourneyPushMessage' 

Fields

  • timeToLive :: Maybe Text

    The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

    This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

Instances

Instances details
Eq JourneyPushMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyPushMessage

Read JourneyPushMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyPushMessage

Show JourneyPushMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyPushMessage

Generic JourneyPushMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyPushMessage

Associated Types

type Rep JourneyPushMessage :: Type -> Type #

NFData JourneyPushMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyPushMessage

Methods

rnf :: JourneyPushMessage -> () #

Hashable JourneyPushMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyPushMessage

ToJSON JourneyPushMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyPushMessage

FromJSON JourneyPushMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyPushMessage

type Rep JourneyPushMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyPushMessage

type Rep JourneyPushMessage = D1 ('MetaData "JourneyPushMessage" "Amazonka.Pinpoint.Types.JourneyPushMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "JourneyPushMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "timeToLive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newJourneyPushMessage :: JourneyPushMessage Source #

Create a value of JourneyPushMessage 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:timeToLive:JourneyPushMessage', journeyPushMessage_timeToLive - The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

journeyPushMessage_timeToLive :: Lens' JourneyPushMessage (Maybe Text) Source #

The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

JourneyResponse

data JourneyResponse Source #

Provides information about the status, configuration, and other settings for a journey.

See: newJourneyResponse smart constructor.

Constructors

JourneyResponse' 

Fields

  • state :: Maybe State

    The current status of the journey. Possible values are:

    • DRAFT - The journey is being developed and hasn't been published yet.
    • ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
    • COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
    • CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
    • CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
  • lastModifiedDate :: Maybe Text

    The date, in ISO 8601 format, when the journey was last modified.

  • schedule :: Maybe JourneySchedule

    The schedule settings for the journey.

  • localTime :: Maybe Bool

    Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.

  • activities :: Maybe (HashMap Text Activity)

    A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.

  • refreshOnSegmentUpdate :: Maybe Bool

    Specifies whether a journey should be refreshed on segment update.

  • limits :: Maybe JourneyLimits

    The messaging and entry limits for the journey.

  • waitForQuietTime :: Maybe Bool

    Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.

  • quietTime :: Maybe QuietTime

    The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
    • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
    • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

    If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

  • startActivity :: Maybe Text

    The unique identifier for the first activity in the journey.

  • creationDate :: Maybe Text

    The date, in ISO 8601 format, when the journey was created.

  • startCondition :: Maybe StartCondition

    The segment that defines which users are participants in the journey.

  • journeyChannelSettings :: Maybe JourneyChannelSettings

    The channel-specific configurations for the journey.

  • refreshFrequency :: Maybe Text

    The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

  • tags :: Maybe (HashMap Text Text)

    This object is not used or supported.

  • name :: Text

    The name of the journey.

  • id :: Text

    The unique identifier for the journey.

  • applicationId :: Text

    The unique identifier for the application that the journey applies to.

Instances

Instances details
Eq JourneyResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyResponse

Read JourneyResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyResponse

Show JourneyResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyResponse

Generic JourneyResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyResponse

Associated Types

type Rep JourneyResponse :: Type -> Type #

NFData JourneyResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyResponse

Methods

rnf :: JourneyResponse -> () #

Hashable JourneyResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyResponse

FromJSON JourneyResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyResponse

type Rep JourneyResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyResponse

type Rep JourneyResponse = D1 ('MetaData "JourneyResponse" "Amazonka.Pinpoint.Types.JourneyResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "JourneyResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe State)) :*: S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JourneySchedule)) :*: S1 ('MetaSel ('Just "localTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "activities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Activity))) :*: S1 ('MetaSel ('Just "refreshOnSegmentUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "limits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JourneyLimits)) :*: (S1 ('MetaSel ('Just "waitForQuietTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "quietTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuietTime)))))) :*: (((S1 ('MetaSel ('Just "startActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "startCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StartCondition)) :*: S1 ('MetaSel ('Just "journeyChannelSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JourneyChannelSettings)))) :*: ((S1 ('MetaSel ('Just "refreshFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newJourneyResponse Source #

Create a value of JourneyResponse 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:state:JourneyResponse', journeyResponse_state - The current status of the journey. Possible values are:

  • DRAFT - The journey is being developed and hasn't been published yet.
  • ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
  • COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
  • CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
  • CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.

$sel:lastModifiedDate:JourneyResponse', journeyResponse_lastModifiedDate - The date, in ISO 8601 format, when the journey was last modified.

$sel:schedule:JourneyResponse', journeyResponse_schedule - The schedule settings for the journey.

$sel:localTime:JourneyResponse', journeyResponse_localTime - Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.

$sel:activities:JourneyResponse', journeyResponse_activities - A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.

$sel:refreshOnSegmentUpdate:JourneyResponse', journeyResponse_refreshOnSegmentUpdate - Specifies whether a journey should be refreshed on segment update.

$sel:limits:JourneyResponse', journeyResponse_limits - The messaging and entry limits for the journey.

$sel:waitForQuietTime:JourneyResponse', journeyResponse_waitForQuietTime - Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.

$sel:quietTime:JourneyResponse', journeyResponse_quietTime - The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

  • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
  • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
  • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

$sel:startActivity:JourneyResponse', journeyResponse_startActivity - The unique identifier for the first activity in the journey.

$sel:creationDate:JourneyResponse', journeyResponse_creationDate - The date, in ISO 8601 format, when the journey was created.

$sel:startCondition:JourneyResponse', journeyResponse_startCondition - The segment that defines which users are participants in the journey.

$sel:journeyChannelSettings:JourneyResponse', journeyResponse_journeyChannelSettings - The channel-specific configurations for the journey.

$sel:refreshFrequency:JourneyResponse', journeyResponse_refreshFrequency - The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

$sel:tags:JourneyResponse', journeyResponse_tags - This object is not used or supported.

$sel:name:JourneyResponse', journeyResponse_name - The name of the journey.

$sel:id:JourneyResponse', journeyResponse_id - The unique identifier for the journey.

$sel:applicationId:JourneyResponse', journeyResponse_applicationId - The unique identifier for the application that the journey applies to.

journeyResponse_state :: Lens' JourneyResponse (Maybe State) Source #

The current status of the journey. Possible values are:

  • DRAFT - The journey is being developed and hasn't been published yet.
  • ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
  • COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
  • CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
  • CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.

journeyResponse_lastModifiedDate :: Lens' JourneyResponse (Maybe Text) Source #

The date, in ISO 8601 format, when the journey was last modified.

journeyResponse_schedule :: Lens' JourneyResponse (Maybe JourneySchedule) Source #

The schedule settings for the journey.

journeyResponse_localTime :: Lens' JourneyResponse (Maybe Bool) Source #

Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.

journeyResponse_activities :: Lens' JourneyResponse (Maybe (HashMap Text Activity)) Source #

A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.

journeyResponse_refreshOnSegmentUpdate :: Lens' JourneyResponse (Maybe Bool) Source #

Specifies whether a journey should be refreshed on segment update.

journeyResponse_limits :: Lens' JourneyResponse (Maybe JourneyLimits) Source #

The messaging and entry limits for the journey.

journeyResponse_waitForQuietTime :: Lens' JourneyResponse (Maybe Bool) Source #

Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.

journeyResponse_quietTime :: Lens' JourneyResponse (Maybe QuietTime) Source #

The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

  • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
  • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
  • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

journeyResponse_startActivity :: Lens' JourneyResponse (Maybe Text) Source #

The unique identifier for the first activity in the journey.

journeyResponse_creationDate :: Lens' JourneyResponse (Maybe Text) Source #

The date, in ISO 8601 format, when the journey was created.

journeyResponse_startCondition :: Lens' JourneyResponse (Maybe StartCondition) Source #

The segment that defines which users are participants in the journey.

journeyResponse_journeyChannelSettings :: Lens' JourneyResponse (Maybe JourneyChannelSettings) Source #

The channel-specific configurations for the journey.

journeyResponse_refreshFrequency :: Lens' JourneyResponse (Maybe Text) Source #

The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

journeyResponse_tags :: Lens' JourneyResponse (Maybe (HashMap Text Text)) Source #

This object is not used or supported.

journeyResponse_id :: Lens' JourneyResponse Text Source #

The unique identifier for the journey.

journeyResponse_applicationId :: Lens' JourneyResponse Text Source #

The unique identifier for the application that the journey applies to.

JourneySMSMessage

data JourneySMSMessage Source #

Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

See: newJourneySMSMessage smart constructor.

Constructors

JourneySMSMessage' 

Fields

  • originationNumber :: Maybe Text

    The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

  • templateId :: Maybe Text

    The template ID received from the regulatory body for sending SMS in your country.

  • messageType :: Maybe MessageType

    The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

  • senderId :: Maybe Text

    The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.

  • entityId :: Maybe Text

    The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

Instances

Instances details
Eq JourneySMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySMSMessage

Read JourneySMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySMSMessage

Show JourneySMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySMSMessage

Generic JourneySMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySMSMessage

Associated Types

type Rep JourneySMSMessage :: Type -> Type #

NFData JourneySMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySMSMessage

Methods

rnf :: JourneySMSMessage -> () #

Hashable JourneySMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySMSMessage

ToJSON JourneySMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySMSMessage

FromJSON JourneySMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySMSMessage

type Rep JourneySMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySMSMessage

type Rep JourneySMSMessage = D1 ('MetaData "JourneySMSMessage" "Amazonka.Pinpoint.Types.JourneySMSMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "JourneySMSMessage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "originationNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "messageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageType)) :*: (S1 ('MetaSel ('Just "senderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newJourneySMSMessage :: JourneySMSMessage Source #

Create a value of JourneySMSMessage 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:originationNumber:JourneySMSMessage', journeySMSMessage_originationNumber - The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

$sel:templateId:JourneySMSMessage', journeySMSMessage_templateId - The template ID received from the regulatory body for sending SMS in your country.

$sel:messageType:JourneySMSMessage', journeySMSMessage_messageType - The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

$sel:senderId:JourneySMSMessage', journeySMSMessage_senderId - The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.

$sel:entityId:JourneySMSMessage', journeySMSMessage_entityId - The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

journeySMSMessage_originationNumber :: Lens' JourneySMSMessage (Maybe Text) Source #

The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

journeySMSMessage_templateId :: Lens' JourneySMSMessage (Maybe Text) Source #

The template ID received from the regulatory body for sending SMS in your country.

journeySMSMessage_messageType :: Lens' JourneySMSMessage (Maybe MessageType) Source #

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

journeySMSMessage_senderId :: Lens' JourneySMSMessage (Maybe Text) Source #

The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.

journeySMSMessage_entityId :: Lens' JourneySMSMessage (Maybe Text) Source #

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

JourneySchedule

data JourneySchedule Source #

Specifies the schedule settings for a journey.

See: newJourneySchedule smart constructor.

Constructors

JourneySchedule' 

Fields

  • startTime :: Maybe POSIX

    The scheduled time, in ISO 8601 format, when the journey began or will begin.

  • endTime :: Maybe POSIX

    The scheduled time, in ISO 8601 format, when the journey ended or will end.

  • timezone :: Maybe Text

    The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.

Instances

Instances details
Eq JourneySchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySchedule

Read JourneySchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySchedule

Show JourneySchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySchedule

Generic JourneySchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySchedule

Associated Types

type Rep JourneySchedule :: Type -> Type #

NFData JourneySchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySchedule

Methods

rnf :: JourneySchedule -> () #

Hashable JourneySchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySchedule

ToJSON JourneySchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySchedule

FromJSON JourneySchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySchedule

type Rep JourneySchedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneySchedule

type Rep JourneySchedule = D1 ('MetaData "JourneySchedule" "Amazonka.Pinpoint.Types.JourneySchedule" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "JourneySchedule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newJourneySchedule :: JourneySchedule Source #

Create a value of JourneySchedule 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:startTime:JourneySchedule', journeySchedule_startTime - The scheduled time, in ISO 8601 format, when the journey began or will begin.

$sel:endTime:JourneySchedule', journeySchedule_endTime - The scheduled time, in ISO 8601 format, when the journey ended or will end.

$sel:timezone:JourneySchedule', journeySchedule_timezone - The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.

journeySchedule_startTime :: Lens' JourneySchedule (Maybe UTCTime) Source #

The scheduled time, in ISO 8601 format, when the journey began or will begin.

journeySchedule_endTime :: Lens' JourneySchedule (Maybe UTCTime) Source #

The scheduled time, in ISO 8601 format, when the journey ended or will end.

journeySchedule_timezone :: Lens' JourneySchedule (Maybe Text) Source #

The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.

JourneyStateRequest

data JourneyStateRequest Source #

Changes the status of a journey.

See: newJourneyStateRequest smart constructor.

Constructors

JourneyStateRequest' 

Fields

  • state :: Maybe State

    The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED

    If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.

    After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.

    When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.

Instances

Instances details
Eq JourneyStateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyStateRequest

Read JourneyStateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyStateRequest

Show JourneyStateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyStateRequest

Generic JourneyStateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyStateRequest

Associated Types

type Rep JourneyStateRequest :: Type -> Type #

NFData JourneyStateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyStateRequest

Methods

rnf :: JourneyStateRequest -> () #

Hashable JourneyStateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyStateRequest

ToJSON JourneyStateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyStateRequest

type Rep JourneyStateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyStateRequest

type Rep JourneyStateRequest = D1 ('MetaData "JourneyStateRequest" "Amazonka.Pinpoint.Types.JourneyStateRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "JourneyStateRequest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe State))))

newJourneyStateRequest :: JourneyStateRequest Source #

Create a value of JourneyStateRequest 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:state:JourneyStateRequest', journeyStateRequest_state - The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED

If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.

After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.

When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.

journeyStateRequest_state :: Lens' JourneyStateRequest (Maybe State) Source #

The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED

If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.

After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.

When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.

JourneysResponse

data JourneysResponse Source #

Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.

See: newJourneysResponse smart constructor.

Constructors

JourneysResponse' 

Fields

  • nextToken :: Maybe Text

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

  • item :: [JourneyResponse]

    An array of responses, one for each journey that's associated with the application.

Instances

Instances details
Eq JourneysResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneysResponse

Read JourneysResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneysResponse

Show JourneysResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneysResponse

Generic JourneysResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneysResponse

Associated Types

type Rep JourneysResponse :: Type -> Type #

NFData JourneysResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneysResponse

Methods

rnf :: JourneysResponse -> () #

Hashable JourneysResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneysResponse

FromJSON JourneysResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneysResponse

type Rep JourneysResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneysResponse

type Rep JourneysResponse = D1 ('MetaData "JourneysResponse" "Amazonka.Pinpoint.Types.JourneysResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "JourneysResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [JourneyResponse])))

newJourneysResponse :: JourneysResponse Source #

Create a value of JourneysResponse 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:nextToken:JourneysResponse', journeysResponse_nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

$sel:item:JourneysResponse', journeysResponse_item - An array of responses, one for each journey that's associated with the application.

journeysResponse_nextToken :: Lens' JourneysResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

journeysResponse_item :: Lens' JourneysResponse [JourneyResponse] Source #

An array of responses, one for each journey that's associated with the application.

ListRecommenderConfigurationsResponse

data ListRecommenderConfigurationsResponse Source #

Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.

See: newListRecommenderConfigurationsResponse smart constructor.

Constructors

ListRecommenderConfigurationsResponse' 

Fields

  • nextToken :: Maybe Text

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

  • item :: [RecommenderConfigurationResponse]

    An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.

Instances

Instances details
Eq ListRecommenderConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ListRecommenderConfigurationsResponse

Read ListRecommenderConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ListRecommenderConfigurationsResponse

Show ListRecommenderConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ListRecommenderConfigurationsResponse

Generic ListRecommenderConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ListRecommenderConfigurationsResponse

NFData ListRecommenderConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ListRecommenderConfigurationsResponse

Hashable ListRecommenderConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ListRecommenderConfigurationsResponse

FromJSON ListRecommenderConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ListRecommenderConfigurationsResponse

type Rep ListRecommenderConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ListRecommenderConfigurationsResponse

type Rep ListRecommenderConfigurationsResponse = D1 ('MetaData "ListRecommenderConfigurationsResponse" "Amazonka.Pinpoint.Types.ListRecommenderConfigurationsResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ListRecommenderConfigurationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [RecommenderConfigurationResponse])))

newListRecommenderConfigurationsResponse :: ListRecommenderConfigurationsResponse Source #

Create a value of ListRecommenderConfigurationsResponse 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:nextToken:ListRecommenderConfigurationsResponse', listRecommenderConfigurationsResponse_nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

$sel:item:ListRecommenderConfigurationsResponse', listRecommenderConfigurationsResponse_item - An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.

listRecommenderConfigurationsResponse_nextToken :: Lens' ListRecommenderConfigurationsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

listRecommenderConfigurationsResponse_item :: Lens' ListRecommenderConfigurationsResponse [RecommenderConfigurationResponse] Source #

An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.

Message

data Message Source #

Specifies the content and settings for a push notification that's sent to recipients of a campaign.

See: newMessage smart constructor.

Constructors

Message' 

Fields

  • silentPush :: Maybe Bool

    Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

  • imageIconUrl :: Maybe Text

    The URL of the image to display as the push-notification icon, such as the icon for the app.

  • rawContent :: Maybe Text

    The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

  • body :: Maybe Text

    The body of the notification message. The maximum number of characters is 200.

  • timeToLive :: Maybe Int

    The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

    This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

  • imageSmallIconUrl :: Maybe Text

    The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

  • jsonBody :: Maybe Text

    The JSON payload to use for a silent push notification.

  • url :: Maybe Text

    The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

  • action :: Maybe Action

    The action to occur if a recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
  • imageUrl :: Maybe Text

    The URL of an image to display in the push notification.

  • mediaUrl :: Maybe Text

    The URL of the image or video to display in the push notification.

  • title :: Maybe Text

    The title to display above the notification message on a recipient's device.

Instances

Instances details
Eq Message Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Message

Methods

(==) :: Message -> Message -> Bool #

(/=) :: Message -> Message -> Bool #

Read Message Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Message

Show Message Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Message

Generic Message Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Message

Associated Types

type Rep Message :: Type -> Type #

Methods

from :: Message -> Rep Message x #

to :: Rep Message x -> Message #

NFData Message Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Message

Methods

rnf :: Message -> () #

Hashable Message Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Message

Methods

hashWithSalt :: Int -> Message -> Int #

hash :: Message -> Int #

ToJSON Message Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Message

FromJSON Message Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Message

type Rep Message Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Message

type Rep Message = D1 ('MetaData "Message" "Amazonka.Pinpoint.Types.Message" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "Message'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "silentPush") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "imageIconUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "rawContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "timeToLive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "imageSmallIconUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "jsonBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Action)))) :*: (S1 ('MetaSel ('Just "imageUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "mediaUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newMessage :: Message Source #

Create a value of Message 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:silentPush:Message', message_silentPush - Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

$sel:imageIconUrl:Message', message_imageIconUrl - The URL of the image to display as the push-notification icon, such as the icon for the app.

$sel:rawContent:Message', message_rawContent - The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

$sel:body:Message', message_body - The body of the notification message. The maximum number of characters is 200.

$sel:timeToLive:Message', message_timeToLive - The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

$sel:imageSmallIconUrl:Message', message_imageSmallIconUrl - The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

$sel:jsonBody:Message', message_jsonBody - The JSON payload to use for a silent push notification.

$sel:url:Message', message_url - The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

$sel:action:Message', message_action - The action to occur if a recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

$sel:imageUrl:Message', message_imageUrl - The URL of an image to display in the push notification.

$sel:mediaUrl:Message', message_mediaUrl - The URL of the image or video to display in the push notification.

$sel:title:Message', message_title - The title to display above the notification message on a recipient's device.

message_silentPush :: Lens' Message (Maybe Bool) Source #

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

message_imageIconUrl :: Lens' Message (Maybe Text) Source #

The URL of the image to display as the push-notification icon, such as the icon for the app.

message_rawContent :: Lens' Message (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

message_body :: Lens' Message (Maybe Text) Source #

The body of the notification message. The maximum number of characters is 200.

message_timeToLive :: Lens' Message (Maybe Int) Source #

The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

message_imageSmallIconUrl :: Lens' Message (Maybe Text) Source #

The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

message_jsonBody :: Lens' Message (Maybe Text) Source #

The JSON payload to use for a silent push notification.

message_url :: Lens' Message (Maybe Text) Source #

The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

message_action :: Lens' Message (Maybe Action) Source #

The action to occur if a recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

message_imageUrl :: Lens' Message (Maybe Text) Source #

The URL of an image to display in the push notification.

message_mediaUrl :: Lens' Message (Maybe Text) Source #

The URL of the image or video to display in the push notification.

message_title :: Lens' Message (Maybe Text) Source #

The title to display above the notification message on a recipient's device.

MessageBody

data MessageBody Source #

Provides information about an API request or response.

See: newMessageBody smart constructor.

Constructors

MessageBody' 

Fields

Instances

Instances details
Eq MessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageBody

Read MessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageBody

Show MessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageBody

Generic MessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageBody

Associated Types

type Rep MessageBody :: Type -> Type #

NFData MessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageBody

Methods

rnf :: MessageBody -> () #

Hashable MessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageBody

FromJSON MessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageBody

type Rep MessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageBody

type Rep MessageBody = D1 ('MetaData "MessageBody" "Amazonka.Pinpoint.Types.MessageBody" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "MessageBody'" 'PrefixI 'True) (S1 ('MetaSel ('Just "requestID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newMessageBody :: MessageBody Source #

Create a value of MessageBody 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:requestID:MessageBody', messageBody_requestID - The unique identifier for the request or response.

$sel:message:MessageBody', messageBody_message - The message that's returned from the API.

messageBody_requestID :: Lens' MessageBody (Maybe Text) Source #

The unique identifier for the request or response.

messageBody_message :: Lens' MessageBody (Maybe Text) Source #

The message that's returned from the API.

MessageConfiguration

data MessageConfiguration Source #

Specifies the message configuration settings for a campaign.

See: newMessageConfiguration smart constructor.

Constructors

MessageConfiguration' 

Fields

  • aPNSMessage :: Maybe Message

    The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

  • gCMMessage :: Maybe Message

    The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

  • defaultMessage :: Maybe Message

    The default message that the campaign sends through all the channels that are configured for the campaign.

  • customMessage :: Maybe CampaignCustomMessage

    The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

  • aDMMessage :: Maybe Message

    The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

  • sMSMessage :: Maybe CampaignSmsMessage

    The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

  • emailMessage :: Maybe CampaignEmailMessage

    The message that the campaign sends through the email channel. If specified, this message overrides the default message.

  • inAppMessage :: Maybe CampaignInAppMessage

    The in-app message configuration.

  • baiduMessage :: Maybe Message

    The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

Instances

Instances details
Eq MessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageConfiguration

Read MessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageConfiguration

Show MessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageConfiguration

Generic MessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageConfiguration

Associated Types

type Rep MessageConfiguration :: Type -> Type #

NFData MessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageConfiguration

Methods

rnf :: MessageConfiguration -> () #

Hashable MessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageConfiguration

ToJSON MessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageConfiguration

FromJSON MessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageConfiguration

type Rep MessageConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageConfiguration

newMessageConfiguration :: MessageConfiguration Source #

Create a value of MessageConfiguration 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:aPNSMessage:MessageConfiguration', messageConfiguration_aPNSMessage - The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

$sel:gCMMessage:MessageConfiguration', messageConfiguration_gCMMessage - The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

$sel:defaultMessage:MessageConfiguration', messageConfiguration_defaultMessage - The default message that the campaign sends through all the channels that are configured for the campaign.

$sel:customMessage:MessageConfiguration', messageConfiguration_customMessage - The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

$sel:aDMMessage:MessageConfiguration', messageConfiguration_aDMMessage - The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

$sel:sMSMessage:MessageConfiguration', messageConfiguration_sMSMessage - The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

$sel:emailMessage:MessageConfiguration', messageConfiguration_emailMessage - The message that the campaign sends through the email channel. If specified, this message overrides the default message.

$sel:inAppMessage:MessageConfiguration', messageConfiguration_inAppMessage - The in-app message configuration.

$sel:baiduMessage:MessageConfiguration', messageConfiguration_baiduMessage - The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

messageConfiguration_aPNSMessage :: Lens' MessageConfiguration (Maybe Message) Source #

The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

messageConfiguration_gCMMessage :: Lens' MessageConfiguration (Maybe Message) Source #

The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

messageConfiguration_defaultMessage :: Lens' MessageConfiguration (Maybe Message) Source #

The default message that the campaign sends through all the channels that are configured for the campaign.

messageConfiguration_customMessage :: Lens' MessageConfiguration (Maybe CampaignCustomMessage) Source #

The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

messageConfiguration_aDMMessage :: Lens' MessageConfiguration (Maybe Message) Source #

The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

messageConfiguration_sMSMessage :: Lens' MessageConfiguration (Maybe CampaignSmsMessage) Source #

The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

messageConfiguration_emailMessage :: Lens' MessageConfiguration (Maybe CampaignEmailMessage) Source #

The message that the campaign sends through the email channel. If specified, this message overrides the default message.

messageConfiguration_baiduMessage :: Lens' MessageConfiguration (Maybe Message) Source #

The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

MessageRequest

data MessageRequest Source #

Specifies the configuration and other settings for a message.

See: newMessageRequest smart constructor.

Constructors

MessageRequest' 

Fields

Instances

Instances details
Eq MessageRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageRequest

Read MessageRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageRequest

Show MessageRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageRequest

Generic MessageRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageRequest

Associated Types

type Rep MessageRequest :: Type -> Type #

NFData MessageRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageRequest

Methods

rnf :: MessageRequest -> () #

Hashable MessageRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageRequest

ToJSON MessageRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageRequest

type Rep MessageRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageRequest

newMessageRequest Source #

Create a value of MessageRequest 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:traceId:MessageRequest', messageRequest_traceId - The unique identifier for tracing the message. This identifier is visible to message recipients.

$sel:context:MessageRequest', messageRequest_context - A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

$sel:addresses:MessageRequest', messageRequest_addresses - A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.

$sel:templateConfiguration:MessageRequest', messageRequest_templateConfiguration - The message template to use for the message.

$sel:endpoints:MessageRequest', messageRequest_endpoints - A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.

$sel:messageConfiguration:MessageRequest', messageRequest_messageConfiguration - The settings and content for the default message and any default messages that you defined for specific channels.

messageRequest_traceId :: Lens' MessageRequest (Maybe Text) Source #

The unique identifier for tracing the message. This identifier is visible to message recipients.

messageRequest_context :: Lens' MessageRequest (Maybe (HashMap Text Text)) Source #

A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

messageRequest_addresses :: Lens' MessageRequest (Maybe (HashMap Text AddressConfiguration)) Source #

A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.

messageRequest_endpoints :: Lens' MessageRequest (Maybe (HashMap Text EndpointSendConfiguration)) Source #

A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.

messageRequest_messageConfiguration :: Lens' MessageRequest DirectMessageConfiguration Source #

The settings and content for the default message and any default messages that you defined for specific channels.

MessageResponse

data MessageResponse Source #

Provides information about the results of a request to send a message to an endpoint address.

See: newMessageResponse smart constructor.

Constructors

MessageResponse' 

Fields

  • requestId :: Maybe Text

    The identifier for the original request that the message was delivered for.

  • result :: Maybe (HashMap Text MessageResult)

    A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.

  • endpointResult :: Maybe (HashMap Text EndpointMessageResult)

    A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.

  • applicationId :: Text

    The unique identifier for the application that was used to send the message.

Instances

Instances details
Eq MessageResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageResponse

Read MessageResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageResponse

Show MessageResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageResponse

Generic MessageResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageResponse

Associated Types

type Rep MessageResponse :: Type -> Type #

NFData MessageResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageResponse

Methods

rnf :: MessageResponse -> () #

Hashable MessageResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageResponse

FromJSON MessageResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageResponse

type Rep MessageResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageResponse

type Rep MessageResponse = D1 ('MetaData "MessageResponse" "Amazonka.Pinpoint.Types.MessageResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "MessageResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text MessageResult)))) :*: (S1 ('MetaSel ('Just "endpointResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text EndpointMessageResult))) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newMessageResponse Source #

Create a value of MessageResponse 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:requestId:MessageResponse', messageResponse_requestId - The identifier for the original request that the message was delivered for.

$sel:result:MessageResponse', messageResponse_result - A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.

$sel:endpointResult:MessageResponse', messageResponse_endpointResult - A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.

$sel:applicationId:MessageResponse', messageResponse_applicationId - The unique identifier for the application that was used to send the message.

messageResponse_requestId :: Lens' MessageResponse (Maybe Text) Source #

The identifier for the original request that the message was delivered for.

messageResponse_result :: Lens' MessageResponse (Maybe (HashMap Text MessageResult)) Source #

A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.

messageResponse_endpointResult :: Lens' MessageResponse (Maybe (HashMap Text EndpointMessageResult)) Source #

A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.

messageResponse_applicationId :: Lens' MessageResponse Text Source #

The unique identifier for the application that was used to send the message.

MessageResult

data MessageResult Source #

Provides information about the results of sending a message directly to an endpoint address.

See: newMessageResult smart constructor.

Constructors

MessageResult' 

Fields

  • statusMessage :: Maybe Text

    The status message for delivering the message.

  • updatedToken :: Maybe Text

    For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

  • messageId :: Maybe Text

    The unique identifier for the message that was sent.

  • deliveryStatus :: DeliveryStatus

    The delivery status of the message. Possible values are:

    • DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
    • OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
    • PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
    • SUCCESSFUL - The message was successfully delivered to the endpoint address.
    • TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
    • THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
    • TIMEOUT - The message couldn't be sent within the timeout period.
    • UNKNOWN_FAILURE - An unknown error occurred.
  • statusCode :: Int

    The downstream service status code for delivering the message.

Instances

Instances details
Eq MessageResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageResult

Read MessageResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageResult

Show MessageResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageResult

Generic MessageResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageResult

Associated Types

type Rep MessageResult :: Type -> Type #

NFData MessageResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageResult

Methods

rnf :: MessageResult -> () #

Hashable MessageResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageResult

FromJSON MessageResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageResult

type Rep MessageResult Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MessageResult

type Rep MessageResult = D1 ('MetaData "MessageResult" "Amazonka.Pinpoint.Types.MessageResult" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "MessageResult'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "updatedToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "messageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "deliveryStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeliveryStatus) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newMessageResult Source #

Create a value of MessageResult 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:statusMessage:MessageResult', messageResult_statusMessage - The status message for delivering the message.

$sel:updatedToken:MessageResult', messageResult_updatedToken - For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

$sel:messageId:MessageResult', messageResult_messageId - The unique identifier for the message that was sent.

$sel:deliveryStatus:MessageResult', messageResult_deliveryStatus - The delivery status of the message. Possible values are:

  • DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
  • OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
  • PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
  • SUCCESSFUL - The message was successfully delivered to the endpoint address.
  • TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
  • THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
  • TIMEOUT - The message couldn't be sent within the timeout period.
  • UNKNOWN_FAILURE - An unknown error occurred.

$sel:statusCode:MessageResult', messageResult_statusCode - The downstream service status code for delivering the message.

messageResult_statusMessage :: Lens' MessageResult (Maybe Text) Source #

The status message for delivering the message.

messageResult_updatedToken :: Lens' MessageResult (Maybe Text) Source #

For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

messageResult_messageId :: Lens' MessageResult (Maybe Text) Source #

The unique identifier for the message that was sent.

messageResult_deliveryStatus :: Lens' MessageResult DeliveryStatus Source #

The delivery status of the message. Possible values are:

  • DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
  • OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
  • PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
  • SUCCESSFUL - The message was successfully delivered to the endpoint address.
  • TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
  • THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
  • TIMEOUT - The message couldn't be sent within the timeout period.
  • UNKNOWN_FAILURE - An unknown error occurred.

messageResult_statusCode :: Lens' MessageResult Int Source #

The downstream service status code for delivering the message.

MetricDimension

data MetricDimension Source #

Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

See: newMetricDimension smart constructor.

Constructors

MetricDimension' 

Fields

  • comparisonOperator :: Text

    The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

  • value :: Double

    The value to compare.

Instances

Instances details
Eq MetricDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MetricDimension

Read MetricDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MetricDimension

Show MetricDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MetricDimension

Generic MetricDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MetricDimension

Associated Types

type Rep MetricDimension :: Type -> Type #

NFData MetricDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MetricDimension

Methods

rnf :: MetricDimension -> () #

Hashable MetricDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MetricDimension

ToJSON MetricDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MetricDimension

FromJSON MetricDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MetricDimension

type Rep MetricDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MetricDimension

type Rep MetricDimension = D1 ('MetaData "MetricDimension" "Amazonka.Pinpoint.Types.MetricDimension" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "MetricDimension'" 'PrefixI 'True) (S1 ('MetaSel ('Just "comparisonOperator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)))

newMetricDimension Source #

Create a value of MetricDimension 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:comparisonOperator:MetricDimension', metricDimension_comparisonOperator - The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

$sel:value:MetricDimension', metricDimension_value - The value to compare.

metricDimension_comparisonOperator :: Lens' MetricDimension Text Source #

The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

MultiConditionalBranch

data MultiConditionalBranch Source #

Specifies a condition to evaluate for an activity path in a journey.

See: newMultiConditionalBranch smart constructor.

Constructors

MultiConditionalBranch' 

Fields

Instances

Instances details
Eq MultiConditionalBranch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalBranch

Read MultiConditionalBranch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalBranch

Show MultiConditionalBranch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalBranch

Generic MultiConditionalBranch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalBranch

Associated Types

type Rep MultiConditionalBranch :: Type -> Type #

NFData MultiConditionalBranch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalBranch

Methods

rnf :: MultiConditionalBranch -> () #

Hashable MultiConditionalBranch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalBranch

ToJSON MultiConditionalBranch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalBranch

FromJSON MultiConditionalBranch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalBranch

type Rep MultiConditionalBranch Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalBranch

type Rep MultiConditionalBranch = D1 ('MetaData "MultiConditionalBranch" "Amazonka.Pinpoint.Types.MultiConditionalBranch" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "MultiConditionalBranch'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "condition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimpleCondition))))

newMultiConditionalBranch :: MultiConditionalBranch Source #

Create a value of MultiConditionalBranch 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:nextActivity:MultiConditionalBranch', multiConditionalBranch_nextActivity - The unique identifier for the next activity to perform, after completing the activity for the path.

$sel:condition:MultiConditionalBranch', multiConditionalBranch_condition - The condition to evaluate for the activity path.

multiConditionalBranch_nextActivity :: Lens' MultiConditionalBranch (Maybe Text) Source #

The unique identifier for the next activity to perform, after completing the activity for the path.

multiConditionalBranch_condition :: Lens' MultiConditionalBranch (Maybe SimpleCondition) Source #

The condition to evaluate for the activity path.

MultiConditionalSplitActivity

data MultiConditionalSplitActivity Source #

Specifies the settings for a multivariate split activity in a journey. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.

To create multivariate split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.

See: newMultiConditionalSplitActivity smart constructor.

Constructors

MultiConditionalSplitActivity' 

Fields

  • branches :: Maybe [MultiConditionalBranch]

    The paths for the activity, including the conditions for entering each path and the activity to perform for each path.

  • evaluationWaitTime :: Maybe WaitTime

    The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.

  • defaultActivity :: Maybe Text

    The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.

Instances

Instances details
Eq MultiConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalSplitActivity

Read MultiConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalSplitActivity

Show MultiConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalSplitActivity

Generic MultiConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalSplitActivity

Associated Types

type Rep MultiConditionalSplitActivity :: Type -> Type #

NFData MultiConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalSplitActivity

Hashable MultiConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalSplitActivity

ToJSON MultiConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalSplitActivity

FromJSON MultiConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalSplitActivity

type Rep MultiConditionalSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.MultiConditionalSplitActivity

type Rep MultiConditionalSplitActivity = D1 ('MetaData "MultiConditionalSplitActivity" "Amazonka.Pinpoint.Types.MultiConditionalSplitActivity" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "MultiConditionalSplitActivity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "branches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MultiConditionalBranch])) :*: (S1 ('MetaSel ('Just "evaluationWaitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WaitTime)) :*: S1 ('MetaSel ('Just "defaultActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newMultiConditionalSplitActivity :: MultiConditionalSplitActivity Source #

Create a value of MultiConditionalSplitActivity 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:branches:MultiConditionalSplitActivity', multiConditionalSplitActivity_branches - The paths for the activity, including the conditions for entering each path and the activity to perform for each path.

$sel:evaluationWaitTime:MultiConditionalSplitActivity', multiConditionalSplitActivity_evaluationWaitTime - The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.

$sel:defaultActivity:MultiConditionalSplitActivity', multiConditionalSplitActivity_defaultActivity - The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.

multiConditionalSplitActivity_branches :: Lens' MultiConditionalSplitActivity (Maybe [MultiConditionalBranch]) Source #

The paths for the activity, including the conditions for entering each path and the activity to perform for each path.

multiConditionalSplitActivity_evaluationWaitTime :: Lens' MultiConditionalSplitActivity (Maybe WaitTime) Source #

The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.

multiConditionalSplitActivity_defaultActivity :: Lens' MultiConditionalSplitActivity (Maybe Text) Source #

The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.

NumberValidateRequest

data NumberValidateRequest Source #

Specifies a phone number to validate and retrieve information about.

See: newNumberValidateRequest smart constructor.

Constructors

NumberValidateRequest' 

Fields

  • isoCountryCode :: Maybe Text

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

  • phoneNumber :: Maybe Text

    The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.

Instances

Instances details
Eq NumberValidateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.NumberValidateRequest

Read NumberValidateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.NumberValidateRequest

Show NumberValidateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.NumberValidateRequest

Generic NumberValidateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.NumberValidateRequest

Associated Types

type Rep NumberValidateRequest :: Type -> Type #

NFData NumberValidateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.NumberValidateRequest

Methods

rnf :: NumberValidateRequest -> () #

Hashable NumberValidateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.NumberValidateRequest

ToJSON NumberValidateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.NumberValidateRequest

type Rep NumberValidateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.NumberValidateRequest

type Rep NumberValidateRequest = D1 ('MetaData "NumberValidateRequest" "Amazonka.Pinpoint.Types.NumberValidateRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "NumberValidateRequest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "isoCountryCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "phoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newNumberValidateRequest :: NumberValidateRequest Source #

Create a value of NumberValidateRequest 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:isoCountryCode:NumberValidateRequest', numberValidateRequest_isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

$sel:phoneNumber:NumberValidateRequest', numberValidateRequest_phoneNumber - The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.

numberValidateRequest_isoCountryCode :: Lens' NumberValidateRequest (Maybe Text) Source #

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

numberValidateRequest_phoneNumber :: Lens' NumberValidateRequest (Maybe Text) Source #

The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.

NumberValidateResponse

data NumberValidateResponse Source #

Provides information about a phone number.

See: newNumberValidateResponse smart constructor.

Constructors

NumberValidateResponse' 

Fields

  • carrier :: Maybe Text

    The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.

  • county :: Maybe Text

    The name of the county where the phone number was originally registered.

  • country :: Maybe Text

    The name of the country or region where the phone number was originally registered.

  • countryCodeNumeric :: Maybe Text

    The numeric code for the country or region where the phone number was originally registered.

  • zipCode :: Maybe Text

    The postal or ZIP code for the location where the phone number was originally registered.

  • originalPhoneNumber :: Maybe Text

    The phone number that was sent in the request body.

  • phoneTypeCode :: Maybe Int

    The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).

  • phoneType :: Maybe Text

    The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.

  • city :: Maybe Text

    The name of the city where the phone number was originally registered.

  • countryCodeIso2 :: Maybe Text

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

  • timezone :: Maybe Text

    The time zone for the location where the phone number was originally registered.

  • originalCountryCodeIso2 :: Maybe Text

    The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.

  • cleansedPhoneNumberNational :: Maybe Text

    The cleansed phone number, in the format for the location where the phone number was originally registered.

  • cleansedPhoneNumberE164 :: Maybe Text

    The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.

Instances

Instances details
Eq NumberValidateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.NumberValidateResponse

Read NumberValidateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.NumberValidateResponse

Show NumberValidateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.NumberValidateResponse

Generic NumberValidateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.NumberValidateResponse

Associated Types

type Rep NumberValidateResponse :: Type -> Type #

NFData NumberValidateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.NumberValidateResponse

Methods

rnf :: NumberValidateResponse -> () #

Hashable NumberValidateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.NumberValidateResponse

FromJSON NumberValidateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.NumberValidateResponse

type Rep NumberValidateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.NumberValidateResponse

type Rep NumberValidateResponse = D1 ('MetaData "NumberValidateResponse" "Amazonka.Pinpoint.Types.NumberValidateResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "NumberValidateResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "carrier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "county") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "country") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "countryCodeNumeric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "zipCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "originalPhoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "phoneTypeCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: ((S1 ('MetaSel ('Just "phoneType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "city") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "countryCodeIso2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "originalCountryCodeIso2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "cleansedPhoneNumberNational") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cleansedPhoneNumberE164") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newNumberValidateResponse :: NumberValidateResponse Source #

Create a value of NumberValidateResponse 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:carrier:NumberValidateResponse', numberValidateResponse_carrier - The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.

$sel:county:NumberValidateResponse', numberValidateResponse_county - The name of the county where the phone number was originally registered.

$sel:country:NumberValidateResponse', numberValidateResponse_country - The name of the country or region where the phone number was originally registered.

$sel:countryCodeNumeric:NumberValidateResponse', numberValidateResponse_countryCodeNumeric - The numeric code for the country or region where the phone number was originally registered.

$sel:zipCode:NumberValidateResponse', numberValidateResponse_zipCode - The postal or ZIP code for the location where the phone number was originally registered.

$sel:originalPhoneNumber:NumberValidateResponse', numberValidateResponse_originalPhoneNumber - The phone number that was sent in the request body.

$sel:phoneTypeCode:NumberValidateResponse', numberValidateResponse_phoneTypeCode - The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).

$sel:phoneType:NumberValidateResponse', numberValidateResponse_phoneType - The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.

$sel:city:NumberValidateResponse', numberValidateResponse_city - The name of the city where the phone number was originally registered.

$sel:countryCodeIso2:NumberValidateResponse', numberValidateResponse_countryCodeIso2 - The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

$sel:timezone:NumberValidateResponse', numberValidateResponse_timezone - The time zone for the location where the phone number was originally registered.

$sel:originalCountryCodeIso2:NumberValidateResponse', numberValidateResponse_originalCountryCodeIso2 - The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.

$sel:cleansedPhoneNumberNational:NumberValidateResponse', numberValidateResponse_cleansedPhoneNumberNational - The cleansed phone number, in the format for the location where the phone number was originally registered.

$sel:cleansedPhoneNumberE164:NumberValidateResponse', numberValidateResponse_cleansedPhoneNumberE164 - The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.

numberValidateResponse_carrier :: Lens' NumberValidateResponse (Maybe Text) Source #

The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.

numberValidateResponse_county :: Lens' NumberValidateResponse (Maybe Text) Source #

The name of the county where the phone number was originally registered.

numberValidateResponse_country :: Lens' NumberValidateResponse (Maybe Text) Source #

The name of the country or region where the phone number was originally registered.

numberValidateResponse_countryCodeNumeric :: Lens' NumberValidateResponse (Maybe Text) Source #

The numeric code for the country or region where the phone number was originally registered.

numberValidateResponse_zipCode :: Lens' NumberValidateResponse (Maybe Text) Source #

The postal or ZIP code for the location where the phone number was originally registered.

numberValidateResponse_originalPhoneNumber :: Lens' NumberValidateResponse (Maybe Text) Source #

The phone number that was sent in the request body.

numberValidateResponse_phoneTypeCode :: Lens' NumberValidateResponse (Maybe Int) Source #

The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).

numberValidateResponse_phoneType :: Lens' NumberValidateResponse (Maybe Text) Source #

The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.

numberValidateResponse_city :: Lens' NumberValidateResponse (Maybe Text) Source #

The name of the city where the phone number was originally registered.

numberValidateResponse_countryCodeIso2 :: Lens' NumberValidateResponse (Maybe Text) Source #

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

numberValidateResponse_timezone :: Lens' NumberValidateResponse (Maybe Text) Source #

The time zone for the location where the phone number was originally registered.

numberValidateResponse_originalCountryCodeIso2 :: Lens' NumberValidateResponse (Maybe Text) Source #

The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.

numberValidateResponse_cleansedPhoneNumberNational :: Lens' NumberValidateResponse (Maybe Text) Source #

The cleansed phone number, in the format for the location where the phone number was originally registered.

numberValidateResponse_cleansedPhoneNumberE164 :: Lens' NumberValidateResponse (Maybe Text) Source #

The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.

OverrideButtonConfiguration

data OverrideButtonConfiguration Source #

Override button configuration.

See: newOverrideButtonConfiguration smart constructor.

Constructors

OverrideButtonConfiguration' 

Fields

Instances

Instances details
Eq OverrideButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.OverrideButtonConfiguration

Read OverrideButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.OverrideButtonConfiguration

Show OverrideButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.OverrideButtonConfiguration

Generic OverrideButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.OverrideButtonConfiguration

Associated Types

type Rep OverrideButtonConfiguration :: Type -> Type #

NFData OverrideButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.OverrideButtonConfiguration

Hashable OverrideButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.OverrideButtonConfiguration

ToJSON OverrideButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.OverrideButtonConfiguration

FromJSON OverrideButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.OverrideButtonConfiguration

type Rep OverrideButtonConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.OverrideButtonConfiguration

type Rep OverrideButtonConfiguration = D1 ('MetaData "OverrideButtonConfiguration" "Amazonka.Pinpoint.Types.OverrideButtonConfiguration" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "OverrideButtonConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "link") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "buttonAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ButtonAction)))

newOverrideButtonConfiguration Source #

Create a value of OverrideButtonConfiguration 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:link:OverrideButtonConfiguration', overrideButtonConfiguration_link - Button destination.

$sel:buttonAction:OverrideButtonConfiguration', overrideButtonConfiguration_buttonAction - Action triggered by the button.

PublicEndpoint

data PublicEndpoint Source #

Specifies the properties and attributes of an endpoint that's associated with an event.

See: newPublicEndpoint smart constructor.

Constructors

PublicEndpoint' 

Fields

  • requestId :: Maybe Text

    A unique identifier that's generated each time the endpoint is updated.

  • metrics :: Maybe (HashMap Text Double)

    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

  • location :: Maybe EndpointLocation

    The geographic information for the endpoint.

  • demographic :: Maybe EndpointDemographic

    The demographic information for the endpoint, such as the time zone and platform.

  • address :: Maybe Text

    The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

  • effectiveDate :: Maybe Text

    The date and time, in ISO 8601 format, when the endpoint was last updated.

  • user :: Maybe EndpointUser

    One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

  • attributes :: Maybe (HashMap Text [Text])

    One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.

  • endpointStatus :: Maybe Text

    Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

  • optOut :: Maybe Text

    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

  • channelType :: Maybe ChannelType

    The channel that's used when sending messages or push notifications to the endpoint.

Instances

Instances details
Eq PublicEndpoint Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PublicEndpoint

Read PublicEndpoint Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PublicEndpoint

Show PublicEndpoint Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PublicEndpoint

Generic PublicEndpoint Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PublicEndpoint

Associated Types

type Rep PublicEndpoint :: Type -> Type #

NFData PublicEndpoint Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PublicEndpoint

Methods

rnf :: PublicEndpoint -> () #

Hashable PublicEndpoint Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PublicEndpoint

ToJSON PublicEndpoint Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PublicEndpoint

type Rep PublicEndpoint Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PublicEndpoint

type Rep PublicEndpoint = D1 ('MetaData "PublicEndpoint" "Amazonka.Pinpoint.Types.PublicEndpoint" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "PublicEndpoint'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Double)))) :*: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointLocation)) :*: (S1 ('MetaSel ('Just "demographic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointDemographic)) :*: S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "effectiveDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointUser)) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))))) :*: (S1 ('MetaSel ('Just "endpointStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "optOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "channelType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelType)))))))

newPublicEndpoint :: PublicEndpoint Source #

Create a value of PublicEndpoint 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:requestId:PublicEndpoint', publicEndpoint_requestId - A unique identifier that's generated each time the endpoint is updated.

$sel:metrics:PublicEndpoint', publicEndpoint_metrics - One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

$sel:location:PublicEndpoint', publicEndpoint_location - The geographic information for the endpoint.

$sel:demographic:PublicEndpoint', publicEndpoint_demographic - The demographic information for the endpoint, such as the time zone and platform.

$sel:address:PublicEndpoint', publicEndpoint_address - The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

$sel:effectiveDate:PublicEndpoint', publicEndpoint_effectiveDate - The date and time, in ISO 8601 format, when the endpoint was last updated.

$sel:user:PublicEndpoint', publicEndpoint_user - One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

$sel:attributes:PublicEndpoint', publicEndpoint_attributes - One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.

$sel:endpointStatus:PublicEndpoint', publicEndpoint_endpointStatus - Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

$sel:optOut:PublicEndpoint', publicEndpoint_optOut - Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

$sel:channelType:PublicEndpoint', publicEndpoint_channelType - The channel that's used when sending messages or push notifications to the endpoint.

publicEndpoint_requestId :: Lens' PublicEndpoint (Maybe Text) Source #

A unique identifier that's generated each time the endpoint is updated.

publicEndpoint_metrics :: Lens' PublicEndpoint (Maybe (HashMap Text Double)) Source #

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

publicEndpoint_location :: Lens' PublicEndpoint (Maybe EndpointLocation) Source #

The geographic information for the endpoint.

publicEndpoint_demographic :: Lens' PublicEndpoint (Maybe EndpointDemographic) Source #

The demographic information for the endpoint, such as the time zone and platform.

publicEndpoint_address :: Lens' PublicEndpoint (Maybe Text) Source #

The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

publicEndpoint_effectiveDate :: Lens' PublicEndpoint (Maybe Text) Source #

The date and time, in ISO 8601 format, when the endpoint was last updated.

publicEndpoint_user :: Lens' PublicEndpoint (Maybe EndpointUser) Source #

One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

publicEndpoint_attributes :: Lens' PublicEndpoint (Maybe (HashMap Text [Text])) Source #

One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.

publicEndpoint_endpointStatus :: Lens' PublicEndpoint (Maybe Text) Source #

Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

publicEndpoint_optOut :: Lens' PublicEndpoint (Maybe Text) Source #

Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

publicEndpoint_channelType :: Lens' PublicEndpoint (Maybe ChannelType) Source #

The channel that's used when sending messages or push notifications to the endpoint.

PushMessageActivity

data PushMessageActivity Source #

Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants.

See: newPushMessageActivity smart constructor.

Constructors

PushMessageActivity' 

Fields

  • templateName :: Maybe Text

    The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.

  • templateVersion :: Maybe Text

    The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

  • nextActivity :: Maybe Text

    The unique identifier for the next activity to perform, after the message is sent.

  • messageConfig :: Maybe JourneyPushMessage

    Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.

Instances

Instances details
Eq PushMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

Read PushMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

Show PushMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

Generic PushMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

Associated Types

type Rep PushMessageActivity :: Type -> Type #

NFData PushMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

Methods

rnf :: PushMessageActivity -> () #

Hashable PushMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

ToJSON PushMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

FromJSON PushMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

type Rep PushMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

type Rep PushMessageActivity = D1 ('MetaData "PushMessageActivity" "Amazonka.Pinpoint.Types.PushMessageActivity" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "PushMessageActivity'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "nextActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "messageConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JourneyPushMessage)))))

newPushMessageActivity :: PushMessageActivity Source #

Create a value of PushMessageActivity 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:templateName:PushMessageActivity', pushMessageActivity_templateName - The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.

$sel:templateVersion:PushMessageActivity', pushMessageActivity_templateVersion - The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

$sel:nextActivity:PushMessageActivity', pushMessageActivity_nextActivity - The unique identifier for the next activity to perform, after the message is sent.

$sel:messageConfig:PushMessageActivity', pushMessageActivity_messageConfig - Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.

pushMessageActivity_templateName :: Lens' PushMessageActivity (Maybe Text) Source #

The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.

pushMessageActivity_templateVersion :: Lens' PushMessageActivity (Maybe Text) Source #

The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

pushMessageActivity_nextActivity :: Lens' PushMessageActivity (Maybe Text) Source #

The unique identifier for the next activity to perform, after the message is sent.

pushMessageActivity_messageConfig :: Lens' PushMessageActivity (Maybe JourneyPushMessage) Source #

Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.

PushNotificationTemplateRequest

data PushNotificationTemplateRequest Source #

Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.

See: newPushNotificationTemplateRequest smart constructor.

Constructors

PushNotificationTemplateRequest' 

Fields

  • default' :: Maybe DefaultPushNotificationTemplate

    The default message template to use for push notification channels.

  • templateDescription :: Maybe Text

    A custom description of the message template.

  • gcm :: Maybe AndroidPushNotificationTemplate

    The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

  • apns :: Maybe APNSPushNotificationTemplate

    The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

  • defaultSubstitutions :: Maybe Text

    A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

  • adm :: Maybe AndroidPushNotificationTemplate

    The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

  • baidu :: Maybe AndroidPushNotificationTemplate

    The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

  • recommenderId :: Maybe Text

    The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

  • tags :: Maybe (HashMap Text Text)

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

Instances

Instances details
Eq PushNotificationTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateRequest

Read PushNotificationTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateRequest

Show PushNotificationTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateRequest

Generic PushNotificationTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateRequest

Associated Types

type Rep PushNotificationTemplateRequest :: Type -> Type #

NFData PushNotificationTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateRequest

Hashable PushNotificationTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateRequest

ToJSON PushNotificationTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateRequest

type Rep PushNotificationTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateRequest

newPushNotificationTemplateRequest :: PushNotificationTemplateRequest Source #

Create a value of PushNotificationTemplateRequest 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:default':PushNotificationTemplateRequest', pushNotificationTemplateRequest_default - The default message template to use for push notification channels.

$sel:templateDescription:PushNotificationTemplateRequest', pushNotificationTemplateRequest_templateDescription - A custom description of the message template.

$sel:gcm:PushNotificationTemplateRequest', pushNotificationTemplateRequest_gcm - The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

$sel:apns:PushNotificationTemplateRequest', pushNotificationTemplateRequest_apns - The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

$sel:defaultSubstitutions:PushNotificationTemplateRequest', pushNotificationTemplateRequest_defaultSubstitutions - A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

$sel:adm:PushNotificationTemplateRequest', pushNotificationTemplateRequest_adm - The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

$sel:baidu:PushNotificationTemplateRequest', pushNotificationTemplateRequest_baidu - The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

$sel:recommenderId:PushNotificationTemplateRequest', pushNotificationTemplateRequest_recommenderId - The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

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

pushNotificationTemplateRequest_gcm :: Lens' PushNotificationTemplateRequest (Maybe AndroidPushNotificationTemplate) Source #

The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateRequest_apns :: Lens' PushNotificationTemplateRequest (Maybe APNSPushNotificationTemplate) Source #

The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateRequest_defaultSubstitutions :: Lens' PushNotificationTemplateRequest (Maybe Text) Source #

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

pushNotificationTemplateRequest_adm :: Lens' PushNotificationTemplateRequest (Maybe AndroidPushNotificationTemplate) Source #

The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateRequest_baidu :: Lens' PushNotificationTemplateRequest (Maybe AndroidPushNotificationTemplate) Source #

The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateRequest_recommenderId :: Lens' PushNotificationTemplateRequest (Maybe Text) Source #

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

pushNotificationTemplateRequest_tags :: Lens' PushNotificationTemplateRequest (Maybe (HashMap Text Text)) Source #

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

PushNotificationTemplateResponse

data PushNotificationTemplateResponse Source #

Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.

See: newPushNotificationTemplateResponse smart constructor.

Constructors

PushNotificationTemplateResponse' 

Fields

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the message template.

  • default' :: Maybe DefaultPushNotificationTemplate

    The default message template that's used for push notification channels.

  • templateDescription :: Maybe Text

    The custom description of the message template.

  • gcm :: Maybe AndroidPushNotificationTemplate

    The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

  • apns :: Maybe APNSPushNotificationTemplate

    The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

  • defaultSubstitutions :: Maybe Text

    The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

  • version :: Maybe Text

    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

  • adm :: Maybe AndroidPushNotificationTemplate

    The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

  • baidu :: Maybe AndroidPushNotificationTemplate

    The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

  • recommenderId :: Maybe Text

    The unique identifier for the recommender model that's used by the message template.

  • tags :: Maybe (HashMap Text Text)

    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

  • lastModifiedDate :: Text

    The date, in ISO 8601 format, when the message template was last modified.

  • creationDate :: Text

    The date, in ISO 8601 format, when the message template was created.

  • templateType :: TemplateType

    The type of channel that the message template is designed for. For a push notification template, this value is PUSH.

  • templateName :: Text

    The name of the message template.

Instances

Instances details
Eq PushNotificationTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateResponse

Read PushNotificationTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateResponse

Show PushNotificationTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateResponse

Generic PushNotificationTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateResponse

Associated Types

type Rep PushNotificationTemplateResponse :: Type -> Type #

NFData PushNotificationTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateResponse

Hashable PushNotificationTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateResponse

FromJSON PushNotificationTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateResponse

type Rep PushNotificationTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.PushNotificationTemplateResponse

type Rep PushNotificationTemplateResponse = D1 ('MetaData "PushNotificationTemplateResponse" "Amazonka.Pinpoint.Types.PushNotificationTemplateResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "PushNotificationTemplateResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "default'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DefaultPushNotificationTemplate)) :*: S1 ('MetaSel ('Just "templateDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "gcm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AndroidPushNotificationTemplate)) :*: S1 ('MetaSel ('Just "apns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe APNSPushNotificationTemplate))) :*: (S1 ('MetaSel ('Just "defaultSubstitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "adm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AndroidPushNotificationTemplate)) :*: S1 ('MetaSel ('Just "baidu") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AndroidPushNotificationTemplate))) :*: (S1 ('MetaSel ('Just "recommenderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: ((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "templateType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TemplateType) :*: S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newPushNotificationTemplateResponse Source #

Create a value of PushNotificationTemplateResponse 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:arn:PushNotificationTemplateResponse', pushNotificationTemplateResponse_arn - The Amazon Resource Name (ARN) of the message template.

$sel:default':PushNotificationTemplateResponse', pushNotificationTemplateResponse_default - The default message template that's used for push notification channels.

$sel:templateDescription:PushNotificationTemplateResponse', pushNotificationTemplateResponse_templateDescription - The custom description of the message template.

$sel:gcm:PushNotificationTemplateResponse', pushNotificationTemplateResponse_gcm - The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

$sel:apns:PushNotificationTemplateResponse', pushNotificationTemplateResponse_apns - The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

$sel:defaultSubstitutions:PushNotificationTemplateResponse', pushNotificationTemplateResponse_defaultSubstitutions - The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

$sel:version:PushNotificationTemplateResponse', pushNotificationTemplateResponse_version - The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

$sel:adm:PushNotificationTemplateResponse', pushNotificationTemplateResponse_adm - The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

$sel:baidu:PushNotificationTemplateResponse', pushNotificationTemplateResponse_baidu - The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

$sel:recommenderId:PushNotificationTemplateResponse', pushNotificationTemplateResponse_recommenderId - The unique identifier for the recommender model that's used by the message template.

$sel:tags:PushNotificationTemplateResponse', pushNotificationTemplateResponse_tags - A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

$sel:lastModifiedDate:PushNotificationTemplateResponse', pushNotificationTemplateResponse_lastModifiedDate - The date, in ISO 8601 format, when the message template was last modified.

$sel:creationDate:PushNotificationTemplateResponse', pushNotificationTemplateResponse_creationDate - The date, in ISO 8601 format, when the message template was created.

$sel:templateType:PushNotificationTemplateResponse', pushNotificationTemplateResponse_templateType - The type of channel that the message template is designed for. For a push notification template, this value is PUSH.

$sel:templateName:PushNotificationTemplateResponse', pushNotificationTemplateResponse_templateName - The name of the message template.

pushNotificationTemplateResponse_arn :: Lens' PushNotificationTemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the message template.

pushNotificationTemplateResponse_default :: Lens' PushNotificationTemplateResponse (Maybe DefaultPushNotificationTemplate) Source #

The default message template that's used for push notification channels.

pushNotificationTemplateResponse_gcm :: Lens' PushNotificationTemplateResponse (Maybe AndroidPushNotificationTemplate) Source #

The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateResponse_apns :: Lens' PushNotificationTemplateResponse (Maybe APNSPushNotificationTemplate) Source #

The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateResponse_defaultSubstitutions :: Lens' PushNotificationTemplateResponse (Maybe Text) Source #

The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

pushNotificationTemplateResponse_version :: Lens' PushNotificationTemplateResponse (Maybe Text) Source #

The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

pushNotificationTemplateResponse_adm :: Lens' PushNotificationTemplateResponse (Maybe AndroidPushNotificationTemplate) Source #

The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateResponse_baidu :: Lens' PushNotificationTemplateResponse (Maybe AndroidPushNotificationTemplate) Source #

The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

pushNotificationTemplateResponse_recommenderId :: Lens' PushNotificationTemplateResponse (Maybe Text) Source #

The unique identifier for the recommender model that's used by the message template.

pushNotificationTemplateResponse_tags :: Lens' PushNotificationTemplateResponse (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

pushNotificationTemplateResponse_lastModifiedDate :: Lens' PushNotificationTemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was last modified.

pushNotificationTemplateResponse_creationDate :: Lens' PushNotificationTemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was created.

pushNotificationTemplateResponse_templateType :: Lens' PushNotificationTemplateResponse TemplateType Source #

The type of channel that the message template is designed for. For a push notification template, this value is PUSH.

QuietTime

data QuietTime Source #

Specifies the start and end times that define a time range when messages aren't sent to endpoints.

See: newQuietTime smart constructor.

Constructors

QuietTime' 

Fields

  • start :: Maybe Text

    The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

  • end :: Maybe Text

    The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

Instances

Instances details
Eq QuietTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.QuietTime

Read QuietTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.QuietTime

Show QuietTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.QuietTime

Generic QuietTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.QuietTime

Associated Types

type Rep QuietTime :: Type -> Type #

NFData QuietTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.QuietTime

Methods

rnf :: QuietTime -> () #

Hashable QuietTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.QuietTime

ToJSON QuietTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.QuietTime

FromJSON QuietTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.QuietTime

type Rep QuietTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.QuietTime

type Rep QuietTime = D1 ('MetaData "QuietTime" "Amazonka.Pinpoint.Types.QuietTime" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "QuietTime'" 'PrefixI 'True) (S1 ('MetaSel ('Just "start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "end") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newQuietTime :: QuietTime Source #

Create a value of QuietTime 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:start:QuietTime', quietTime_start - The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

$sel:end:QuietTime', quietTime_end - The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

quietTime_start :: Lens' QuietTime (Maybe Text) Source #

The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

quietTime_end :: Lens' QuietTime (Maybe Text) Source #

The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

RandomSplitActivity

data RandomSplitActivity Source #

Specifies the settings for a random split activity in a journey. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

See: newRandomSplitActivity smart constructor.

Constructors

RandomSplitActivity' 

Fields

  • branches :: Maybe [RandomSplitEntry]

    The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.

Instances

Instances details
Eq RandomSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitActivity

Read RandomSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitActivity

Show RandomSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitActivity

Generic RandomSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitActivity

Associated Types

type Rep RandomSplitActivity :: Type -> Type #

NFData RandomSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitActivity

Methods

rnf :: RandomSplitActivity -> () #

Hashable RandomSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitActivity

ToJSON RandomSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitActivity

FromJSON RandomSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitActivity

type Rep RandomSplitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitActivity

type Rep RandomSplitActivity = D1 ('MetaData "RandomSplitActivity" "Amazonka.Pinpoint.Types.RandomSplitActivity" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "RandomSplitActivity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "branches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RandomSplitEntry]))))

newRandomSplitActivity :: RandomSplitActivity Source #

Create a value of RandomSplitActivity 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:branches:RandomSplitActivity', randomSplitActivity_branches - The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.

randomSplitActivity_branches :: Lens' RandomSplitActivity (Maybe [RandomSplitEntry]) Source #

The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.

RandomSplitEntry

data RandomSplitEntry Source #

Specifies the settings for a path in a random split activity in a journey.

See: newRandomSplitEntry smart constructor.

Constructors

RandomSplitEntry' 

Fields

  • nextActivity :: Maybe Text

    The unique identifier for the next activity to perform, after completing the activity for the path.

  • percentage :: Maybe Int

    The percentage of participants to send down the activity path.

    To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.

Instances

Instances details
Eq RandomSplitEntry Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitEntry

Read RandomSplitEntry Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitEntry

Show RandomSplitEntry Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitEntry

Generic RandomSplitEntry Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitEntry

Associated Types

type Rep RandomSplitEntry :: Type -> Type #

NFData RandomSplitEntry Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitEntry

Methods

rnf :: RandomSplitEntry -> () #

Hashable RandomSplitEntry Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitEntry

ToJSON RandomSplitEntry Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitEntry

FromJSON RandomSplitEntry Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitEntry

type Rep RandomSplitEntry Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RandomSplitEntry

type Rep RandomSplitEntry = D1 ('MetaData "RandomSplitEntry" "Amazonka.Pinpoint.Types.RandomSplitEntry" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "RandomSplitEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "percentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

newRandomSplitEntry :: RandomSplitEntry Source #

Create a value of RandomSplitEntry 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:nextActivity:RandomSplitEntry', randomSplitEntry_nextActivity - The unique identifier for the next activity to perform, after completing the activity for the path.

$sel:percentage:RandomSplitEntry', randomSplitEntry_percentage - The percentage of participants to send down the activity path.

To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.

randomSplitEntry_nextActivity :: Lens' RandomSplitEntry (Maybe Text) Source #

The unique identifier for the next activity to perform, after completing the activity for the path.

randomSplitEntry_percentage :: Lens' RandomSplitEntry (Maybe Int) Source #

The percentage of participants to send down the activity path.

To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.

RawEmail

data RawEmail Source #

Specifies the contents of an email message, represented as a raw MIME message.

See: newRawEmail smart constructor.

Constructors

RawEmail' 

Fields

  • data' :: Maybe Base64

    The email message, represented as a raw MIME message. The entire message must be base64 encoded.

Instances

Instances details
Eq RawEmail Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RawEmail

Read RawEmail Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RawEmail

Show RawEmail Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RawEmail

Generic RawEmail Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RawEmail

Associated Types

type Rep RawEmail :: Type -> Type #

Methods

from :: RawEmail -> Rep RawEmail x #

to :: Rep RawEmail x -> RawEmail #

NFData RawEmail Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RawEmail

Methods

rnf :: RawEmail -> () #

Hashable RawEmail Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RawEmail

Methods

hashWithSalt :: Int -> RawEmail -> Int #

hash :: RawEmail -> Int #

ToJSON RawEmail Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RawEmail

type Rep RawEmail Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RawEmail

type Rep RawEmail = D1 ('MetaData "RawEmail" "Amazonka.Pinpoint.Types.RawEmail" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "RawEmail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64))))

newRawEmail :: RawEmail Source #

Create a value of RawEmail 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:data':RawEmail', rawEmail_data - The email message, represented as a raw MIME message. The entire message must be base64 encoded.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

rawEmail_data :: Lens' RawEmail (Maybe ByteString) Source #

The email message, represented as a raw MIME message. The entire message must be base64 encoded.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

RecencyDimension

data RecencyDimension Source #

Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active.

See: newRecencyDimension smart constructor.

Constructors

RecencyDimension' 

Fields

  • duration :: Duration

    The duration to use when determining whether an endpoint is active or inactive.

  • recencyType :: RecencyType

    The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

Instances

Instances details
Eq RecencyDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyDimension

Read RecencyDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyDimension

Show RecencyDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyDimension

Generic RecencyDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyDimension

Associated Types

type Rep RecencyDimension :: Type -> Type #

NFData RecencyDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyDimension

Methods

rnf :: RecencyDimension -> () #

Hashable RecencyDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyDimension

ToJSON RecencyDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyDimension

FromJSON RecencyDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyDimension

type Rep RecencyDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecencyDimension

type Rep RecencyDimension = D1 ('MetaData "RecencyDimension" "Amazonka.Pinpoint.Types.RecencyDimension" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "RecencyDimension'" 'PrefixI 'True) (S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Duration) :*: S1 ('MetaSel ('Just "recencyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RecencyType)))

newRecencyDimension Source #

Create a value of RecencyDimension 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:duration:RecencyDimension', recencyDimension_duration - The duration to use when determining whether an endpoint is active or inactive.

$sel:recencyType:RecencyDimension', recencyDimension_recencyType - The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

recencyDimension_duration :: Lens' RecencyDimension Duration Source #

The duration to use when determining whether an endpoint is active or inactive.

recencyDimension_recencyType :: Lens' RecencyDimension RecencyType Source #

The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

RecommenderConfigurationResponse

data RecommenderConfigurationResponse Source #

Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.

See: newRecommenderConfigurationResponse smart constructor.

Constructors

RecommenderConfigurationResponse' 

Fields

  • recommendationTransformerUri :: Maybe Text

    The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.

  • recommendationsDisplayName :: Maybe Text

    The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.

    This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

  • recommendationProviderIdType :: Maybe Text

    The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:

    • PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
    • PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
  • attributes :: Maybe (HashMap Text Text)

    A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

    This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

  • name :: Maybe Text

    The custom name of the configuration for the recommender model.

  • description :: Maybe Text

    The custom description of the configuration for the recommender model.

  • recommendationsPerMessage :: Maybe Int

    The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.

  • recommendationProviderUri :: Text

    The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.

  • lastModifiedDate :: Text

    The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.

  • creationDate :: Text

    The date, in extended ISO 8601 format, when the configuration was created for the recommender model.

  • recommendationProviderRoleArn :: Text

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

  • id :: Text

    The unique identifier for the recommender model configuration.

Instances

Instances details
Eq RecommenderConfigurationResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecommenderConfigurationResponse

Read RecommenderConfigurationResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecommenderConfigurationResponse

Show RecommenderConfigurationResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecommenderConfigurationResponse

Generic RecommenderConfigurationResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecommenderConfigurationResponse

Associated Types

type Rep RecommenderConfigurationResponse :: Type -> Type #

NFData RecommenderConfigurationResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecommenderConfigurationResponse

Hashable RecommenderConfigurationResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecommenderConfigurationResponse

FromJSON RecommenderConfigurationResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecommenderConfigurationResponse

type Rep RecommenderConfigurationResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.RecommenderConfigurationResponse

type Rep RecommenderConfigurationResponse = D1 ('MetaData "RecommenderConfigurationResponse" "Amazonka.Pinpoint.Types.RecommenderConfigurationResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "RecommenderConfigurationResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "recommendationTransformerUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "recommendationsDisplayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "recommendationProviderIdType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "recommendationsPerMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "recommendationProviderUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "recommendationProviderRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newRecommenderConfigurationResponse Source #

Create a value of RecommenderConfigurationResponse 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:recommendationTransformerUri:RecommenderConfigurationResponse', recommenderConfigurationResponse_recommendationTransformerUri - The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.

$sel:recommendationsDisplayName:RecommenderConfigurationResponse', recommenderConfigurationResponse_recommendationsDisplayName - The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.

This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

$sel:recommendationProviderIdType:RecommenderConfigurationResponse', recommenderConfigurationResponse_recommendationProviderIdType - The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:

  • PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
  • PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

$sel:attributes:RecommenderConfigurationResponse', recommenderConfigurationResponse_attributes - A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

$sel:name:RecommenderConfigurationResponse', recommenderConfigurationResponse_name - The custom name of the configuration for the recommender model.

$sel:description:RecommenderConfigurationResponse', recommenderConfigurationResponse_description - The custom description of the configuration for the recommender model.

$sel:recommendationsPerMessage:RecommenderConfigurationResponse', recommenderConfigurationResponse_recommendationsPerMessage - The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.

$sel:recommendationProviderUri:RecommenderConfigurationResponse', recommenderConfigurationResponse_recommendationProviderUri - The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.

$sel:lastModifiedDate:RecommenderConfigurationResponse', recommenderConfigurationResponse_lastModifiedDate - The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.

$sel:creationDate:RecommenderConfigurationResponse', recommenderConfigurationResponse_creationDate - The date, in extended ISO 8601 format, when the configuration was created for the recommender model.

$sel:recommendationProviderRoleArn:RecommenderConfigurationResponse', recommenderConfigurationResponse_recommendationProviderRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

$sel:id:RecommenderConfigurationResponse', recommenderConfigurationResponse_id - The unique identifier for the recommender model configuration.

recommenderConfigurationResponse_recommendationTransformerUri :: Lens' RecommenderConfigurationResponse (Maybe Text) Source #

The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.

recommenderConfigurationResponse_recommendationsDisplayName :: Lens' RecommenderConfigurationResponse (Maybe Text) Source #

The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.

This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

recommenderConfigurationResponse_recommendationProviderIdType :: Lens' RecommenderConfigurationResponse (Maybe Text) Source #

The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:

  • PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
  • PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

recommenderConfigurationResponse_attributes :: Lens' RecommenderConfigurationResponse (Maybe (HashMap Text Text)) Source #

A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

recommenderConfigurationResponse_name :: Lens' RecommenderConfigurationResponse (Maybe Text) Source #

The custom name of the configuration for the recommender model.

recommenderConfigurationResponse_description :: Lens' RecommenderConfigurationResponse (Maybe Text) Source #

The custom description of the configuration for the recommender model.

recommenderConfigurationResponse_recommendationsPerMessage :: Lens' RecommenderConfigurationResponse (Maybe Int) Source #

The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.

recommenderConfigurationResponse_recommendationProviderUri :: Lens' RecommenderConfigurationResponse Text Source #

The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.

recommenderConfigurationResponse_lastModifiedDate :: Lens' RecommenderConfigurationResponse Text Source #

The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.

recommenderConfigurationResponse_creationDate :: Lens' RecommenderConfigurationResponse Text Source #

The date, in extended ISO 8601 format, when the configuration was created for the recommender model.

recommenderConfigurationResponse_recommendationProviderRoleArn :: Lens' RecommenderConfigurationResponse Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

recommenderConfigurationResponse_id :: Lens' RecommenderConfigurationResponse Text Source #

The unique identifier for the recommender model configuration.

ResultRow

data ResultRow Source #

Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

See: newResultRow smart constructor.

Constructors

ResultRow' 

Fields

  • groupedBys :: [ResultRowValue]

    An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.

  • values :: [ResultRowValue]

    An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.

Instances

Instances details
Eq ResultRow Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ResultRow

Read ResultRow Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ResultRow

Show ResultRow Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ResultRow

Generic ResultRow Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ResultRow

Associated Types

type Rep ResultRow :: Type -> Type #

NFData ResultRow Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ResultRow

Methods

rnf :: ResultRow -> () #

Hashable ResultRow Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ResultRow

FromJSON ResultRow Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ResultRow

type Rep ResultRow Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ResultRow

type Rep ResultRow = D1 ('MetaData "ResultRow" "Amazonka.Pinpoint.Types.ResultRow" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ResultRow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupedBys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ResultRowValue]) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ResultRowValue])))

newResultRow :: ResultRow Source #

Create a value of ResultRow 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:groupedBys:ResultRow', resultRow_groupedBys - An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.

$sel:values:ResultRow', resultRow_values - An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.

resultRow_groupedBys :: Lens' ResultRow [ResultRowValue] Source #

An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.

resultRow_values :: Lens' ResultRow [ResultRowValue] Source #

An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.

ResultRowValue

data ResultRowValue Source #

Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.

See: newResultRowValue smart constructor.

Constructors

ResultRowValue' 

Fields

  • type' :: Text

    The data type of the value specified by the Value property.

  • value :: Text

    In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).

  • key :: Text

    The friendly name of the metric whose value is specified by the Value property.

Instances

Instances details
Eq ResultRowValue Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ResultRowValue

Read ResultRowValue Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ResultRowValue

Show ResultRowValue Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ResultRowValue

Generic ResultRowValue Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ResultRowValue

Associated Types

type Rep ResultRowValue :: Type -> Type #

NFData ResultRowValue Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ResultRowValue

Methods

rnf :: ResultRowValue -> () #

Hashable ResultRowValue Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ResultRowValue

FromJSON ResultRowValue Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ResultRowValue

type Rep ResultRowValue Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ResultRowValue

type Rep ResultRowValue = D1 ('MetaData "ResultRowValue" "Amazonka.Pinpoint.Types.ResultRowValue" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ResultRowValue'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newResultRowValue Source #

Create a value of ResultRowValue 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:type':ResultRowValue', resultRowValue_type - The data type of the value specified by the Value property.

$sel:value:ResultRowValue', resultRowValue_value - In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).

$sel:key:ResultRowValue', resultRowValue_key - The friendly name of the metric whose value is specified by the Value property.

resultRowValue_type :: Lens' ResultRowValue Text Source #

The data type of the value specified by the Value property.

resultRowValue_value :: Lens' ResultRowValue Text Source #

In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).

resultRowValue_key :: Lens' ResultRowValue Text Source #

The friendly name of the metric whose value is specified by the Value property.

SMSChannelRequest

data SMSChannelRequest Source #

Specifies the status and settings of the SMS channel for an application.

See: newSMSChannelRequest smart constructor.

Constructors

SMSChannelRequest' 

Fields

  • shortCode :: Maybe Text

    The registered short code that you want to use when you send messages through the SMS channel.

  • enabled :: Maybe Bool

    Specifies whether to enable the SMS channel for the application.

  • senderId :: Maybe Text

    The identity that you want to display on recipients' devices when they receive messages from the SMS channel.

Instances

Instances details
Eq SMSChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSChannelRequest

Read SMSChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSChannelRequest

Show SMSChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSChannelRequest

Generic SMSChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSChannelRequest

Associated Types

type Rep SMSChannelRequest :: Type -> Type #

NFData SMSChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSChannelRequest

Methods

rnf :: SMSChannelRequest -> () #

Hashable SMSChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSChannelRequest

ToJSON SMSChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSChannelRequest

type Rep SMSChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSChannelRequest

type Rep SMSChannelRequest = D1 ('MetaData "SMSChannelRequest" "Amazonka.Pinpoint.Types.SMSChannelRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SMSChannelRequest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "shortCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "senderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newSMSChannelRequest :: SMSChannelRequest Source #

Create a value of SMSChannelRequest 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:shortCode:SMSChannelRequest', sMSChannelRequest_shortCode - The registered short code that you want to use when you send messages through the SMS channel.

$sel:enabled:SMSChannelRequest', sMSChannelRequest_enabled - Specifies whether to enable the SMS channel for the application.

$sel:senderId:SMSChannelRequest', sMSChannelRequest_senderId - The identity that you want to display on recipients' devices when they receive messages from the SMS channel.

sMSChannelRequest_shortCode :: Lens' SMSChannelRequest (Maybe Text) Source #

The registered short code that you want to use when you send messages through the SMS channel.

sMSChannelRequest_enabled :: Lens' SMSChannelRequest (Maybe Bool) Source #

Specifies whether to enable the SMS channel for the application.

sMSChannelRequest_senderId :: Lens' SMSChannelRequest (Maybe Text) Source #

The identity that you want to display on recipients' devices when they receive messages from the SMS channel.

SMSChannelResponse

data SMSChannelResponse Source #

Provides information about the status and settings of the SMS channel for an application.

See: newSMSChannelResponse smart constructor.

Constructors

SMSChannelResponse' 

Fields

Instances

Instances details
Eq SMSChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSChannelResponse

Read SMSChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSChannelResponse

Show SMSChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSChannelResponse

Generic SMSChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSChannelResponse

Associated Types

type Rep SMSChannelResponse :: Type -> Type #

NFData SMSChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSChannelResponse

Methods

rnf :: SMSChannelResponse -> () #

Hashable SMSChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSChannelResponse

FromJSON SMSChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSChannelResponse

type Rep SMSChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSChannelResponse

type Rep SMSChannelResponse = D1 ('MetaData "SMSChannelResponse" "Amazonka.Pinpoint.Types.SMSChannelResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SMSChannelResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "shortCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "senderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "transactionalMessagesPerSecond") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "promotionalMessagesPerSecond") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "isArchived") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "hasCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newSMSChannelResponse Source #

Create a value of SMSChannelResponse 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:shortCode:SMSChannelResponse', sMSChannelResponse_shortCode - The registered short code to use when you send messages through the SMS channel.

$sel:lastModifiedDate:SMSChannelResponse', sMSChannelResponse_lastModifiedDate - The date and time, in ISO 8601 format, when the SMS channel was last modified.

$sel:enabled:SMSChannelResponse', sMSChannelResponse_enabled - Specifies whether the SMS channel is enabled for the application.

$sel:senderId:SMSChannelResponse', sMSChannelResponse_senderId - The identity that displays on recipients' devices when they receive messages from the SMS channel.

$sel:transactionalMessagesPerSecond:SMSChannelResponse', sMSChannelResponse_transactionalMessagesPerSecond - The maximum number of transactional messages that you can send through the SMS channel each second.

$sel:promotionalMessagesPerSecond:SMSChannelResponse', sMSChannelResponse_promotionalMessagesPerSecond - The maximum number of promotional messages that you can send through the SMS channel each second.

$sel:isArchived:SMSChannelResponse', sMSChannelResponse_isArchived - Specifies whether the SMS channel is archived.

$sel:applicationId:SMSChannelResponse', sMSChannelResponse_applicationId - The unique identifier for the application that the SMS channel applies to.

$sel:version:SMSChannelResponse', sMSChannelResponse_version - The current version of the SMS channel.

$sel:id:SMSChannelResponse', sMSChannelResponse_id - (Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.

$sel:creationDate:SMSChannelResponse', sMSChannelResponse_creationDate - The date and time, in ISO 8601 format, when the SMS channel was enabled.

$sel:lastModifiedBy:SMSChannelResponse', sMSChannelResponse_lastModifiedBy - The user who last modified the SMS channel.

$sel:hasCredential:SMSChannelResponse', sMSChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.

$sel:platform:SMSChannelResponse', sMSChannelResponse_platform - The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

sMSChannelResponse_shortCode :: Lens' SMSChannelResponse (Maybe Text) Source #

The registered short code to use when you send messages through the SMS channel.

sMSChannelResponse_lastModifiedDate :: Lens' SMSChannelResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the SMS channel was last modified.

sMSChannelResponse_enabled :: Lens' SMSChannelResponse (Maybe Bool) Source #

Specifies whether the SMS channel is enabled for the application.

sMSChannelResponse_senderId :: Lens' SMSChannelResponse (Maybe Text) Source #

The identity that displays on recipients' devices when they receive messages from the SMS channel.

sMSChannelResponse_transactionalMessagesPerSecond :: Lens' SMSChannelResponse (Maybe Int) Source #

The maximum number of transactional messages that you can send through the SMS channel each second.

sMSChannelResponse_promotionalMessagesPerSecond :: Lens' SMSChannelResponse (Maybe Int) Source #

The maximum number of promotional messages that you can send through the SMS channel each second.

sMSChannelResponse_isArchived :: Lens' SMSChannelResponse (Maybe Bool) Source #

Specifies whether the SMS channel is archived.

sMSChannelResponse_applicationId :: Lens' SMSChannelResponse (Maybe Text) Source #

The unique identifier for the application that the SMS channel applies to.

sMSChannelResponse_version :: Lens' SMSChannelResponse (Maybe Int) Source #

The current version of the SMS channel.

sMSChannelResponse_id :: Lens' SMSChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.

sMSChannelResponse_creationDate :: Lens' SMSChannelResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the SMS channel was enabled.

sMSChannelResponse_lastModifiedBy :: Lens' SMSChannelResponse (Maybe Text) Source #

The user who last modified the SMS channel.

sMSChannelResponse_hasCredential :: Lens' SMSChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

sMSChannelResponse_platform :: Lens' SMSChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

SMSMessage

data SMSMessage Source #

Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.

See: newSMSMessage smart constructor.

Constructors

SMSMessage' 

Fields

  • substitutions :: Maybe (HashMap Text [Text])

    The message variables to use in the SMS message. You can override the default variables with individual address variables.

  • originationNumber :: Maybe Text

    The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

  • templateId :: Maybe Text

    The template ID received from the regulatory body for sending SMS in your country.

  • body :: Maybe Text

    The body of the SMS message.

  • messageType :: Maybe MessageType

    The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

  • senderId :: Maybe Text

    The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.

  • mediaUrl :: Maybe Text

    This field is reserved for future use.

  • entityId :: Maybe Text

    The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

  • keyword :: Maybe Text

    The SMS program name that you provided to AWS Support when you requested your dedicated number.

Instances

Instances details
Eq SMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessage

Read SMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessage

Show SMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessage

Generic SMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessage

Associated Types

type Rep SMSMessage :: Type -> Type #

NFData SMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessage

Methods

rnf :: SMSMessage -> () #

Hashable SMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessage

ToJSON SMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessage

type Rep SMSMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessage

newSMSMessage :: SMSMessage Source #

Create a value of SMSMessage 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:substitutions:SMSMessage', sMSMessage_substitutions - The message variables to use in the SMS message. You can override the default variables with individual address variables.

$sel:originationNumber:SMSMessage', sMSMessage_originationNumber - The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

$sel:templateId:SMSMessage', sMSMessage_templateId - The template ID received from the regulatory body for sending SMS in your country.

$sel:body:SMSMessage', sMSMessage_body - The body of the SMS message.

$sel:messageType:SMSMessage', sMSMessage_messageType - The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

$sel:senderId:SMSMessage', sMSMessage_senderId - The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.

$sel:mediaUrl:SMSMessage', sMSMessage_mediaUrl - This field is reserved for future use.

$sel:entityId:SMSMessage', sMSMessage_entityId - The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

$sel:keyword:SMSMessage', sMSMessage_keyword - The SMS program name that you provided to AWS Support when you requested your dedicated number.

sMSMessage_substitutions :: Lens' SMSMessage (Maybe (HashMap Text [Text])) Source #

The message variables to use in the SMS message. You can override the default variables with individual address variables.

sMSMessage_originationNumber :: Lens' SMSMessage (Maybe Text) Source #

The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

sMSMessage_templateId :: Lens' SMSMessage (Maybe Text) Source #

The template ID received from the regulatory body for sending SMS in your country.

sMSMessage_body :: Lens' SMSMessage (Maybe Text) Source #

The body of the SMS message.

sMSMessage_messageType :: Lens' SMSMessage (Maybe MessageType) Source #

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

sMSMessage_senderId :: Lens' SMSMessage (Maybe Text) Source #

The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.

sMSMessage_mediaUrl :: Lens' SMSMessage (Maybe Text) Source #

This field is reserved for future use.

sMSMessage_entityId :: Lens' SMSMessage (Maybe Text) Source #

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

sMSMessage_keyword :: Lens' SMSMessage (Maybe Text) Source #

The SMS program name that you provided to AWS Support when you requested your dedicated number.

SMSMessageActivity

data SMSMessageActivity Source #

Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants.

See: newSMSMessageActivity smart constructor.

Constructors

SMSMessageActivity' 

Fields

  • templateName :: Maybe Text

    The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.

  • templateVersion :: Maybe Text

    The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

  • nextActivity :: Maybe Text

    The unique identifier for the next activity to perform, after the message is sent.

  • messageConfig :: Maybe JourneySMSMessage

    Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

Instances

Instances details
Eq SMSMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessageActivity

Read SMSMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessageActivity

Show SMSMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessageActivity

Generic SMSMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessageActivity

Associated Types

type Rep SMSMessageActivity :: Type -> Type #

NFData SMSMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessageActivity

Methods

rnf :: SMSMessageActivity -> () #

Hashable SMSMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessageActivity

ToJSON SMSMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessageActivity

FromJSON SMSMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessageActivity

type Rep SMSMessageActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSMessageActivity

type Rep SMSMessageActivity = D1 ('MetaData "SMSMessageActivity" "Amazonka.Pinpoint.Types.SMSMessageActivity" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SMSMessageActivity'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "nextActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "messageConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JourneySMSMessage)))))

newSMSMessageActivity :: SMSMessageActivity Source #

Create a value of SMSMessageActivity 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:templateName:SMSMessageActivity', sMSMessageActivity_templateName - The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.

$sel:templateVersion:SMSMessageActivity', sMSMessageActivity_templateVersion - The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

$sel:nextActivity:SMSMessageActivity', sMSMessageActivity_nextActivity - The unique identifier for the next activity to perform, after the message is sent.

$sel:messageConfig:SMSMessageActivity', sMSMessageActivity_messageConfig - Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

sMSMessageActivity_templateName :: Lens' SMSMessageActivity (Maybe Text) Source #

The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.

sMSMessageActivity_templateVersion :: Lens' SMSMessageActivity (Maybe Text) Source #

The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

sMSMessageActivity_nextActivity :: Lens' SMSMessageActivity (Maybe Text) Source #

The unique identifier for the next activity to perform, after the message is sent.

sMSMessageActivity_messageConfig :: Lens' SMSMessageActivity (Maybe JourneySMSMessage) Source #

Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

SMSTemplateRequest

data SMSTemplateRequest Source #

Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

See: newSMSTemplateRequest smart constructor.

Constructors

SMSTemplateRequest' 

Fields

  • body :: Maybe Text

    The message body to use in text messages that are based on the message template.

  • templateDescription :: Maybe Text

    A custom description of the message template.

  • defaultSubstitutions :: Maybe Text

    A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

  • recommenderId :: Maybe Text

    The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

  • tags :: Maybe (HashMap Text Text)

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

Instances

Instances details
Eq SMSTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSTemplateRequest

Read SMSTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSTemplateRequest

Show SMSTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSTemplateRequest

Generic SMSTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSTemplateRequest

Associated Types

type Rep SMSTemplateRequest :: Type -> Type #

NFData SMSTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSTemplateRequest

Methods

rnf :: SMSTemplateRequest -> () #

Hashable SMSTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSTemplateRequest

ToJSON SMSTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSTemplateRequest

type Rep SMSTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSTemplateRequest

type Rep SMSTemplateRequest = D1 ('MetaData "SMSTemplateRequest" "Amazonka.Pinpoint.Types.SMSTemplateRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SMSTemplateRequest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "defaultSubstitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "recommenderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))

newSMSTemplateRequest :: SMSTemplateRequest Source #

Create a value of SMSTemplateRequest 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:body:SMSTemplateRequest', sMSTemplateRequest_body - The message body to use in text messages that are based on the message template.

$sel:templateDescription:SMSTemplateRequest', sMSTemplateRequest_templateDescription - A custom description of the message template.

$sel:defaultSubstitutions:SMSTemplateRequest', sMSTemplateRequest_defaultSubstitutions - A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

$sel:recommenderId:SMSTemplateRequest', sMSTemplateRequest_recommenderId - The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

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

sMSTemplateRequest_body :: Lens' SMSTemplateRequest (Maybe Text) Source #

The message body to use in text messages that are based on the message template.

sMSTemplateRequest_templateDescription :: Lens' SMSTemplateRequest (Maybe Text) Source #

A custom description of the message template.

sMSTemplateRequest_defaultSubstitutions :: Lens' SMSTemplateRequest (Maybe Text) Source #

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

sMSTemplateRequest_recommenderId :: Lens' SMSTemplateRequest (Maybe Text) Source #

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

sMSTemplateRequest_tags :: Lens' SMSTemplateRequest (Maybe (HashMap Text Text)) Source #

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

SMSTemplateResponse

data SMSTemplateResponse Source #

Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

See: newSMSTemplateResponse smart constructor.

Constructors

SMSTemplateResponse' 

Fields

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the message template.

  • body :: Maybe Text

    The message body that's used in text messages that are based on the message template.

  • templateDescription :: Maybe Text

    The custom description of the message template.

  • defaultSubstitutions :: Maybe Text

    The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

  • version :: Maybe Text

    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

  • recommenderId :: Maybe Text

    The unique identifier for the recommender model that's used by the message template.

  • tags :: Maybe (HashMap Text Text)

    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

  • lastModifiedDate :: Text

    The date, in ISO 8601 format, when the message template was last modified.

  • creationDate :: Text

    The date, in ISO 8601 format, when the message template was created.

  • templateName :: Text

    The name of the message template.

  • templateType :: TemplateType

    The type of channel that the message template is designed for. For an SMS template, this value is SMS.

Instances

Instances details
Eq SMSTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSTemplateResponse

Read SMSTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSTemplateResponse

Show SMSTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSTemplateResponse

Generic SMSTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSTemplateResponse

Associated Types

type Rep SMSTemplateResponse :: Type -> Type #

NFData SMSTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSTemplateResponse

Methods

rnf :: SMSTemplateResponse -> () #

Hashable SMSTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSTemplateResponse

FromJSON SMSTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSTemplateResponse

type Rep SMSTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SMSTemplateResponse

type Rep SMSTemplateResponse = D1 ('MetaData "SMSTemplateResponse" "Amazonka.Pinpoint.Types.SMSTemplateResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SMSTemplateResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "templateDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "defaultSubstitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "recommenderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "templateType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TemplateType))))))

newSMSTemplateResponse Source #

Create a value of SMSTemplateResponse 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:arn:SMSTemplateResponse', sMSTemplateResponse_arn - The Amazon Resource Name (ARN) of the message template.

$sel:body:SMSTemplateResponse', sMSTemplateResponse_body - The message body that's used in text messages that are based on the message template.

$sel:templateDescription:SMSTemplateResponse', sMSTemplateResponse_templateDescription - The custom description of the message template.

$sel:defaultSubstitutions:SMSTemplateResponse', sMSTemplateResponse_defaultSubstitutions - The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

$sel:version:SMSTemplateResponse', sMSTemplateResponse_version - The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

$sel:recommenderId:SMSTemplateResponse', sMSTemplateResponse_recommenderId - The unique identifier for the recommender model that's used by the message template.

$sel:tags:SMSTemplateResponse', sMSTemplateResponse_tags - A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

$sel:lastModifiedDate:SMSTemplateResponse', sMSTemplateResponse_lastModifiedDate - The date, in ISO 8601 format, when the message template was last modified.

$sel:creationDate:SMSTemplateResponse', sMSTemplateResponse_creationDate - The date, in ISO 8601 format, when the message template was created.

$sel:templateName:SMSTemplateResponse', sMSTemplateResponse_templateName - The name of the message template.

$sel:templateType:SMSTemplateResponse', sMSTemplateResponse_templateType - The type of channel that the message template is designed for. For an SMS template, this value is SMS.

sMSTemplateResponse_arn :: Lens' SMSTemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the message template.

sMSTemplateResponse_body :: Lens' SMSTemplateResponse (Maybe Text) Source #

The message body that's used in text messages that are based on the message template.

sMSTemplateResponse_templateDescription :: Lens' SMSTemplateResponse (Maybe Text) Source #

The custom description of the message template.

sMSTemplateResponse_defaultSubstitutions :: Lens' SMSTemplateResponse (Maybe Text) Source #

The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

sMSTemplateResponse_version :: Lens' SMSTemplateResponse (Maybe Text) Source #

The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

sMSTemplateResponse_recommenderId :: Lens' SMSTemplateResponse (Maybe Text) Source #

The unique identifier for the recommender model that's used by the message template.

sMSTemplateResponse_tags :: Lens' SMSTemplateResponse (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

sMSTemplateResponse_lastModifiedDate :: Lens' SMSTemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was last modified.

sMSTemplateResponse_creationDate :: Lens' SMSTemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was created.

sMSTemplateResponse_templateType :: Lens' SMSTemplateResponse TemplateType Source #

The type of channel that the message template is designed for. For an SMS template, this value is SMS.

Schedule

data Schedule Source #

Specifies the schedule settings for a campaign.

See: newSchedule smart constructor.

Constructors

Schedule' 

Fields

  • frequency :: Maybe Frequency

    Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

  • quietTime :: Maybe QuietTime

    The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
    • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
    • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

    If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

  • eventFilter :: Maybe CampaignEventFilter

    The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

  • isLocalTime :: Maybe Bool

    Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

  • endTime :: Maybe Text

    The scheduled time, in ISO 8601 format, when the campaign ended or will end.

  • timezone :: Maybe Text

    The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

  • startTime :: Text

    The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

Instances

Instances details
Eq Schedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Schedule

Read Schedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Schedule

Show Schedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Schedule

Generic Schedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Schedule

Associated Types

type Rep Schedule :: Type -> Type #

Methods

from :: Schedule -> Rep Schedule x #

to :: Rep Schedule x -> Schedule #

NFData Schedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Schedule

Methods

rnf :: Schedule -> () #

Hashable Schedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Schedule

Methods

hashWithSalt :: Int -> Schedule -> Int #

hash :: Schedule -> Int #

ToJSON Schedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Schedule

FromJSON Schedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Schedule

type Rep Schedule Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Schedule

newSchedule Source #

Create a value of Schedule 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:frequency:Schedule', schedule_frequency - Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

$sel:quietTime:Schedule', schedule_quietTime - The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

  • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
  • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
  • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

$sel:eventFilter:Schedule', schedule_eventFilter - The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

$sel:isLocalTime:Schedule', schedule_isLocalTime - Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

$sel:endTime:Schedule', schedule_endTime - The scheduled time, in ISO 8601 format, when the campaign ended or will end.

$sel:timezone:Schedule', schedule_timezone - The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

$sel:startTime:Schedule', schedule_startTime - The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

schedule_frequency :: Lens' Schedule (Maybe Frequency) Source #

Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

schedule_quietTime :: Lens' Schedule (Maybe QuietTime) Source #

The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

  • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
  • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
  • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

schedule_eventFilter :: Lens' Schedule (Maybe CampaignEventFilter) Source #

The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

schedule_isLocalTime :: Lens' Schedule (Maybe Bool) Source #

Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

schedule_endTime :: Lens' Schedule (Maybe Text) Source #

The scheduled time, in ISO 8601 format, when the campaign ended or will end.

schedule_timezone :: Lens' Schedule (Maybe Text) Source #

The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

schedule_startTime :: Lens' Schedule Text Source #

The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

SegmentBehaviors

data SegmentBehaviors Source #

Specifies dimension settings for including or excluding endpoints from a segment based on how recently an endpoint was active.

See: newSegmentBehaviors smart constructor.

Constructors

SegmentBehaviors' 

Fields

Instances

Instances details
Eq SegmentBehaviors Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentBehaviors

Read SegmentBehaviors Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentBehaviors

Show SegmentBehaviors Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentBehaviors

Generic SegmentBehaviors Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentBehaviors

Associated Types

type Rep SegmentBehaviors :: Type -> Type #

NFData SegmentBehaviors Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentBehaviors

Methods

rnf :: SegmentBehaviors -> () #

Hashable SegmentBehaviors Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentBehaviors

ToJSON SegmentBehaviors Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentBehaviors

FromJSON SegmentBehaviors Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentBehaviors

type Rep SegmentBehaviors Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentBehaviors

type Rep SegmentBehaviors = D1 ('MetaData "SegmentBehaviors" "Amazonka.Pinpoint.Types.SegmentBehaviors" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SegmentBehaviors'" 'PrefixI 'True) (S1 ('MetaSel ('Just "recency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecencyDimension))))

newSegmentBehaviors :: SegmentBehaviors Source #

Create a value of SegmentBehaviors 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:recency:SegmentBehaviors', segmentBehaviors_recency - The dimension settings that are based on how recently an endpoint was active.

segmentBehaviors_recency :: Lens' SegmentBehaviors (Maybe RecencyDimension) Source #

The dimension settings that are based on how recently an endpoint was active.

SegmentCondition

data SegmentCondition Source #

Specifies a segment to associate with an activity in a journey.

See: newSegmentCondition smart constructor.

Constructors

SegmentCondition' 

Fields

  • segmentId :: Text

    The unique identifier for the segment to associate with the activity.

Instances

Instances details
Eq SegmentCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentCondition

Read SegmentCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentCondition

Show SegmentCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentCondition

Generic SegmentCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentCondition

Associated Types

type Rep SegmentCondition :: Type -> Type #

NFData SegmentCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentCondition

Methods

rnf :: SegmentCondition -> () #

Hashable SegmentCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentCondition

ToJSON SegmentCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentCondition

FromJSON SegmentCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentCondition

type Rep SegmentCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentCondition

type Rep SegmentCondition = D1 ('MetaData "SegmentCondition" "Amazonka.Pinpoint.Types.SegmentCondition" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SegmentCondition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "segmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSegmentCondition Source #

Create a value of SegmentCondition 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:segmentId:SegmentCondition', segmentCondition_segmentId - The unique identifier for the segment to associate with the activity.

segmentCondition_segmentId :: Lens' SegmentCondition Text Source #

The unique identifier for the segment to associate with the activity.

SegmentDemographics

data SegmentDemographics Source #

Specifies demographic-based dimension settings for including or excluding endpoints from a segment. These settings derive from characteristics of endpoint devices, such as platform, make, and model.

See: newSegmentDemographics smart constructor.

Constructors

SegmentDemographics' 

Fields

Instances

Instances details
Eq SegmentDemographics Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDemographics

Read SegmentDemographics Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDemographics

Show SegmentDemographics Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDemographics

Generic SegmentDemographics Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDemographics

Associated Types

type Rep SegmentDemographics :: Type -> Type #

NFData SegmentDemographics Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDemographics

Methods

rnf :: SegmentDemographics -> () #

Hashable SegmentDemographics Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDemographics

ToJSON SegmentDemographics Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDemographics

FromJSON SegmentDemographics Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDemographics

type Rep SegmentDemographics Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDemographics

newSegmentDemographics :: SegmentDemographics Source #

Create a value of SegmentDemographics 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:platform:SegmentDemographics', segmentDemographics_platform - The device platform criteria for the segment.

$sel:appVersion:SegmentDemographics', segmentDemographics_appVersion - The app version criteria for the segment.

$sel:channel:SegmentDemographics', segmentDemographics_channel - The channel criteria for the segment.

$sel:model:SegmentDemographics', segmentDemographics_model - The device model criteria for the segment.

$sel:make:SegmentDemographics', segmentDemographics_make - The device make criteria for the segment.

$sel:deviceType:SegmentDemographics', segmentDemographics_deviceType - The device type criteria for the segment.

segmentDemographics_platform :: Lens' SegmentDemographics (Maybe SetDimension) Source #

The device platform criteria for the segment.

segmentDemographics_appVersion :: Lens' SegmentDemographics (Maybe SetDimension) Source #

The app version criteria for the segment.

segmentDemographics_model :: Lens' SegmentDemographics (Maybe SetDimension) Source #

The device model criteria for the segment.

segmentDemographics_make :: Lens' SegmentDemographics (Maybe SetDimension) Source #

The device make criteria for the segment.

segmentDemographics_deviceType :: Lens' SegmentDemographics (Maybe SetDimension) Source #

The device type criteria for the segment.

SegmentDimensions

data SegmentDimensions Source #

Specifies the dimension settings for a segment.

See: newSegmentDimensions smart constructor.

Constructors

SegmentDimensions' 

Fields

Instances

Instances details
Eq SegmentDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDimensions

Read SegmentDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDimensions

Show SegmentDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDimensions

Generic SegmentDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDimensions

Associated Types

type Rep SegmentDimensions :: Type -> Type #

NFData SegmentDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDimensions

Methods

rnf :: SegmentDimensions -> () #

Hashable SegmentDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDimensions

ToJSON SegmentDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDimensions

FromJSON SegmentDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDimensions

type Rep SegmentDimensions Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentDimensions

newSegmentDimensions :: SegmentDimensions Source #

Create a value of SegmentDimensions 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:metrics:SegmentDimensions', segmentDimensions_metrics - One or more custom metrics to use as criteria for the segment.

$sel:location:SegmentDimensions', segmentDimensions_location - The location-based criteria, such as region or GPS coordinates, for the segment.

$sel:demographic:SegmentDimensions', segmentDimensions_demographic - The demographic-based criteria, such as device platform, for the segment.

$sel:userAttributes:SegmentDimensions', segmentDimensions_userAttributes - One or more custom user attributes to use as criteria for the segment.

$sel:behavior:SegmentDimensions', segmentDimensions_behavior - The behavior-based criteria, such as how recently users have used your app, for the segment.

$sel:attributes:SegmentDimensions', segmentDimensions_attributes - One or more custom attributes to use as criteria for the segment.

segmentDimensions_metrics :: Lens' SegmentDimensions (Maybe (HashMap Text MetricDimension)) Source #

One or more custom metrics to use as criteria for the segment.

segmentDimensions_location :: Lens' SegmentDimensions (Maybe SegmentLocation) Source #

The location-based criteria, such as region or GPS coordinates, for the segment.

segmentDimensions_demographic :: Lens' SegmentDimensions (Maybe SegmentDemographics) Source #

The demographic-based criteria, such as device platform, for the segment.

segmentDimensions_userAttributes :: Lens' SegmentDimensions (Maybe (HashMap Text AttributeDimension)) Source #

One or more custom user attributes to use as criteria for the segment.

segmentDimensions_behavior :: Lens' SegmentDimensions (Maybe SegmentBehaviors) Source #

The behavior-based criteria, such as how recently users have used your app, for the segment.

segmentDimensions_attributes :: Lens' SegmentDimensions (Maybe (HashMap Text AttributeDimension)) Source #

One or more custom attributes to use as criteria for the segment.

SegmentGroup

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

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

  • dimensions :: Maybe [SegmentDimensions]

    An array that defines the dimensions for the segment.

Instances

Instances details
Eq SegmentGroup Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroup

Read SegmentGroup Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroup

Show SegmentGroup Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroup

Generic SegmentGroup Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroup

Associated Types

type Rep SegmentGroup :: Type -> Type #

NFData SegmentGroup Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroup

Methods

rnf :: SegmentGroup -> () #

Hashable SegmentGroup Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroup

ToJSON SegmentGroup Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroup

FromJSON SegmentGroup Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroup

type Rep SegmentGroup Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroup

type Rep SegmentGroup = D1 ('MetaData "SegmentGroup" "Amazonka.Pinpoint.Types.SegmentGroup" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SegmentGroup'" 'PrefixI 'True) ((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)) :*: S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SegmentDimensions])))))

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

$sel:dimensions:SegmentGroup', segmentGroup_dimensions - 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.

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

An array that defines the dimensions for the segment.

SegmentGroupList

data SegmentGroupList Source #

Specifies the settings that define the relationships between segment groups for a segment.

See: newSegmentGroupList smart constructor.

Constructors

SegmentGroupList' 

Fields

  • include :: Maybe Include

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

  • groups :: Maybe [SegmentGroup]

    An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

Instances

Instances details
Eq SegmentGroupList Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroupList

Read SegmentGroupList Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroupList

Show SegmentGroupList Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroupList

Generic SegmentGroupList Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroupList

Associated Types

type Rep SegmentGroupList :: Type -> Type #

NFData SegmentGroupList Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroupList

Methods

rnf :: SegmentGroupList -> () #

Hashable SegmentGroupList Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroupList

ToJSON SegmentGroupList Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroupList

FromJSON SegmentGroupList Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroupList

type Rep SegmentGroupList Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentGroupList

type Rep SegmentGroupList = D1 ('MetaData "SegmentGroupList" "Amazonka.Pinpoint.Types.SegmentGroupList" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SegmentGroupList'" 'PrefixI 'True) (S1 ('MetaSel ('Just "include") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Include)) :*: S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SegmentGroup]))))

newSegmentGroupList :: SegmentGroupList Source #

Create a value of SegmentGroupList 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:include:SegmentGroupList', segmentGroupList_include - Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

$sel:groups:SegmentGroupList', segmentGroupList_groups - An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

segmentGroupList_include :: Lens' SegmentGroupList (Maybe Include) Source #

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

segmentGroupList_groups :: Lens' SegmentGroupList (Maybe [SegmentGroup]) Source #

An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

SegmentImportResource

data SegmentImportResource Source #

Provides information about the import job that created a segment. An import job is a job that creates a user segment by importing endpoint definitions.

See: newSegmentImportResource smart constructor.

Constructors

SegmentImportResource' 

Fields

  • channelCounts :: Maybe (HashMap Text Int)

    The number of channel types in the endpoint definitions that were imported to create the segment.

  • format :: DefinitionFormat

    The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

  • s3Url :: Text

    The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.

  • size :: Int

    The number of endpoint definitions that were imported successfully to create the segment.

  • externalId :: Text

    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

  • roleArn :: Text

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

Instances

Instances details
Eq SegmentImportResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentImportResource

Read SegmentImportResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentImportResource

Show SegmentImportResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentImportResource

Generic SegmentImportResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentImportResource

Associated Types

type Rep SegmentImportResource :: Type -> Type #

NFData SegmentImportResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentImportResource

Methods

rnf :: SegmentImportResource -> () #

Hashable SegmentImportResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentImportResource

FromJSON SegmentImportResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentImportResource

type Rep SegmentImportResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentImportResource

type Rep SegmentImportResource = D1 ('MetaData "SegmentImportResource" "Amazonka.Pinpoint.Types.SegmentImportResource" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SegmentImportResource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelCounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Int))) :*: (S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DefinitionFormat) :*: S1 ('MetaSel ('Just "s3Url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSegmentImportResource Source #

Create a value of SegmentImportResource 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:channelCounts:SegmentImportResource', segmentImportResource_channelCounts - The number of channel types in the endpoint definitions that were imported to create the segment.

$sel:format:SegmentImportResource', segmentImportResource_format - The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

$sel:s3Url:SegmentImportResource', segmentImportResource_s3Url - The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.

$sel:size:SegmentImportResource', segmentImportResource_size - The number of endpoint definitions that were imported successfully to create the segment.

$sel:externalId:SegmentImportResource', segmentImportResource_externalId - (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

$sel:roleArn:SegmentImportResource', segmentImportResource_roleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

segmentImportResource_channelCounts :: Lens' SegmentImportResource (Maybe (HashMap Text Int)) Source #

The number of channel types in the endpoint definitions that were imported to create the segment.

segmentImportResource_format :: Lens' SegmentImportResource DefinitionFormat Source #

The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

segmentImportResource_s3Url :: Lens' SegmentImportResource Text Source #

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.

segmentImportResource_size :: Lens' SegmentImportResource Int Source #

The number of endpoint definitions that were imported successfully to create the segment.

segmentImportResource_externalId :: Lens' SegmentImportResource Text Source #

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

segmentImportResource_roleArn :: Lens' SegmentImportResource Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

SegmentLocation

data SegmentLocation Source #

Specifies geographical dimension settings for a segment.

See: newSegmentLocation smart constructor.

Constructors

SegmentLocation' 

Fields

Instances

Instances details
Eq SegmentLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentLocation

Read SegmentLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentLocation

Show SegmentLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentLocation

Generic SegmentLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentLocation

Associated Types

type Rep SegmentLocation :: Type -> Type #

NFData SegmentLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentLocation

Methods

rnf :: SegmentLocation -> () #

Hashable SegmentLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentLocation

ToJSON SegmentLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentLocation

FromJSON SegmentLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentLocation

type Rep SegmentLocation Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentLocation

type Rep SegmentLocation = D1 ('MetaData "SegmentLocation" "Amazonka.Pinpoint.Types.SegmentLocation" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SegmentLocation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "country") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SetDimension)) :*: S1 ('MetaSel ('Just "gPSPoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GPSPointDimension))))

newSegmentLocation :: SegmentLocation Source #

Create a value of SegmentLocation 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:country:SegmentLocation', segmentLocation_country - The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

$sel:gPSPoint:SegmentLocation', segmentLocation_gPSPoint - The GPS location and range for the segment.

segmentLocation_country :: Lens' SegmentLocation (Maybe SetDimension) Source #

The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

segmentLocation_gPSPoint :: Lens' SegmentLocation (Maybe GPSPointDimension) Source #

The GPS location and range for the segment.

SegmentReference

data SegmentReference Source #

Specifies the segment identifier and version of a segment.

See: newSegmentReference smart constructor.

Constructors

SegmentReference' 

Fields

Instances

Instances details
Eq SegmentReference Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentReference

Read SegmentReference Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentReference

Show SegmentReference Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentReference

Generic SegmentReference Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentReference

Associated Types

type Rep SegmentReference :: Type -> Type #

NFData SegmentReference Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentReference

Methods

rnf :: SegmentReference -> () #

Hashable SegmentReference Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentReference

ToJSON SegmentReference Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentReference

FromJSON SegmentReference Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentReference

type Rep SegmentReference Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentReference

type Rep SegmentReference = D1 ('MetaData "SegmentReference" "Amazonka.Pinpoint.Types.SegmentReference" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SegmentReference'" 'PrefixI 'True) (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSegmentReference Source #

Create a value of SegmentReference 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:version:SegmentReference', segmentReference_version - The version number of the segment.

$sel:id:SegmentReference', segmentReference_id - The unique identifier for the segment.

segmentReference_version :: Lens' SegmentReference (Maybe Int) Source #

The version number of the segment.

segmentReference_id :: Lens' SegmentReference Text Source #

The unique identifier for the segment.

SegmentResponse

data SegmentResponse Source #

Provides information about the configuration, dimension, and other settings for a segment.

See: newSegmentResponse smart constructor.

Constructors

SegmentResponse' 

Fields

  • lastModifiedDate :: Maybe Text

    The date and time when the segment was last modified.

  • segmentGroups :: Maybe SegmentGroupList

    A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

  • name :: Maybe Text

    The name of the segment.

  • version :: Maybe Int

    The version number of the segment.

  • importDefinition :: Maybe SegmentImportResource

    The settings for the import job that's associated with the segment.

  • dimensions :: Maybe SegmentDimensions

    The dimension settings for the segment.

  • tags :: Maybe (HashMap Text Text)

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

  • segmentType :: SegmentType

    The segment type. Valid values are:

    • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
    • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.
  • creationDate :: Text

    The date and time when the segment was created.

  • id :: Text

    The unique identifier for the segment.

  • arn :: Text

    The Amazon Resource Name (ARN) of the segment.

  • applicationId :: Text

    The unique identifier for the application that the segment is associated with.

Instances

Instances details
Eq SegmentResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentResponse

Read SegmentResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentResponse

Show SegmentResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentResponse

Generic SegmentResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentResponse

Associated Types

type Rep SegmentResponse :: Type -> Type #

NFData SegmentResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentResponse

Methods

rnf :: SegmentResponse -> () #

Hashable SegmentResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentResponse

FromJSON SegmentResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentResponse

type Rep SegmentResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentResponse

type Rep SegmentResponse = D1 ('MetaData "SegmentResponse" "Amazonka.Pinpoint.Types.SegmentResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SegmentResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "segmentGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SegmentGroupList)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "importDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SegmentImportResource)) :*: S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SegmentDimensions))))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "segmentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SegmentType) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newSegmentResponse Source #

Create a value of SegmentResponse 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:lastModifiedDate:SegmentResponse', segmentResponse_lastModifiedDate - The date and time when the segment was last modified.

$sel:segmentGroups:SegmentResponse', segmentResponse_segmentGroups - A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

$sel:name:SegmentResponse', segmentResponse_name - The name of the segment.

$sel:version:SegmentResponse', segmentResponse_version - The version number of the segment.

$sel:importDefinition:SegmentResponse', segmentResponse_importDefinition - The settings for the import job that's associated with the segment.

$sel:dimensions:SegmentResponse', segmentResponse_dimensions - The dimension settings for the segment.

$sel:tags:SegmentResponse', segmentResponse_tags - A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.

$sel:segmentType:SegmentResponse', segmentResponse_segmentType - The segment type. Valid values are:

  • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
  • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

$sel:creationDate:SegmentResponse', segmentResponse_creationDate - The date and time when the segment was created.

$sel:id:SegmentResponse', segmentResponse_id - The unique identifier for the segment.

$sel:arn:SegmentResponse', segmentResponse_arn - The Amazon Resource Name (ARN) of the segment.

$sel:applicationId:SegmentResponse', segmentResponse_applicationId - The unique identifier for the application that the segment is associated with.

segmentResponse_lastModifiedDate :: Lens' SegmentResponse (Maybe Text) Source #

The date and time when the segment was last modified.

segmentResponse_segmentGroups :: Lens' SegmentResponse (Maybe SegmentGroupList) Source #

A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

segmentResponse_version :: Lens' SegmentResponse (Maybe Int) Source #

The version number of the segment.

segmentResponse_importDefinition :: Lens' SegmentResponse (Maybe SegmentImportResource) Source #

The settings for the import job that's associated with the segment.

segmentResponse_dimensions :: Lens' SegmentResponse (Maybe SegmentDimensions) Source #

The dimension settings for the segment.

segmentResponse_tags :: Lens' SegmentResponse (Maybe (HashMap Text Text)) Source #

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

segmentResponse_segmentType :: Lens' SegmentResponse SegmentType Source #

The segment type. Valid values are:

  • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
  • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

segmentResponse_creationDate :: Lens' SegmentResponse Text Source #

The date and time when the segment was created.

segmentResponse_id :: Lens' SegmentResponse Text Source #

The unique identifier for the segment.

segmentResponse_arn :: Lens' SegmentResponse Text Source #

The Amazon Resource Name (ARN) of the segment.

segmentResponse_applicationId :: Lens' SegmentResponse Text Source #

The unique identifier for the application that the segment is associated with.

SegmentsResponse

data SegmentsResponse Source #

Provides information about all the segments that are associated with an application.

See: newSegmentsResponse smart constructor.

Constructors

SegmentsResponse' 

Fields

  • nextToken :: Maybe Text

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

  • item :: [SegmentResponse]

    An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).

Instances

Instances details
Eq SegmentsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentsResponse

Read SegmentsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentsResponse

Show SegmentsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentsResponse

Generic SegmentsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentsResponse

Associated Types

type Rep SegmentsResponse :: Type -> Type #

NFData SegmentsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentsResponse

Methods

rnf :: SegmentsResponse -> () #

Hashable SegmentsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentsResponse

FromJSON SegmentsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentsResponse

type Rep SegmentsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SegmentsResponse

type Rep SegmentsResponse = D1 ('MetaData "SegmentsResponse" "Amazonka.Pinpoint.Types.SegmentsResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SegmentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SegmentResponse])))

newSegmentsResponse :: SegmentsResponse Source #

Create a value of SegmentsResponse 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:nextToken:SegmentsResponse', segmentsResponse_nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

$sel:item:SegmentsResponse', segmentsResponse_item - An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).

segmentsResponse_nextToken :: Lens' SegmentsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

segmentsResponse_item :: Lens' SegmentsResponse [SegmentResponse] Source #

An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).

SendUsersMessageRequest

data SendUsersMessageRequest Source #

Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.

See: newSendUsersMessageRequest smart constructor.

Constructors

SendUsersMessageRequest' 

Fields

Instances

Instances details
Eq SendUsersMessageRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SendUsersMessageRequest

Read SendUsersMessageRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SendUsersMessageRequest

Show SendUsersMessageRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SendUsersMessageRequest

Generic SendUsersMessageRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SendUsersMessageRequest

Associated Types

type Rep SendUsersMessageRequest :: Type -> Type #

NFData SendUsersMessageRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SendUsersMessageRequest

Methods

rnf :: SendUsersMessageRequest -> () #

Hashable SendUsersMessageRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SendUsersMessageRequest

ToJSON SendUsersMessageRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SendUsersMessageRequest

type Rep SendUsersMessageRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SendUsersMessageRequest

type Rep SendUsersMessageRequest = D1 ('MetaData "SendUsersMessageRequest" "Amazonka.Pinpoint.Types.SendUsersMessageRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SendUsersMessageRequest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "traceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "context") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "templateConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateConfiguration)) :*: (S1 ('MetaSel ('Just "messageConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DirectMessageConfiguration) :*: S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text EndpointSendConfiguration))))))

newSendUsersMessageRequest Source #

Create a value of SendUsersMessageRequest 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:traceId:SendUsersMessageRequest', sendUsersMessageRequest_traceId - The unique identifier for tracing the message. This identifier is visible to message recipients.

$sel:context:SendUsersMessageRequest', sendUsersMessageRequest_context - A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.

$sel:templateConfiguration:SendUsersMessageRequest', sendUsersMessageRequest_templateConfiguration - The message template to use for the message.

$sel:messageConfiguration:SendUsersMessageRequest', sendUsersMessageRequest_messageConfiguration - The settings and content for the default message and any default messages that you defined for specific channels.

$sel:users:SendUsersMessageRequest', sendUsersMessageRequest_users - A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.

sendUsersMessageRequest_traceId :: Lens' SendUsersMessageRequest (Maybe Text) Source #

The unique identifier for tracing the message. This identifier is visible to message recipients.

sendUsersMessageRequest_context :: Lens' SendUsersMessageRequest (Maybe (HashMap Text Text)) Source #

A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.

sendUsersMessageRequest_messageConfiguration :: Lens' SendUsersMessageRequest DirectMessageConfiguration Source #

The settings and content for the default message and any default messages that you defined for specific channels.

sendUsersMessageRequest_users :: Lens' SendUsersMessageRequest (HashMap Text EndpointSendConfiguration) Source #

A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.

SendUsersMessageResponse

data SendUsersMessageResponse Source #

Provides information about which users and endpoints a message was sent to.

See: newSendUsersMessageResponse smart constructor.

Constructors

SendUsersMessageResponse' 

Fields

  • requestId :: Maybe Text

    The unique identifier that was assigned to the message request.

  • result :: Maybe (HashMap Text (HashMap Text EndpointMessageResult))

    An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.

  • applicationId :: Text

    The unique identifier for the application that was used to send the message.

Instances

Instances details
Eq SendUsersMessageResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SendUsersMessageResponse

Read SendUsersMessageResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SendUsersMessageResponse

Show SendUsersMessageResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SendUsersMessageResponse

Generic SendUsersMessageResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SendUsersMessageResponse

Associated Types

type Rep SendUsersMessageResponse :: Type -> Type #

NFData SendUsersMessageResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SendUsersMessageResponse

Hashable SendUsersMessageResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SendUsersMessageResponse

FromJSON SendUsersMessageResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SendUsersMessageResponse

type Rep SendUsersMessageResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SendUsersMessageResponse

type Rep SendUsersMessageResponse = D1 ('MetaData "SendUsersMessageResponse" "Amazonka.Pinpoint.Types.SendUsersMessageResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SendUsersMessageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (HashMap Text EndpointMessageResult)))) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSendUsersMessageResponse Source #

Create a value of SendUsersMessageResponse 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:requestId:SendUsersMessageResponse', sendUsersMessageResponse_requestId - The unique identifier that was assigned to the message request.

$sel:result:SendUsersMessageResponse', sendUsersMessageResponse_result - An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.

$sel:applicationId:SendUsersMessageResponse', sendUsersMessageResponse_applicationId - The unique identifier for the application that was used to send the message.

sendUsersMessageResponse_requestId :: Lens' SendUsersMessageResponse (Maybe Text) Source #

The unique identifier that was assigned to the message request.

sendUsersMessageResponse_result :: Lens' SendUsersMessageResponse (Maybe (HashMap Text (HashMap Text EndpointMessageResult))) Source #

An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.

sendUsersMessageResponse_applicationId :: Lens' SendUsersMessageResponse Text Source #

The unique identifier for the application that was used to send the message.

Session

data Session Source #

Provides information about a session.

See: newSession smart constructor.

Constructors

Session' 

Fields

Instances

Instances details
Eq Session Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Session

Methods

(==) :: Session -> Session -> Bool #

(/=) :: Session -> Session -> Bool #

Read Session Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Session

Show Session Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Session

Generic Session Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Session

Associated Types

type Rep Session :: Type -> Type #

Methods

from :: Session -> Rep Session x #

to :: Rep Session x -> Session #

NFData Session Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Session

Methods

rnf :: Session -> () #

Hashable Session Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Session

Methods

hashWithSalt :: Int -> Session -> Int #

hash :: Session -> Int #

ToJSON Session Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Session

type Rep Session Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Session

type Rep Session = D1 ('MetaData "Session" "Amazonka.Pinpoint.Types.Session" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "Session'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "stopTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "startTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSession Source #

Create a value of Session 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:stopTimestamp:Session', session_stopTimestamp - The date and time when the session ended.

$sel:duration:Session', session_duration - The duration of the session, in milliseconds.

$sel:startTimestamp:Session', session_startTimestamp - The date and time when the session began.

$sel:id:Session', session_id - The unique identifier for the session.

session_stopTimestamp :: Lens' Session (Maybe Text) Source #

The date and time when the session ended.

session_duration :: Lens' Session (Maybe Int) Source #

The duration of the session, in milliseconds.

session_startTimestamp :: Lens' Session Text Source #

The date and time when the session began.

session_id :: Lens' Session Text Source #

The unique identifier for the session.

SetDimension

data SetDimension Source #

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

Instances details
Eq SetDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SetDimension

Read SetDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SetDimension

Show SetDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SetDimension

Generic SetDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SetDimension

Associated Types

type Rep SetDimension :: Type -> Type #

NFData SetDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SetDimension

Methods

rnf :: SetDimension -> () #

Hashable SetDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SetDimension

ToJSON SetDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SetDimension

FromJSON SetDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SetDimension

type Rep SetDimension Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SetDimension

type Rep SetDimension = D1 ('MetaData "SetDimension" "Amazonka.Pinpoint.Types.SetDimension" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" '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 Source #

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) Source #

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] Source #

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.

SimpleCondition

data SimpleCondition Source #

Specifies a condition to evaluate for an activity in a journey.

See: newSimpleCondition smart constructor.

Constructors

SimpleCondition' 

Fields

Instances

Instances details
Eq SimpleCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleCondition

Read SimpleCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleCondition

Show SimpleCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleCondition

Generic SimpleCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleCondition

Associated Types

type Rep SimpleCondition :: Type -> Type #

NFData SimpleCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleCondition

Methods

rnf :: SimpleCondition -> () #

Hashable SimpleCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleCondition

ToJSON SimpleCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleCondition

FromJSON SimpleCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleCondition

type Rep SimpleCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleCondition

type Rep SimpleCondition = D1 ('MetaData "SimpleCondition" "Amazonka.Pinpoint.Types.SimpleCondition" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SimpleCondition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "segmentDimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SegmentDimensions)) :*: (S1 ('MetaSel ('Just "eventCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventCondition)) :*: S1 ('MetaSel ('Just "segmentCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SegmentCondition)))))

newSimpleCondition :: SimpleCondition Source #

Create a value of SimpleCondition 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:segmentDimensions:SimpleCondition', simpleCondition_segmentDimensions - The dimension settings for the segment that's associated with the activity.

$sel:eventCondition:SimpleCondition', simpleCondition_eventCondition - The dimension settings for the event that's associated with the activity.

$sel:segmentCondition:SimpleCondition', simpleCondition_segmentCondition - The segment that's associated with the activity.

simpleCondition_segmentDimensions :: Lens' SimpleCondition (Maybe SegmentDimensions) Source #

The dimension settings for the segment that's associated with the activity.

simpleCondition_eventCondition :: Lens' SimpleCondition (Maybe EventCondition) Source #

The dimension settings for the event that's associated with the activity.

simpleCondition_segmentCondition :: Lens' SimpleCondition (Maybe SegmentCondition) Source #

The segment that's associated with the activity.

SimpleEmail

data SimpleEmail Source #

Specifies the contents of an email message, composed of a subject, a text part, and an HTML part.

See: newSimpleEmail smart constructor.

Constructors

SimpleEmail' 

Fields

  • subject :: Maybe SimpleEmailPart

    The subject line, or title, of the email.

  • textPart :: Maybe SimpleEmailPart

    The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

  • htmlPart :: Maybe SimpleEmailPart

    The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

Instances

Instances details
Eq SimpleEmail Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleEmail

Read SimpleEmail Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleEmail

Show SimpleEmail Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleEmail

Generic SimpleEmail Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleEmail

Associated Types

type Rep SimpleEmail :: Type -> Type #

NFData SimpleEmail Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleEmail

Methods

rnf :: SimpleEmail -> () #

Hashable SimpleEmail Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleEmail

ToJSON SimpleEmail Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleEmail

type Rep SimpleEmail Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleEmail

type Rep SimpleEmail = D1 ('MetaData "SimpleEmail" "Amazonka.Pinpoint.Types.SimpleEmail" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SimpleEmail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimpleEmailPart)) :*: (S1 ('MetaSel ('Just "textPart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimpleEmailPart)) :*: S1 ('MetaSel ('Just "htmlPart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimpleEmailPart)))))

newSimpleEmail :: SimpleEmail Source #

Create a value of SimpleEmail 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:subject:SimpleEmail', simpleEmail_subject - The subject line, or title, of the email.

$sel:textPart:SimpleEmail', simpleEmail_textPart - The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

$sel:htmlPart:SimpleEmail', simpleEmail_htmlPart - The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

simpleEmail_subject :: Lens' SimpleEmail (Maybe SimpleEmailPart) Source #

The subject line, or title, of the email.

simpleEmail_textPart :: Lens' SimpleEmail (Maybe SimpleEmailPart) Source #

The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

simpleEmail_htmlPart :: Lens' SimpleEmail (Maybe SimpleEmailPart) Source #

The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

SimpleEmailPart

data SimpleEmailPart Source #

Specifies the subject or body of an email message, represented as textual email data and the applicable character set.

See: newSimpleEmailPart smart constructor.

Constructors

SimpleEmailPart' 

Fields

Instances

Instances details
Eq SimpleEmailPart Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleEmailPart

Read SimpleEmailPart Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleEmailPart

Show SimpleEmailPart Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleEmailPart

Generic SimpleEmailPart Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleEmailPart

Associated Types

type Rep SimpleEmailPart :: Type -> Type #

NFData SimpleEmailPart Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleEmailPart

Methods

rnf :: SimpleEmailPart -> () #

Hashable SimpleEmailPart Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleEmailPart

ToJSON SimpleEmailPart Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleEmailPart

type Rep SimpleEmailPart Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.SimpleEmailPart

type Rep SimpleEmailPart = D1 ('MetaData "SimpleEmailPart" "Amazonka.Pinpoint.Types.SimpleEmailPart" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SimpleEmailPart'" 'PrefixI 'True) (S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "charset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newSimpleEmailPart :: SimpleEmailPart Source #

Create a value of SimpleEmailPart 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:data':SimpleEmailPart', simpleEmailPart_data - The textual data of the message content.

$sel:charset:SimpleEmailPart', simpleEmailPart_charset - The applicable character set for the message content.

simpleEmailPart_data :: Lens' SimpleEmailPart (Maybe Text) Source #

The textual data of the message content.

simpleEmailPart_charset :: Lens' SimpleEmailPart (Maybe Text) Source #

The applicable character set for the message content.

StartCondition

data StartCondition Source #

Specifies the conditions for the first activity in a journey. This activity and its conditions determine which users are participants in a journey.

See: newStartCondition smart constructor.

Constructors

StartCondition' 

Fields

Instances

Instances details
Eq StartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.StartCondition

Read StartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.StartCondition

Show StartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.StartCondition

Generic StartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.StartCondition

Associated Types

type Rep StartCondition :: Type -> Type #

NFData StartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.StartCondition

Methods

rnf :: StartCondition -> () #

Hashable StartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.StartCondition

ToJSON StartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.StartCondition

FromJSON StartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.StartCondition

type Rep StartCondition Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.StartCondition

type Rep StartCondition = D1 ('MetaData "StartCondition" "Amazonka.Pinpoint.Types.StartCondition" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "StartCondition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "segmentStartCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SegmentCondition)) :*: (S1 ('MetaSel ('Just "eventStartCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventStartCondition)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newStartCondition :: StartCondition Source #

Create a value of StartCondition 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:segmentStartCondition:StartCondition', startCondition_segmentStartCondition - The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.

$sel:eventStartCondition:StartCondition', startCondition_eventStartCondition - Undocumented member.

$sel:description:StartCondition', startCondition_description - The custom description of the condition.

startCondition_segmentStartCondition :: Lens' StartCondition (Maybe SegmentCondition) Source #

The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.

startCondition_description :: Lens' StartCondition (Maybe Text) Source #

The custom description of the condition.

TagsModel

data TagsModel Source #

Specifies the tags (keys and values) for an application, campaign, message template, or segment.

See: newTagsModel smart constructor.

Constructors

TagsModel' 

Fields

  • tags :: HashMap Text Text

    A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.

    Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Instances

Instances details
Eq TagsModel Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TagsModel

Read TagsModel Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TagsModel

Show TagsModel Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TagsModel

Generic TagsModel Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TagsModel

Associated Types

type Rep TagsModel :: Type -> Type #

NFData TagsModel Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TagsModel

Methods

rnf :: TagsModel -> () #

Hashable TagsModel Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TagsModel

ToJSON TagsModel Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TagsModel

FromJSON TagsModel Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TagsModel

type Rep TagsModel Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TagsModel

type Rep TagsModel = D1 ('MetaData "TagsModel" "Amazonka.Pinpoint.Types.TagsModel" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "TagsModel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))))

newTagsModel :: TagsModel Source #

Create a value of TagsModel 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:tags:TagsModel', tagsModel_tags - A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.

Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

tagsModel_tags :: Lens' TagsModel (HashMap Text Text) Source #

A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.

Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Template

data Template Source #

Specifies the name and version of the message template to use for the message.

See: newTemplate smart constructor.

Constructors

Template' 

Fields

  • name :: Maybe Text

    The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

  • version :: Maybe Text

    The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

Instances

Instances details
Eq Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

Read Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

Show Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

Generic Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

Associated Types

type Rep Template :: Type -> Type #

Methods

from :: Template -> Rep Template x #

to :: Rep Template x -> Template #

NFData Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

Methods

rnf :: Template -> () #

Hashable Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

Methods

hashWithSalt :: Int -> Template -> Int #

hash :: Template -> Int #

ToJSON Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

FromJSON Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

type Rep Template Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.Template

type Rep Template = D1 ('MetaData "Template" "Amazonka.Pinpoint.Types.Template" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "Template'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newTemplate :: Template Source #

Create a value of Template 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:name:Template', template_name - The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

$sel:version:Template', template_version - The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

template_name :: Lens' Template (Maybe Text) Source #

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

template_version :: Lens' Template (Maybe Text) Source #

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

TemplateActiveVersionRequest

data TemplateActiveVersionRequest Source #

Specifies which version of a message template to use as the active version of the template.

See: newTemplateActiveVersionRequest smart constructor.

Constructors

TemplateActiveVersionRequest' 

Fields

  • version :: Maybe Text

    The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

Instances

Instances details
Eq TemplateActiveVersionRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateActiveVersionRequest

Read TemplateActiveVersionRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateActiveVersionRequest

Show TemplateActiveVersionRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateActiveVersionRequest

Generic TemplateActiveVersionRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateActiveVersionRequest

Associated Types

type Rep TemplateActiveVersionRequest :: Type -> Type #

NFData TemplateActiveVersionRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateActiveVersionRequest

Hashable TemplateActiveVersionRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateActiveVersionRequest

ToJSON TemplateActiveVersionRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateActiveVersionRequest

type Rep TemplateActiveVersionRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateActiveVersionRequest

type Rep TemplateActiveVersionRequest = D1 ('MetaData "TemplateActiveVersionRequest" "Amazonka.Pinpoint.Types.TemplateActiveVersionRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "TemplateActiveVersionRequest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newTemplateActiveVersionRequest :: TemplateActiveVersionRequest Source #

Create a value of TemplateActiveVersionRequest 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:version:TemplateActiveVersionRequest', templateActiveVersionRequest_version - The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

templateActiveVersionRequest_version :: Lens' TemplateActiveVersionRequest (Maybe Text) Source #

The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

TemplateConfiguration

data TemplateConfiguration Source #

Specifies the message template to use for the message, for each type of channel.

See: newTemplateConfiguration smart constructor.

Constructors

TemplateConfiguration' 

Fields

Instances

Instances details
Eq TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateConfiguration

Read TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateConfiguration

Show TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateConfiguration

Generic TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateConfiguration

Associated Types

type Rep TemplateConfiguration :: Type -> Type #

NFData TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateConfiguration

Methods

rnf :: TemplateConfiguration -> () #

Hashable TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateConfiguration

ToJSON TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateConfiguration

FromJSON TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateConfiguration

type Rep TemplateConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateConfiguration

type Rep TemplateConfiguration = D1 ('MetaData "TemplateConfiguration" "Amazonka.Pinpoint.Types.TemplateConfiguration" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "TemplateConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sMSTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Template)) :*: S1 ('MetaSel ('Just "voiceTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Template))) :*: (S1 ('MetaSel ('Just "pushTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Template)) :*: S1 ('MetaSel ('Just "emailTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Template)))))

newTemplateConfiguration :: TemplateConfiguration Source #

Create a value of TemplateConfiguration 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:sMSTemplate:TemplateConfiguration', templateConfiguration_sMSTemplate - The SMS template to use for the message.

$sel:voiceTemplate:TemplateConfiguration', templateConfiguration_voiceTemplate - The voice template to use for the message. This object isn't supported for campaigns.

$sel:pushTemplate:TemplateConfiguration', templateConfiguration_pushTemplate - The push notification template to use for the message.

$sel:emailTemplate:TemplateConfiguration', templateConfiguration_emailTemplate - The email template to use for the message.

templateConfiguration_voiceTemplate :: Lens' TemplateConfiguration (Maybe Template) Source #

The voice template to use for the message. This object isn't supported for campaigns.

templateConfiguration_pushTemplate :: Lens' TemplateConfiguration (Maybe Template) Source #

The push notification template to use for the message.

TemplateCreateMessageBody

data TemplateCreateMessageBody Source #

Provides information about a request to create a message template.

See: newTemplateCreateMessageBody smart constructor.

Constructors

TemplateCreateMessageBody' 

Fields

  • requestID :: Maybe Text

    The unique identifier for the request to create the message template.

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the message template that was created.

  • message :: Maybe Text

    The message that's returned from the API for the request to create the message template.

Instances

Instances details
Eq TemplateCreateMessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateCreateMessageBody

Read TemplateCreateMessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateCreateMessageBody

Show TemplateCreateMessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateCreateMessageBody

Generic TemplateCreateMessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateCreateMessageBody

Associated Types

type Rep TemplateCreateMessageBody :: Type -> Type #

NFData TemplateCreateMessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateCreateMessageBody

Hashable TemplateCreateMessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateCreateMessageBody

FromJSON TemplateCreateMessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateCreateMessageBody

type Rep TemplateCreateMessageBody Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateCreateMessageBody

type Rep TemplateCreateMessageBody = D1 ('MetaData "TemplateCreateMessageBody" "Amazonka.Pinpoint.Types.TemplateCreateMessageBody" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "TemplateCreateMessageBody'" 'PrefixI 'True) (S1 ('MetaSel ('Just "requestID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newTemplateCreateMessageBody :: TemplateCreateMessageBody Source #

Create a value of TemplateCreateMessageBody 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:requestID:TemplateCreateMessageBody', templateCreateMessageBody_requestID - The unique identifier for the request to create the message template.

$sel:arn:TemplateCreateMessageBody', templateCreateMessageBody_arn - The Amazon Resource Name (ARN) of the message template that was created.

$sel:message:TemplateCreateMessageBody', templateCreateMessageBody_message - The message that's returned from the API for the request to create the message template.

templateCreateMessageBody_requestID :: Lens' TemplateCreateMessageBody (Maybe Text) Source #

The unique identifier for the request to create the message template.

templateCreateMessageBody_arn :: Lens' TemplateCreateMessageBody (Maybe Text) Source #

The Amazon Resource Name (ARN) of the message template that was created.

templateCreateMessageBody_message :: Lens' TemplateCreateMessageBody (Maybe Text) Source #

The message that's returned from the API for the request to create the message template.

TemplateResponse

data TemplateResponse Source #

Provides information about a message template that's associated with your Amazon Pinpoint account.

See: newTemplateResponse smart constructor.

Constructors

TemplateResponse' 

Fields

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.

  • templateDescription :: Maybe Text

    The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.

  • defaultSubstitutions :: Maybe Text

    The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

  • version :: Maybe Text

    The unique identifier, as an integer, for the active version of the message template.

  • tags :: Maybe (HashMap Text Text)

    A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

  • lastModifiedDate :: Text

    The date, in ISO 8601 format, when the message template was last modified.

  • creationDate :: Text

    The date, in ISO 8601 format, when the message template was created.

  • templateName :: Text

    The name of the message template.

  • templateType :: TemplateType

    The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

Instances

Instances details
Eq TemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateResponse

Read TemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateResponse

Show TemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateResponse

Generic TemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateResponse

Associated Types

type Rep TemplateResponse :: Type -> Type #

NFData TemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateResponse

Methods

rnf :: TemplateResponse -> () #

Hashable TemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateResponse

FromJSON TemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateResponse

type Rep TemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateResponse

newTemplateResponse Source #

Create a value of TemplateResponse 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:arn:TemplateResponse', templateResponse_arn - The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.

$sel:templateDescription:TemplateResponse', templateResponse_templateDescription - The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.

$sel:defaultSubstitutions:TemplateResponse', templateResponse_defaultSubstitutions - The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

$sel:version:TemplateResponse', templateResponse_version - The unique identifier, as an integer, for the active version of the message template.

$sel:tags:TemplateResponse', templateResponse_tags - A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

$sel:lastModifiedDate:TemplateResponse', templateResponse_lastModifiedDate - The date, in ISO 8601 format, when the message template was last modified.

$sel:creationDate:TemplateResponse', templateResponse_creationDate - The date, in ISO 8601 format, when the message template was created.

$sel:templateName:TemplateResponse', templateResponse_templateName - The name of the message template.

$sel:templateType:TemplateResponse', templateResponse_templateType - The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

templateResponse_arn :: Lens' TemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.

templateResponse_templateDescription :: Lens' TemplateResponse (Maybe Text) Source #

The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.

templateResponse_defaultSubstitutions :: Lens' TemplateResponse (Maybe Text) Source #

The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

templateResponse_version :: Lens' TemplateResponse (Maybe Text) Source #

The unique identifier, as an integer, for the active version of the message template.

templateResponse_tags :: Lens' TemplateResponse (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.

templateResponse_lastModifiedDate :: Lens' TemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was last modified.

templateResponse_creationDate :: Lens' TemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was created.

templateResponse_templateName :: Lens' TemplateResponse Text Source #

The name of the message template.

templateResponse_templateType :: Lens' TemplateResponse TemplateType Source #

The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

TemplateVersionResponse

data TemplateVersionResponse Source #

Provides information about a specific version of a message template.

See: newTemplateVersionResponse smart constructor.

Constructors

TemplateVersionResponse' 

Fields

  • templateDescription :: Maybe Text

    The custom description of the version of the message template.

  • defaultSubstitutions :: Maybe Text

    A JSON object that specifies the default values that are used for message variables in the version of the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

  • version :: Maybe Text

    The unique identifier for the version of the message template. This value is an integer that Amazon Pinpoint automatically increments and assigns to each new version of a template.

  • lastModifiedDate :: Text

    The date, in ISO 8601 format, when the version of the message template was last modified.

  • creationDate :: Text

    The date, in ISO 8601 format, when the version of the message template was created.

  • templateName :: Text

    The name of the message template.

  • templateType :: Text

    The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

Instances

Instances details
Eq TemplateVersionResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateVersionResponse

Read TemplateVersionResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateVersionResponse

Show TemplateVersionResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateVersionResponse

Generic TemplateVersionResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateVersionResponse

Associated Types

type Rep TemplateVersionResponse :: Type -> Type #

NFData TemplateVersionResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateVersionResponse

Methods

rnf :: TemplateVersionResponse -> () #

Hashable TemplateVersionResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateVersionResponse

FromJSON TemplateVersionResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateVersionResponse

type Rep TemplateVersionResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateVersionResponse

type Rep TemplateVersionResponse = D1 ('MetaData "TemplateVersionResponse" "Amazonka.Pinpoint.Types.TemplateVersionResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "TemplateVersionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "templateDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "defaultSubstitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "templateType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newTemplateVersionResponse Source #

Create a value of TemplateVersionResponse 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:templateDescription:TemplateVersionResponse', templateVersionResponse_templateDescription - The custom description of the version of the message template.

$sel:defaultSubstitutions:TemplateVersionResponse', templateVersionResponse_defaultSubstitutions - A JSON object that specifies the default values that are used for message variables in the version of the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

$sel:version:TemplateVersionResponse', templateVersionResponse_version - The unique identifier for the version of the message template. This value is an integer that Amazon Pinpoint automatically increments and assigns to each new version of a template.

$sel:lastModifiedDate:TemplateVersionResponse', templateVersionResponse_lastModifiedDate - The date, in ISO 8601 format, when the version of the message template was last modified.

$sel:creationDate:TemplateVersionResponse', templateVersionResponse_creationDate - The date, in ISO 8601 format, when the version of the message template was created.

$sel:templateName:TemplateVersionResponse', templateVersionResponse_templateName - The name of the message template.

$sel:templateType:TemplateVersionResponse', templateVersionResponse_templateType - The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

templateVersionResponse_templateDescription :: Lens' TemplateVersionResponse (Maybe Text) Source #

The custom description of the version of the message template.

templateVersionResponse_defaultSubstitutions :: Lens' TemplateVersionResponse (Maybe Text) Source #

A JSON object that specifies the default values that are used for message variables in the version of the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

templateVersionResponse_version :: Lens' TemplateVersionResponse (Maybe Text) Source #

The unique identifier for the version of the message template. This value is an integer that Amazon Pinpoint automatically increments and assigns to each new version of a template.

templateVersionResponse_lastModifiedDate :: Lens' TemplateVersionResponse Text Source #

The date, in ISO 8601 format, when the version of the message template was last modified.

templateVersionResponse_creationDate :: Lens' TemplateVersionResponse Text Source #

The date, in ISO 8601 format, when the version of the message template was created.

templateVersionResponse_templateType :: Lens' TemplateVersionResponse Text Source #

The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

TemplateVersionsResponse

data TemplateVersionsResponse Source #

Provides information about all the versions of a specific message template.

See: newTemplateVersionsResponse smart constructor.

Constructors

TemplateVersionsResponse' 

Fields

  • requestID :: Maybe Text

    The unique identifier for the request to retrieve information about all the versions of the message template.

  • nextToken :: Maybe Text

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

  • message :: Maybe Text

    The message that's returned from the API for the request to retrieve information about all the versions of the message template.

  • item :: [TemplateVersionResponse]

    An array of responses, one for each version of the message template.

Instances

Instances details
Eq TemplateVersionsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateVersionsResponse

Read TemplateVersionsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateVersionsResponse

Show TemplateVersionsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateVersionsResponse

Generic TemplateVersionsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateVersionsResponse

Associated Types

type Rep TemplateVersionsResponse :: Type -> Type #

NFData TemplateVersionsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateVersionsResponse

Hashable TemplateVersionsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateVersionsResponse

FromJSON TemplateVersionsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateVersionsResponse

type Rep TemplateVersionsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplateVersionsResponse

type Rep TemplateVersionsResponse = D1 ('MetaData "TemplateVersionsResponse" "Amazonka.Pinpoint.Types.TemplateVersionsResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "TemplateVersionsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TemplateVersionResponse]))))

newTemplateVersionsResponse :: TemplateVersionsResponse Source #

Create a value of TemplateVersionsResponse 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:requestID:TemplateVersionsResponse', templateVersionsResponse_requestID - The unique identifier for the request to retrieve information about all the versions of the message template.

$sel:nextToken:TemplateVersionsResponse', templateVersionsResponse_nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

$sel:message:TemplateVersionsResponse', templateVersionsResponse_message - The message that's returned from the API for the request to retrieve information about all the versions of the message template.

$sel:item:TemplateVersionsResponse', templateVersionsResponse_item - An array of responses, one for each version of the message template.

templateVersionsResponse_requestID :: Lens' TemplateVersionsResponse (Maybe Text) Source #

The unique identifier for the request to retrieve information about all the versions of the message template.

templateVersionsResponse_nextToken :: Lens' TemplateVersionsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

templateVersionsResponse_message :: Lens' TemplateVersionsResponse (Maybe Text) Source #

The message that's returned from the API for the request to retrieve information about all the versions of the message template.

templateVersionsResponse_item :: Lens' TemplateVersionsResponse [TemplateVersionResponse] Source #

An array of responses, one for each version of the message template.

TemplatesResponse

data TemplatesResponse Source #

Provides information about all the message templates that are associated with your Amazon Pinpoint account.

See: newTemplatesResponse smart constructor.

Constructors

TemplatesResponse' 

Fields

  • nextToken :: Maybe Text

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

  • item :: [TemplateResponse]

    An array of responses, one for each message template that's associated with your Amazon Pinpoint account and meets any filter criteria that you specified in the request.

Instances

Instances details
Eq TemplatesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplatesResponse

Read TemplatesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplatesResponse

Show TemplatesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplatesResponse

Generic TemplatesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplatesResponse

Associated Types

type Rep TemplatesResponse :: Type -> Type #

NFData TemplatesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplatesResponse

Methods

rnf :: TemplatesResponse -> () #

Hashable TemplatesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplatesResponse

FromJSON TemplatesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplatesResponse

type Rep TemplatesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TemplatesResponse

type Rep TemplatesResponse = D1 ('MetaData "TemplatesResponse" "Amazonka.Pinpoint.Types.TemplatesResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "TemplatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TemplateResponse])))

newTemplatesResponse :: TemplatesResponse Source #

Create a value of TemplatesResponse 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:nextToken:TemplatesResponse', templatesResponse_nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

$sel:item:TemplatesResponse', templatesResponse_item - An array of responses, one for each message template that's associated with your Amazon Pinpoint account and meets any filter criteria that you specified in the request.

templatesResponse_nextToken :: Lens' TemplatesResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

templatesResponse_item :: Lens' TemplatesResponse [TemplateResponse] Source #

An array of responses, one for each message template that's associated with your Amazon Pinpoint account and meets any filter criteria that you specified in the request.

TreatmentResource

data TreatmentResource Source #

Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

See: newTreatmentResource smart constructor.

Constructors

TreatmentResource' 

Fields

Instances

Instances details
Eq TreatmentResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TreatmentResource

Read TreatmentResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TreatmentResource

Show TreatmentResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TreatmentResource

Generic TreatmentResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TreatmentResource

Associated Types

type Rep TreatmentResource :: Type -> Type #

NFData TreatmentResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TreatmentResource

Methods

rnf :: TreatmentResource -> () #

Hashable TreatmentResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TreatmentResource

FromJSON TreatmentResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TreatmentResource

type Rep TreatmentResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.TreatmentResource

newTreatmentResource Source #

Create a value of TreatmentResource 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:customDeliveryConfiguration:TreatmentResource', treatmentResource_customDeliveryConfiguration - The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

$sel:state:TreatmentResource', treatmentResource_state - The current status of the treatment.

$sel:schedule:TreatmentResource', treatmentResource_schedule - The schedule settings for the treatment.

$sel:templateConfiguration:TreatmentResource', treatmentResource_templateConfiguration - The message template to use for the treatment.

$sel:treatmentName:TreatmentResource', treatmentResource_treatmentName - The custom name of the treatment.

$sel:treatmentDescription:TreatmentResource', treatmentResource_treatmentDescription - The custom description of the treatment.

$sel:messageConfiguration:TreatmentResource', treatmentResource_messageConfiguration - The message configuration settings for the treatment.

$sel:id:TreatmentResource', treatmentResource_id - The unique identifier for the treatment.

$sel:sizePercent:TreatmentResource', treatmentResource_sizePercent - The allocated percentage of users (segment members) that the treatment is sent to.

treatmentResource_customDeliveryConfiguration :: Lens' TreatmentResource (Maybe CustomDeliveryConfiguration) Source #

The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

treatmentResource_state :: Lens' TreatmentResource (Maybe CampaignState) Source #

The current status of the treatment.

treatmentResource_schedule :: Lens' TreatmentResource (Maybe Schedule) Source #

The schedule settings for the treatment.

treatmentResource_treatmentDescription :: Lens' TreatmentResource (Maybe Text) Source #

The custom description of the treatment.

treatmentResource_messageConfiguration :: Lens' TreatmentResource (Maybe MessageConfiguration) Source #

The message configuration settings for the treatment.

treatmentResource_id :: Lens' TreatmentResource Text Source #

The unique identifier for the treatment.

treatmentResource_sizePercent :: Lens' TreatmentResource Int Source #

The allocated percentage of users (segment members) that the treatment is sent to.

UpdateAttributesRequest

data UpdateAttributesRequest Source #

Specifies one or more attributes to remove from all the endpoints that are associated with an application.

See: newUpdateAttributesRequest smart constructor.

Constructors

UpdateAttributesRequest' 

Fields

  • blacklist :: Maybe [Text]

    An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.

Instances

Instances details
Eq UpdateAttributesRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.UpdateAttributesRequest

Read UpdateAttributesRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.UpdateAttributesRequest

Show UpdateAttributesRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.UpdateAttributesRequest

Generic UpdateAttributesRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.UpdateAttributesRequest

Associated Types

type Rep UpdateAttributesRequest :: Type -> Type #

NFData UpdateAttributesRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.UpdateAttributesRequest

Methods

rnf :: UpdateAttributesRequest -> () #

Hashable UpdateAttributesRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.UpdateAttributesRequest

ToJSON UpdateAttributesRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.UpdateAttributesRequest

type Rep UpdateAttributesRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.UpdateAttributesRequest

type Rep UpdateAttributesRequest = D1 ('MetaData "UpdateAttributesRequest" "Amazonka.Pinpoint.Types.UpdateAttributesRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "UpdateAttributesRequest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "blacklist") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newUpdateAttributesRequest :: UpdateAttributesRequest Source #

Create a value of UpdateAttributesRequest 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:blacklist:UpdateAttributesRequest', updateAttributesRequest_blacklist - An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.

updateAttributesRequest_blacklist :: Lens' UpdateAttributesRequest (Maybe [Text]) Source #

An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.

UpdateRecommenderConfiguration

data UpdateRecommenderConfiguration Source #

Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.

See: newUpdateRecommenderConfiguration smart constructor.

Constructors

UpdateRecommenderConfiguration' 

Fields

  • recommendationTransformerUri :: Maybe Text

    The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.

  • recommendationsDisplayName :: Maybe Text

    A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

    This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

  • recommendationProviderIdType :: Maybe Text

    The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

    • PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
    • PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
  • attributes :: Maybe (HashMap Text Text)

    A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

    In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

    • An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
    • An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

    This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.

  • name :: Maybe Text

    A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

  • description :: Maybe Text

    A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.

  • recommendationsPerMessage :: Maybe Int

    The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

    To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

  • recommendationProviderUri :: Text

    The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.

  • recommendationProviderRoleArn :: Text

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

Instances

Instances details
Eq UpdateRecommenderConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.UpdateRecommenderConfiguration

Read UpdateRecommenderConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.UpdateRecommenderConfiguration

Show UpdateRecommenderConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.UpdateRecommenderConfiguration

Generic UpdateRecommenderConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.UpdateRecommenderConfiguration

Associated Types

type Rep UpdateRecommenderConfiguration :: Type -> Type #

NFData UpdateRecommenderConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.UpdateRecommenderConfiguration

Hashable UpdateRecommenderConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.UpdateRecommenderConfiguration

ToJSON UpdateRecommenderConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.UpdateRecommenderConfiguration

type Rep UpdateRecommenderConfiguration Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.UpdateRecommenderConfiguration

type Rep UpdateRecommenderConfiguration = D1 ('MetaData "UpdateRecommenderConfiguration" "Amazonka.Pinpoint.Types.UpdateRecommenderConfiguration" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "UpdateRecommenderConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "recommendationTransformerUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "recommendationsDisplayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "recommendationProviderIdType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "recommendationsPerMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "recommendationProviderUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "recommendationProviderRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateRecommenderConfiguration Source #

Create a value of UpdateRecommenderConfiguration 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:recommendationTransformerUri:UpdateRecommenderConfiguration', updateRecommenderConfiguration_recommendationTransformerUri - The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.

$sel:recommendationsDisplayName:UpdateRecommenderConfiguration', updateRecommenderConfiguration_recommendationsDisplayName - A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

$sel:recommendationProviderIdType:UpdateRecommenderConfiguration', updateRecommenderConfiguration_recommendationProviderIdType - The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

  • PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
  • PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

$sel:attributes:UpdateRecommenderConfiguration', updateRecommenderConfiguration_attributes - A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

  • An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
  • An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.

$sel:name:UpdateRecommenderConfiguration', updateRecommenderConfiguration_name - A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

$sel:description:UpdateRecommenderConfiguration', updateRecommenderConfiguration_description - A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.

$sel:recommendationsPerMessage:UpdateRecommenderConfiguration', updateRecommenderConfiguration_recommendationsPerMessage - The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

$sel:recommendationProviderUri:UpdateRecommenderConfiguration', updateRecommenderConfiguration_recommendationProviderUri - The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.

$sel:recommendationProviderRoleArn:UpdateRecommenderConfiguration', updateRecommenderConfiguration_recommendationProviderRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

updateRecommenderConfiguration_recommendationTransformerUri :: Lens' UpdateRecommenderConfiguration (Maybe Text) Source #

The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.

updateRecommenderConfiguration_recommendationsDisplayName :: Lens' UpdateRecommenderConfiguration (Maybe Text) Source #

A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.

updateRecommenderConfiguration_recommendationProviderIdType :: Lens' UpdateRecommenderConfiguration (Maybe Text) Source #

The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:

  • PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
  • PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.

updateRecommenderConfiguration_attributes :: Lens' UpdateRecommenderConfiguration (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.

In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:

  • An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
  • An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.

updateRecommenderConfiguration_name :: Lens' UpdateRecommenderConfiguration (Maybe Text) Source #

A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).

updateRecommenderConfiguration_description :: Lens' UpdateRecommenderConfiguration (Maybe Text) Source #

A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.

updateRecommenderConfiguration_recommendationsPerMessage :: Lens' UpdateRecommenderConfiguration (Maybe Int) Source #

The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.

To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.

updateRecommenderConfiguration_recommendationProviderUri :: Lens' UpdateRecommenderConfiguration Text Source #

The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.

updateRecommenderConfiguration_recommendationProviderRoleArn :: Lens' UpdateRecommenderConfiguration Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.

VoiceChannelRequest

data VoiceChannelRequest Source #

Specifies the status and settings of the voice channel for an application.

See: newVoiceChannelRequest smart constructor.

Constructors

VoiceChannelRequest' 

Fields

  • enabled :: Maybe Bool

    Specifies whether to enable the voice channel for the application.

Instances

Instances details
Eq VoiceChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceChannelRequest

Read VoiceChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceChannelRequest

Show VoiceChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceChannelRequest

Generic VoiceChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceChannelRequest

Associated Types

type Rep VoiceChannelRequest :: Type -> Type #

NFData VoiceChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceChannelRequest

Methods

rnf :: VoiceChannelRequest -> () #

Hashable VoiceChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceChannelRequest

ToJSON VoiceChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceChannelRequest

type Rep VoiceChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceChannelRequest

type Rep VoiceChannelRequest = D1 ('MetaData "VoiceChannelRequest" "Amazonka.Pinpoint.Types.VoiceChannelRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "VoiceChannelRequest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))

newVoiceChannelRequest :: VoiceChannelRequest Source #

Create a value of VoiceChannelRequest 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:enabled:VoiceChannelRequest', voiceChannelRequest_enabled - Specifies whether to enable the voice channel for the application.

voiceChannelRequest_enabled :: Lens' VoiceChannelRequest (Maybe Bool) Source #

Specifies whether to enable the voice channel for the application.

VoiceChannelResponse

data VoiceChannelResponse Source #

Provides information about the status and settings of the voice channel for an application.

See: newVoiceChannelResponse smart constructor.

Constructors

VoiceChannelResponse' 

Fields

  • lastModifiedDate :: Maybe Text

    The date and time, in ISO 8601 format, when the voice channel was last modified.

  • enabled :: Maybe Bool

    Specifies whether the voice channel is enabled for the application.

  • isArchived :: Maybe Bool

    Specifies whether the voice channel is archived.

  • applicationId :: Maybe Text

    The unique identifier for the application that the voice channel applies to.

  • version :: Maybe Int

    The current version of the voice channel.

  • id :: Maybe Text

    (Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.

  • creationDate :: Maybe Text

    The date and time, in ISO 8601 format, when the voice channel was enabled.

  • lastModifiedBy :: Maybe Text

    The user who last modified the voice channel.

  • hasCredential :: Maybe Bool

    (Not used) This property is retained only for backward compatibility.

  • platform :: Text

    The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.

Instances

Instances details
Eq VoiceChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceChannelResponse

Read VoiceChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceChannelResponse

Show VoiceChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceChannelResponse

Generic VoiceChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceChannelResponse

Associated Types

type Rep VoiceChannelResponse :: Type -> Type #

NFData VoiceChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceChannelResponse

Methods

rnf :: VoiceChannelResponse -> () #

Hashable VoiceChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceChannelResponse

FromJSON VoiceChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceChannelResponse

type Rep VoiceChannelResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceChannelResponse

newVoiceChannelResponse Source #

Create a value of VoiceChannelResponse 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:lastModifiedDate:VoiceChannelResponse', voiceChannelResponse_lastModifiedDate - The date and time, in ISO 8601 format, when the voice channel was last modified.

$sel:enabled:VoiceChannelResponse', voiceChannelResponse_enabled - Specifies whether the voice channel is enabled for the application.

$sel:isArchived:VoiceChannelResponse', voiceChannelResponse_isArchived - Specifies whether the voice channel is archived.

$sel:applicationId:VoiceChannelResponse', voiceChannelResponse_applicationId - The unique identifier for the application that the voice channel applies to.

$sel:version:VoiceChannelResponse', voiceChannelResponse_version - The current version of the voice channel.

$sel:id:VoiceChannelResponse', voiceChannelResponse_id - (Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.

$sel:creationDate:VoiceChannelResponse', voiceChannelResponse_creationDate - The date and time, in ISO 8601 format, when the voice channel was enabled.

$sel:lastModifiedBy:VoiceChannelResponse', voiceChannelResponse_lastModifiedBy - The user who last modified the voice channel.

$sel:hasCredential:VoiceChannelResponse', voiceChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.

$sel:platform:VoiceChannelResponse', voiceChannelResponse_platform - The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.

voiceChannelResponse_lastModifiedDate :: Lens' VoiceChannelResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the voice channel was last modified.

voiceChannelResponse_enabled :: Lens' VoiceChannelResponse (Maybe Bool) Source #

Specifies whether the voice channel is enabled for the application.

voiceChannelResponse_isArchived :: Lens' VoiceChannelResponse (Maybe Bool) Source #

Specifies whether the voice channel is archived.

voiceChannelResponse_applicationId :: Lens' VoiceChannelResponse (Maybe Text) Source #

The unique identifier for the application that the voice channel applies to.

voiceChannelResponse_version :: Lens' VoiceChannelResponse (Maybe Int) Source #

The current version of the voice channel.

voiceChannelResponse_id :: Lens' VoiceChannelResponse (Maybe Text) Source #

(Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.

voiceChannelResponse_creationDate :: Lens' VoiceChannelResponse (Maybe Text) Source #

The date and time, in ISO 8601 format, when the voice channel was enabled.

voiceChannelResponse_lastModifiedBy :: Lens' VoiceChannelResponse (Maybe Text) Source #

The user who last modified the voice channel.

voiceChannelResponse_hasCredential :: Lens' VoiceChannelResponse (Maybe Bool) Source #

(Not used) This property is retained only for backward compatibility.

voiceChannelResponse_platform :: Lens' VoiceChannelResponse Text Source #

The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.

VoiceMessage

data VoiceMessage Source #

Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.

See: newVoiceMessage smart constructor.

Constructors

VoiceMessage' 

Fields

  • substitutions :: Maybe (HashMap Text [Text])

    The default message variables to use in the voice message. You can override the default variables with individual address variables.

  • languageCode :: Maybe Text

    The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

  • originationNumber :: Maybe Text

    The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.

  • body :: Maybe Text

    The text of the script to use for the voice message.

  • voiceId :: Maybe Text

    The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.

Instances

Instances details
Eq VoiceMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceMessage

Read VoiceMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceMessage

Show VoiceMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceMessage

Generic VoiceMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceMessage

Associated Types

type Rep VoiceMessage :: Type -> Type #

NFData VoiceMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceMessage

Methods

rnf :: VoiceMessage -> () #

Hashable VoiceMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceMessage

ToJSON VoiceMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceMessage

type Rep VoiceMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceMessage

type Rep VoiceMessage = D1 ('MetaData "VoiceMessage" "Amazonka.Pinpoint.Types.VoiceMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "VoiceMessage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "substitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "originationNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "voiceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newVoiceMessage :: VoiceMessage Source #

Create a value of VoiceMessage 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:substitutions:VoiceMessage', voiceMessage_substitutions - The default message variables to use in the voice message. You can override the default variables with individual address variables.

$sel:languageCode:VoiceMessage', voiceMessage_languageCode - The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

$sel:originationNumber:VoiceMessage', voiceMessage_originationNumber - The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.

$sel:body:VoiceMessage', voiceMessage_body - The text of the script to use for the voice message.

$sel:voiceId:VoiceMessage', voiceMessage_voiceId - The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.

voiceMessage_substitutions :: Lens' VoiceMessage (Maybe (HashMap Text [Text])) Source #

The default message variables to use in the voice message. You can override the default variables with individual address variables.

voiceMessage_languageCode :: Lens' VoiceMessage (Maybe Text) Source #

The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

voiceMessage_originationNumber :: Lens' VoiceMessage (Maybe Text) Source #

The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.

voiceMessage_body :: Lens' VoiceMessage (Maybe Text) Source #

The text of the script to use for the voice message.

voiceMessage_voiceId :: Lens' VoiceMessage (Maybe Text) Source #

The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.

VoiceTemplateRequest

data VoiceTemplateRequest Source #

Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

See: newVoiceTemplateRequest smart constructor.

Constructors

VoiceTemplateRequest' 

Fields

  • languageCode :: Maybe Text

    The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

  • body :: Maybe Text

    The text of the script to use in messages that are based on the message template, in plain text format.

  • templateDescription :: Maybe Text

    A custom description of the message template.

  • defaultSubstitutions :: Maybe Text

    A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

  • voiceId :: Maybe Text

    The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

  • tags :: Maybe (HashMap Text Text)

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

Instances

Instances details
Eq VoiceTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceTemplateRequest

Read VoiceTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceTemplateRequest

Show VoiceTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceTemplateRequest

Generic VoiceTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceTemplateRequest

Associated Types

type Rep VoiceTemplateRequest :: Type -> Type #

NFData VoiceTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceTemplateRequest

Methods

rnf :: VoiceTemplateRequest -> () #

Hashable VoiceTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceTemplateRequest

ToJSON VoiceTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceTemplateRequest

type Rep VoiceTemplateRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceTemplateRequest

type Rep VoiceTemplateRequest = D1 ('MetaData "VoiceTemplateRequest" "Amazonka.Pinpoint.Types.VoiceTemplateRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "VoiceTemplateRequest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "defaultSubstitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "voiceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))

newVoiceTemplateRequest :: VoiceTemplateRequest Source #

Create a value of VoiceTemplateRequest 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:languageCode:VoiceTemplateRequest', voiceTemplateRequest_languageCode - The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

$sel:body:VoiceTemplateRequest', voiceTemplateRequest_body - The text of the script to use in messages that are based on the message template, in plain text format.

$sel:templateDescription:VoiceTemplateRequest', voiceTemplateRequest_templateDescription - A custom description of the message template.

$sel:defaultSubstitutions:VoiceTemplateRequest', voiceTemplateRequest_defaultSubstitutions - A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

$sel:voiceId:VoiceTemplateRequest', voiceTemplateRequest_voiceId - The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

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

voiceTemplateRequest_languageCode :: Lens' VoiceTemplateRequest (Maybe Text) Source #

The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

voiceTemplateRequest_body :: Lens' VoiceTemplateRequest (Maybe Text) Source #

The text of the script to use in messages that are based on the message template, in plain text format.

voiceTemplateRequest_templateDescription :: Lens' VoiceTemplateRequest (Maybe Text) Source #

A custom description of the message template.

voiceTemplateRequest_defaultSubstitutions :: Lens' VoiceTemplateRequest (Maybe Text) Source #

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

voiceTemplateRequest_voiceId :: Lens' VoiceTemplateRequest (Maybe Text) Source #

The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

voiceTemplateRequest_tags :: Lens' VoiceTemplateRequest (Maybe (HashMap Text Text)) Source #

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

VoiceTemplateResponse

data VoiceTemplateResponse Source #

Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.

See: newVoiceTemplateResponse smart constructor.

Constructors

VoiceTemplateResponse' 

Fields

  • languageCode :: Maybe Text

    The code for the language that's used when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the message template.

  • body :: Maybe Text

    The text of the script that's used in messages that are based on the message template, in plain text format.

  • templateDescription :: Maybe Text

    The custom description of the message template.

  • defaultSubstitutions :: Maybe Text

    The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

  • version :: Maybe Text

    The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

  • voiceId :: Maybe Text

    The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

  • tags :: Maybe (HashMap Text Text)

    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

  • lastModifiedDate :: Text

    The date, in ISO 8601 format, when the message template was last modified.

  • creationDate :: Text

    The date, in ISO 8601 format, when the message template was created.

  • templateName :: Text

    The name of the message template.

  • templateType :: TemplateType

    The type of channel that the message template is designed for. For a voice template, this value is VOICE.

Instances

Instances details
Eq VoiceTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceTemplateResponse

Read VoiceTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceTemplateResponse

Show VoiceTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceTemplateResponse

Generic VoiceTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceTemplateResponse

Associated Types

type Rep VoiceTemplateResponse :: Type -> Type #

NFData VoiceTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceTemplateResponse

Methods

rnf :: VoiceTemplateResponse -> () #

Hashable VoiceTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceTemplateResponse

FromJSON VoiceTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceTemplateResponse

type Rep VoiceTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.VoiceTemplateResponse

type Rep VoiceTemplateResponse = D1 ('MetaData "VoiceTemplateResponse" "Amazonka.Pinpoint.Types.VoiceTemplateResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "VoiceTemplateResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "templateDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "defaultSubstitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "voiceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "templateType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TemplateType))))))

newVoiceTemplateResponse Source #

Create a value of VoiceTemplateResponse 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:languageCode:VoiceTemplateResponse', voiceTemplateResponse_languageCode - The code for the language that's used when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

$sel:arn:VoiceTemplateResponse', voiceTemplateResponse_arn - The Amazon Resource Name (ARN) of the message template.

$sel:body:VoiceTemplateResponse', voiceTemplateResponse_body - The text of the script that's used in messages that are based on the message template, in plain text format.

$sel:templateDescription:VoiceTemplateResponse', voiceTemplateResponse_templateDescription - The custom description of the message template.

$sel:defaultSubstitutions:VoiceTemplateResponse', voiceTemplateResponse_defaultSubstitutions - The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

$sel:version:VoiceTemplateResponse', voiceTemplateResponse_version - The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

$sel:voiceId:VoiceTemplateResponse', voiceTemplateResponse_voiceId - The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

$sel:tags:VoiceTemplateResponse', voiceTemplateResponse_tags - A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

$sel:lastModifiedDate:VoiceTemplateResponse', voiceTemplateResponse_lastModifiedDate - The date, in ISO 8601 format, when the message template was last modified.

$sel:creationDate:VoiceTemplateResponse', voiceTemplateResponse_creationDate - The date, in ISO 8601 format, when the message template was created.

$sel:templateName:VoiceTemplateResponse', voiceTemplateResponse_templateName - The name of the message template.

$sel:templateType:VoiceTemplateResponse', voiceTemplateResponse_templateType - The type of channel that the message template is designed for. For a voice template, this value is VOICE.

voiceTemplateResponse_languageCode :: Lens' VoiceTemplateResponse (Maybe Text) Source #

The code for the language that's used when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

voiceTemplateResponse_arn :: Lens' VoiceTemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the message template.

voiceTemplateResponse_body :: Lens' VoiceTemplateResponse (Maybe Text) Source #

The text of the script that's used in messages that are based on the message template, in plain text format.

voiceTemplateResponse_templateDescription :: Lens' VoiceTemplateResponse (Maybe Text) Source #

The custom description of the message template.

voiceTemplateResponse_defaultSubstitutions :: Lens' VoiceTemplateResponse (Maybe Text) Source #

The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

voiceTemplateResponse_version :: Lens' VoiceTemplateResponse (Maybe Text) Source #

The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.

voiceTemplateResponse_voiceId :: Lens' VoiceTemplateResponse (Maybe Text) Source #

The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

voiceTemplateResponse_tags :: Lens' VoiceTemplateResponse (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

voiceTemplateResponse_lastModifiedDate :: Lens' VoiceTemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was last modified.

voiceTemplateResponse_creationDate :: Lens' VoiceTemplateResponse Text Source #

The date, in ISO 8601 format, when the message template was created.

voiceTemplateResponse_templateType :: Lens' VoiceTemplateResponse TemplateType Source #

The type of channel that the message template is designed for. For a voice template, this value is VOICE.

WaitActivity

data WaitActivity Source #

Specifies the settings for a wait activity in a journey. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

See: newWaitActivity smart constructor.

Constructors

WaitActivity' 

Fields

  • nextActivity :: Maybe Text

    The unique identifier for the next activity to perform, after performing the wait activity.

  • waitTime :: Maybe WaitTime

    The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.

Instances

Instances details
Eq WaitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitActivity

Read WaitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitActivity

Show WaitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitActivity

Generic WaitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitActivity

Associated Types

type Rep WaitActivity :: Type -> Type #

NFData WaitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitActivity

Methods

rnf :: WaitActivity -> () #

Hashable WaitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitActivity

ToJSON WaitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitActivity

FromJSON WaitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitActivity

type Rep WaitActivity Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitActivity

type Rep WaitActivity = D1 ('MetaData "WaitActivity" "Amazonka.Pinpoint.Types.WaitActivity" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "WaitActivity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "waitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WaitTime))))

newWaitActivity :: WaitActivity Source #

Create a value of WaitActivity 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:nextActivity:WaitActivity', waitActivity_nextActivity - The unique identifier for the next activity to perform, after performing the wait activity.

$sel:waitTime:WaitActivity', waitActivity_waitTime - The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.

waitActivity_nextActivity :: Lens' WaitActivity (Maybe Text) Source #

The unique identifier for the next activity to perform, after performing the wait activity.

waitActivity_waitTime :: Lens' WaitActivity (Maybe WaitTime) Source #

The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.

WaitTime

data WaitTime Source #

Specifies a duration or a date and time that indicates when Amazon Pinpoint determines whether an activity's conditions have been met or an activity moves participants to the next activity in a journey.

See: newWaitTime smart constructor.

Constructors

WaitTime' 

Fields

  • waitFor :: Maybe Text

    The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

  • waitUntil :: Maybe Text

    The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

Instances

Instances details
Eq WaitTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitTime

Read WaitTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitTime

Show WaitTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitTime

Generic WaitTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitTime

Associated Types

type Rep WaitTime :: Type -> Type #

Methods

from :: WaitTime -> Rep WaitTime x #

to :: Rep WaitTime x -> WaitTime #

NFData WaitTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitTime

Methods

rnf :: WaitTime -> () #

Hashable WaitTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitTime

Methods

hashWithSalt :: Int -> WaitTime -> Int #

hash :: WaitTime -> Int #

ToJSON WaitTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitTime

FromJSON WaitTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitTime

type Rep WaitTime Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WaitTime

type Rep WaitTime = D1 ('MetaData "WaitTime" "Amazonka.Pinpoint.Types.WaitTime" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "WaitTime'" 'PrefixI 'True) (S1 ('MetaSel ('Just "waitFor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "waitUntil") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newWaitTime :: WaitTime Source #

Create a value of WaitTime 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:waitFor:WaitTime', waitTime_waitFor - The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

$sel:waitUntil:WaitTime', waitTime_waitUntil - The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

waitTime_waitFor :: Lens' WaitTime (Maybe Text) Source #

The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

waitTime_waitUntil :: Lens' WaitTime (Maybe Text) Source #

The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

WriteApplicationSettingsRequest

data WriteApplicationSettingsRequest Source #

Specifies the default settings for an application.

See: newWriteApplicationSettingsRequest smart constructor.

Constructors

WriteApplicationSettingsRequest' 

Fields

  • eventTaggingEnabled :: Maybe Bool
     
  • cloudWatchMetricsEnabled :: Maybe Bool

    Specifies whether to enable application-related alarms in Amazon CloudWatch.

  • limits :: Maybe CampaignLimits

    The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.

  • quietTime :: Maybe QuietTime

    The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
    • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
    • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

    To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.

  • campaignHook :: Maybe CampaignHook

    The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.

    To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.

Instances

Instances details
Eq WriteApplicationSettingsRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest

Read WriteApplicationSettingsRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest

Show WriteApplicationSettingsRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest

Generic WriteApplicationSettingsRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest

Associated Types

type Rep WriteApplicationSettingsRequest :: Type -> Type #

NFData WriteApplicationSettingsRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest

Hashable WriteApplicationSettingsRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest

ToJSON WriteApplicationSettingsRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest

type Rep WriteApplicationSettingsRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest

type Rep WriteApplicationSettingsRequest = D1 ('MetaData "WriteApplicationSettingsRequest" "Amazonka.Pinpoint.Types.WriteApplicationSettingsRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "WriteApplicationSettingsRequest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eventTaggingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "cloudWatchMetricsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "limits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignLimits)) :*: (S1 ('MetaSel ('Just "quietTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuietTime)) :*: S1 ('MetaSel ('Just "campaignHook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignHook))))))

newWriteApplicationSettingsRequest :: WriteApplicationSettingsRequest Source #

Create a value of WriteApplicationSettingsRequest 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:eventTaggingEnabled:WriteApplicationSettingsRequest', writeApplicationSettingsRequest_eventTaggingEnabled - Undocumented member.

$sel:cloudWatchMetricsEnabled:WriteApplicationSettingsRequest', writeApplicationSettingsRequest_cloudWatchMetricsEnabled - Specifies whether to enable application-related alarms in Amazon CloudWatch.

$sel:limits:WriteApplicationSettingsRequest', writeApplicationSettingsRequest_limits - The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.

$sel:quietTime:WriteApplicationSettingsRequest', writeApplicationSettingsRequest_quietTime - The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

  • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
  • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
  • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.

$sel:campaignHook:WriteApplicationSettingsRequest', writeApplicationSettingsRequest_campaignHook - The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.

To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.

writeApplicationSettingsRequest_cloudWatchMetricsEnabled :: Lens' WriteApplicationSettingsRequest (Maybe Bool) Source #

Specifies whether to enable application-related alarms in Amazon CloudWatch.

writeApplicationSettingsRequest_limits :: Lens' WriteApplicationSettingsRequest (Maybe CampaignLimits) Source #

The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.

writeApplicationSettingsRequest_quietTime :: Lens' WriteApplicationSettingsRequest (Maybe QuietTime) Source #

The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

  • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
  • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
  • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.

writeApplicationSettingsRequest_campaignHook :: Lens' WriteApplicationSettingsRequest (Maybe CampaignHook) Source #

The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.

To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.

WriteCampaignRequest

data WriteCampaignRequest Source #

Specifies the configuration and other settings for a campaign.

See: newWriteCampaignRequest smart constructor.

Constructors

WriteCampaignRequest' 

Fields

Instances

Instances details
Eq WriteCampaignRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteCampaignRequest

Read WriteCampaignRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteCampaignRequest

Show WriteCampaignRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteCampaignRequest

Generic WriteCampaignRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteCampaignRequest

Associated Types

type Rep WriteCampaignRequest :: Type -> Type #

NFData WriteCampaignRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteCampaignRequest

Methods

rnf :: WriteCampaignRequest -> () #

Hashable WriteCampaignRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteCampaignRequest

ToJSON WriteCampaignRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteCampaignRequest

type Rep WriteCampaignRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteCampaignRequest

type Rep WriteCampaignRequest = D1 ('MetaData "WriteCampaignRequest" "Amazonka.Pinpoint.Types.WriteCampaignRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "WriteCampaignRequest'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "customDeliveryConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomDeliveryConfiguration)) :*: S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Schedule)) :*: S1 ('MetaSel ('Just "templateConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateConfiguration)))) :*: ((S1 ('MetaSel ('Just "hook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignHook)) :*: S1 ('MetaSel ('Just "treatmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "limits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CampaignLimits)) :*: S1 ('MetaSel ('Just "isPaused") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "holdoutPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "treatmentDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "messageConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageConfiguration)))) :*: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "segmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "additionalTreatments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WriteTreatmentResource])) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "segmentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))))

newWriteCampaignRequest :: WriteCampaignRequest Source #

Create a value of WriteCampaignRequest 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:customDeliveryConfiguration:WriteCampaignRequest', writeCampaignRequest_customDeliveryConfiguration - The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.

$sel:priority:WriteCampaignRequest', writeCampaignRequest_priority - Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.

$sel:schedule:WriteCampaignRequest', writeCampaignRequest_schedule - The schedule settings for the campaign.

$sel:templateConfiguration:WriteCampaignRequest', writeCampaignRequest_templateConfiguration - The message template to use for the campaign.

$sel:hook:WriteCampaignRequest', writeCampaignRequest_hook - The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

$sel:treatmentName:WriteCampaignRequest', writeCampaignRequest_treatmentName - A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

$sel:limits:WriteCampaignRequest', writeCampaignRequest_limits - The messaging limits for the campaign.

$sel:isPaused:WriteCampaignRequest', writeCampaignRequest_isPaused - Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

$sel:name:WriteCampaignRequest', writeCampaignRequest_name - A custom name for the campaign.

$sel:holdoutPercent:WriteCampaignRequest', writeCampaignRequest_holdoutPercent - The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

$sel:treatmentDescription:WriteCampaignRequest', writeCampaignRequest_treatmentDescription - A custom description of the default treatment for the campaign.

$sel:messageConfiguration:WriteCampaignRequest', writeCampaignRequest_messageConfiguration - The message configuration settings for the campaign.

$sel:description:WriteCampaignRequest', writeCampaignRequest_description - A custom description of the campaign.

$sel:segmentId:WriteCampaignRequest', writeCampaignRequest_segmentId - The unique identifier for the segment to associate with the campaign.

$sel:additionalTreatments:WriteCampaignRequest', writeCampaignRequest_additionalTreatments - An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

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

$sel:segmentVersion:WriteCampaignRequest', writeCampaignRequest_segmentVersion - The version of the segment to associate with the campaign.

writeCampaignRequest_customDeliveryConfiguration :: Lens' WriteCampaignRequest (Maybe CustomDeliveryConfiguration) Source #

The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.

writeCampaignRequest_priority :: Lens' WriteCampaignRequest (Maybe Int) Source #

Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.

writeCampaignRequest_schedule :: Lens' WriteCampaignRequest (Maybe Schedule) Source #

The schedule settings for the campaign.

writeCampaignRequest_hook :: Lens' WriteCampaignRequest (Maybe CampaignHook) Source #

The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

writeCampaignRequest_treatmentName :: Lens' WriteCampaignRequest (Maybe Text) Source #

A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

writeCampaignRequest_isPaused :: Lens' WriteCampaignRequest (Maybe Bool) Source #

Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

writeCampaignRequest_holdoutPercent :: Lens' WriteCampaignRequest (Maybe Int) Source #

The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

writeCampaignRequest_treatmentDescription :: Lens' WriteCampaignRequest (Maybe Text) Source #

A custom description of the default treatment for the campaign.

writeCampaignRequest_segmentId :: Lens' WriteCampaignRequest (Maybe Text) Source #

The unique identifier for the segment to associate with the campaign.

writeCampaignRequest_additionalTreatments :: Lens' WriteCampaignRequest (Maybe [WriteTreatmentResource]) Source #

An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

writeCampaignRequest_tags :: Lens' WriteCampaignRequest (Maybe (HashMap Text Text)) Source #

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

writeCampaignRequest_segmentVersion :: Lens' WriteCampaignRequest (Maybe Int) Source #

The version of the segment to associate with the campaign.

WriteEventStream

data WriteEventStream Source #

Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.

See: newWriteEventStream smart constructor.

Constructors

WriteEventStream' 

Fields

  • roleArn :: Text

    The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

  • destinationStreamArn :: Text

    The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.

    For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name

    For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

Instances

Instances details
Eq WriteEventStream Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteEventStream

Read WriteEventStream Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteEventStream

Show WriteEventStream Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteEventStream

Generic WriteEventStream Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteEventStream

Associated Types

type Rep WriteEventStream :: Type -> Type #

NFData WriteEventStream Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteEventStream

Methods

rnf :: WriteEventStream -> () #

Hashable WriteEventStream Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteEventStream

ToJSON WriteEventStream Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteEventStream

type Rep WriteEventStream Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteEventStream

type Rep WriteEventStream = D1 ('MetaData "WriteEventStream" "Amazonka.Pinpoint.Types.WriteEventStream" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "WriteEventStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "destinationStreamArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newWriteEventStream Source #

Create a value of WriteEventStream 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:roleArn:WriteEventStream', writeEventStream_roleArn - The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

$sel:destinationStreamArn:WriteEventStream', writeEventStream_destinationStreamArn - The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.

For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name

For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

writeEventStream_roleArn :: Lens' WriteEventStream Text Source #

The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

writeEventStream_destinationStreamArn :: Lens' WriteEventStream Text Source #

The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.

For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name

For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

WriteJourneyRequest

data WriteJourneyRequest Source #

Specifies the configuration and other settings for a journey.

See: newWriteJourneyRequest smart constructor.

Constructors

WriteJourneyRequest' 

Fields

  • state :: Maybe State

    The status of the journey. Valid values are:

    • DRAFT - Saves the journey and doesn't publish it.
    • ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

    PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the Journey State resource.

  • lastModifiedDate :: Maybe Text

    The date, in ISO 8601 format, when the journey was last modified.

  • schedule :: Maybe JourneySchedule

    The schedule settings for the journey.

  • localTime :: Maybe Bool

    Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

  • activities :: Maybe (HashMap Text Activity)

    A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.

  • refreshOnSegmentUpdate :: Maybe Bool

    Specifies whether a journey should be refreshed on segment update.

  • limits :: Maybe JourneyLimits

    The messaging and entry limits for the journey.

  • waitForQuietTime :: Maybe Bool

    Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.

  • quietTime :: Maybe QuietTime

    The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
    • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
    • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

    If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

  • startActivity :: Maybe Text

    The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.

  • creationDate :: Maybe Text

    The date, in ISO 8601 format, when the journey was created.

  • startCondition :: Maybe StartCondition

    The segment that defines which users are participants in the journey.

  • refreshFrequency :: Maybe Text

    The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

  • name :: Text

    The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.

Instances

Instances details
Eq WriteJourneyRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteJourneyRequest

Read WriteJourneyRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteJourneyRequest

Show WriteJourneyRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteJourneyRequest

Generic WriteJourneyRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteJourneyRequest

Associated Types

type Rep WriteJourneyRequest :: Type -> Type #

NFData WriteJourneyRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteJourneyRequest

Methods

rnf :: WriteJourneyRequest -> () #

Hashable WriteJourneyRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteJourneyRequest

ToJSON WriteJourneyRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteJourneyRequest

type Rep WriteJourneyRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteJourneyRequest

type Rep WriteJourneyRequest = D1 ('MetaData "WriteJourneyRequest" "Amazonka.Pinpoint.Types.WriteJourneyRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "WriteJourneyRequest'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe State)) :*: (S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JourneySchedule)))) :*: ((S1 ('MetaSel ('Just "localTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "activities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Activity)))) :*: (S1 ('MetaSel ('Just "refreshOnSegmentUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "limits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JourneyLimits))))) :*: ((S1 ('MetaSel ('Just "waitForQuietTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "quietTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuietTime)) :*: S1 ('MetaSel ('Just "startActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "startCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StartCondition))) :*: (S1 ('MetaSel ('Just "refreshFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newWriteJourneyRequest Source #

Create a value of WriteJourneyRequest 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:state:WriteJourneyRequest', writeJourneyRequest_state - The status of the journey. Valid values are:

  • DRAFT - Saves the journey and doesn't publish it.
  • ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the Journey State resource.

$sel:lastModifiedDate:WriteJourneyRequest', writeJourneyRequest_lastModifiedDate - The date, in ISO 8601 format, when the journey was last modified.

$sel:schedule:WriteJourneyRequest', writeJourneyRequest_schedule - The schedule settings for the journey.

$sel:localTime:WriteJourneyRequest', writeJourneyRequest_localTime - Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

$sel:activities:WriteJourneyRequest', writeJourneyRequest_activities - A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.

$sel:refreshOnSegmentUpdate:WriteJourneyRequest', writeJourneyRequest_refreshOnSegmentUpdate - Specifies whether a journey should be refreshed on segment update.

$sel:limits:WriteJourneyRequest', writeJourneyRequest_limits - The messaging and entry limits for the journey.

$sel:waitForQuietTime:WriteJourneyRequest', writeJourneyRequest_waitForQuietTime - Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.

$sel:quietTime:WriteJourneyRequest', writeJourneyRequest_quietTime - The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

  • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
  • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
  • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

$sel:startActivity:WriteJourneyRequest', writeJourneyRequest_startActivity - The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.

$sel:creationDate:WriteJourneyRequest', writeJourneyRequest_creationDate - The date, in ISO 8601 format, when the journey was created.

$sel:startCondition:WriteJourneyRequest', writeJourneyRequest_startCondition - The segment that defines which users are participants in the journey.

$sel:refreshFrequency:WriteJourneyRequest', writeJourneyRequest_refreshFrequency - The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

$sel:name:WriteJourneyRequest', writeJourneyRequest_name - The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.

writeJourneyRequest_state :: Lens' WriteJourneyRequest (Maybe State) Source #

The status of the journey. Valid values are:

  • DRAFT - Saves the journey and doesn't publish it.
  • ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the Journey State resource.

writeJourneyRequest_lastModifiedDate :: Lens' WriteJourneyRequest (Maybe Text) Source #

The date, in ISO 8601 format, when the journey was last modified.

writeJourneyRequest_localTime :: Lens' WriteJourneyRequest (Maybe Bool) Source #

Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

writeJourneyRequest_activities :: Lens' WriteJourneyRequest (Maybe (HashMap Text Activity)) Source #

A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.

writeJourneyRequest_refreshOnSegmentUpdate :: Lens' WriteJourneyRequest (Maybe Bool) Source #

Specifies whether a journey should be refreshed on segment update.

writeJourneyRequest_limits :: Lens' WriteJourneyRequest (Maybe JourneyLimits) Source #

The messaging and entry limits for the journey.

writeJourneyRequest_waitForQuietTime :: Lens' WriteJourneyRequest (Maybe Bool) Source #

Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.

writeJourneyRequest_quietTime :: Lens' WriteJourneyRequest (Maybe QuietTime) Source #

The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

  • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
  • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
  • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

writeJourneyRequest_startActivity :: Lens' WriteJourneyRequest (Maybe Text) Source #

The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.

writeJourneyRequest_creationDate :: Lens' WriteJourneyRequest (Maybe Text) Source #

The date, in ISO 8601 format, when the journey was created.

writeJourneyRequest_startCondition :: Lens' WriteJourneyRequest (Maybe StartCondition) Source #

The segment that defines which users are participants in the journey.

writeJourneyRequest_refreshFrequency :: Lens' WriteJourneyRequest (Maybe Text) Source #

The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

writeJourneyRequest_name :: Lens' WriteJourneyRequest Text Source #

The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.

WriteSegmentRequest

data WriteSegmentRequest Source #

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

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

  • name :: Maybe Text

    The name of the segment.

  • dimensions :: Maybe SegmentDimensions

    The criteria that define the dimensions for the segment.

  • 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

Instances details
Eq WriteSegmentRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteSegmentRequest

Read WriteSegmentRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteSegmentRequest

Show WriteSegmentRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteSegmentRequest

Generic WriteSegmentRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteSegmentRequest

Associated Types

type Rep WriteSegmentRequest :: Type -> Type #

NFData WriteSegmentRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteSegmentRequest

Methods

rnf :: WriteSegmentRequest -> () #

Hashable WriteSegmentRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteSegmentRequest

ToJSON WriteSegmentRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteSegmentRequest

type Rep WriteSegmentRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteSegmentRequest

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

newWriteSegmentRequest :: WriteSegmentRequest Source #

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: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:name:WriteSegmentRequest', writeSegmentRequest_name - The name of the segment.

$sel:dimensions:WriteSegmentRequest', writeSegmentRequest_dimensions - The criteria that define the dimensions for the segment.

$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_segmentGroups :: Lens' WriteSegmentRequest (Maybe SegmentGroupList) Source #

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_dimensions :: Lens' WriteSegmentRequest (Maybe SegmentDimensions) Source #

The criteria that define the dimensions for the segment.

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

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.

WriteTreatmentResource

data WriteTreatmentResource Source #

Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

See: newWriteTreatmentResource smart constructor.

Constructors

WriteTreatmentResource' 

Fields

Instances

Instances details
Eq WriteTreatmentResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteTreatmentResource

Read WriteTreatmentResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteTreatmentResource

Show WriteTreatmentResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteTreatmentResource

Generic WriteTreatmentResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteTreatmentResource

Associated Types

type Rep WriteTreatmentResource :: Type -> Type #

NFData WriteTreatmentResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteTreatmentResource

Methods

rnf :: WriteTreatmentResource -> () #

Hashable WriteTreatmentResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteTreatmentResource

ToJSON WriteTreatmentResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteTreatmentResource

type Rep WriteTreatmentResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.WriteTreatmentResource

type Rep WriteTreatmentResource = D1 ('MetaData "WriteTreatmentResource" "Amazonka.Pinpoint.Types.WriteTreatmentResource" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "WriteTreatmentResource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "customDeliveryConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomDeliveryConfiguration)) :*: (S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Schedule)) :*: S1 ('MetaSel ('Just "templateConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateConfiguration)))) :*: ((S1 ('MetaSel ('Just "treatmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "treatmentDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "messageConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageConfiguration)) :*: S1 ('MetaSel ('Just "sizePercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newWriteTreatmentResource Source #

Create a value of WriteTreatmentResource 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:customDeliveryConfiguration:WriteTreatmentResource', writeTreatmentResource_customDeliveryConfiguration - The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

$sel:schedule:WriteTreatmentResource', writeTreatmentResource_schedule - The schedule settings for the treatment.

$sel:templateConfiguration:WriteTreatmentResource', writeTreatmentResource_templateConfiguration - The message template to use for the treatment.

$sel:treatmentName:WriteTreatmentResource', writeTreatmentResource_treatmentName - A custom name for the treatment.

$sel:treatmentDescription:WriteTreatmentResource', writeTreatmentResource_treatmentDescription - A custom description of the treatment.

$sel:messageConfiguration:WriteTreatmentResource', writeTreatmentResource_messageConfiguration - The message configuration settings for the treatment.

$sel:sizePercent:WriteTreatmentResource', writeTreatmentResource_sizePercent - The allocated percentage of users (segment members) to send the treatment to.

writeTreatmentResource_customDeliveryConfiguration :: Lens' WriteTreatmentResource (Maybe CustomDeliveryConfiguration) Source #

The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

writeTreatmentResource_sizePercent :: Lens' WriteTreatmentResource Int Source #

The allocated percentage of users (segment members) to send the treatment to.