amazonka-pinpoint-1.6.0: Amazon Pinpoint SDK.

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

Network.AWS.Pinpoint

Contents

Description

Amazon Pinpoint makes it easy to run targeted campaigns to drive user engagement in mobile apps. Amazon Pinpoint helps you understand user behavior, define which users to target, determine which messages to send, schedule the best time to deliver the messages, and then track the results of your campaign.

Targeted push notifications based on app usage trends and user behavior have become a popular approach for mobile app user engagement because response rates are often several times higher than tradition email marketing campaigns. By using targeted push notifications, you can increase message relevance and effectiveness, measure engagement, and continually improve your campaigns.

Getting started with Amazon Pinpoint is easy. First, AWS Mobile Hub guides you through the process to integrate the AWS Mobile SDK with your app. Next, you define your target segments, campaign message, and specify the delivery schedule. Once your campaign is running, Pinpoint provides metrics so you can run analytics and track the impact of your campaign.

With Amazon Pinpoint, there are no upfront setup costs, and no fixed monthly cost. You only pay for the number of users your campaign targets, the messages you send, and the events you collect, so you can start small and scale as your application grows.

Synopsis

Service Configuration

pinpoint :: Service #

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

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by Pinpoint.

ForbiddenException

NotFoundException

TooManyRequestsException

InternalServerErrorException

MethodNotAllowedException

BadRequestException

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

GetGCMChannel

GetSegmentImportJobs

SendMessages

GetImportJob

GetAPNSVoipSandboxChannel

GetSegmentVersions

DeleteCampaign

UpdateCampaign

GetSegmentVersion

CreateExportJob

CreateSegment

UpdateADMChannel

DeleteADMChannel

DeleteEndpoint

UpdateEndpoint

CreateCampaign

GetExportJob

GetEndpoint

GetSegment

UpdateEndpointsBatch

GetADMChannel

GetCampaign

DeleteApp

UpdateAPNSVoipSandboxChannel

DeleteAPNSVoipSandboxChannel

UpdateGCMChannel

DeleteGCMChannel

GetCampaignActivities

GetEventStream

DeleteEmailChannel

UpdateEmailChannel

GetBaiduChannel

DeleteAPNSChannel

UpdateAPNSChannel

PutEventStream

DeleteEventStream

GetCampaignVersions

GetAPNSChannel

GetApps

GetAPNSSandboxChannel

GetImportJobs

DeleteSmsChannel

UpdateSmsChannel

GetApp

GetCampaignVersion

DeleteSegment

UpdateSegment

CreateApp

GetSegmentExportJobs

GetSmsChannel

DeleteAPNSSandboxChannel

UpdateAPNSSandboxChannel

GetCampaigns

UpdateApplicationSettings

GetSegments

GetExportJobs

CreateImportJob

DeleteAPNSVoipChannel

UpdateAPNSVoipChannel

SendUsersMessages

GetApplicationSettings

DeleteBaiduChannel

UpdateBaiduChannel

GetAPNSVoipChannel

GetEmailChannel

Types

Action

data Action #

Constructors

DeepLink 
OpenApp 
URL 

Instances

Bounded Action # 
Enum Action # 
Eq Action # 

Methods

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

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

Data Action # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Action -> c Action #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Action #

toConstr :: Action -> Constr #

dataTypeOf :: Action -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Action) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Action) #

gmapT :: (forall b. Data b => b -> b) -> Action -> Action #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Action -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Action -> r #

gmapQ :: (forall d. Data d => d -> u) -> Action -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Action -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Action -> m Action #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Action -> m Action #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Action -> m Action #

Ord Action # 
Read Action # 
Show Action # 
Generic Action # 

Associated Types

type Rep Action :: * -> * #

Methods

from :: Action -> Rep Action x #

to :: Rep Action x -> Action #

Hashable Action # 

Methods

hashWithSalt :: Int -> Action -> Int #

hash :: Action -> Int #

ToJSON Action # 
FromJSON Action # 
NFData Action # 

Methods

rnf :: Action -> () #

ToHeader Action # 

Methods

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

ToQuery Action # 
ToByteString Action # 

Methods

toBS :: Action -> ByteString #

FromText Action # 

Methods

parser :: Parser Action #

ToText Action # 

Methods

toText :: Action -> Text #

type Rep Action # 
type Rep Action = D1 * (MetaData "Action" "Network.AWS.Pinpoint.Types.Sum" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) ((:+:) * (C1 * (MetaCons "DeepLink" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "OpenApp" PrefixI False) (U1 *)) (C1 * (MetaCons "URL" PrefixI False) (U1 *))))

AttributeType

data AttributeType #

Constructors

Exclusive 
Inclusive 

Instances

Bounded AttributeType # 
Enum AttributeType # 
Eq AttributeType # 
Data AttributeType # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AttributeType -> c AttributeType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AttributeType #

toConstr :: AttributeType -> Constr #

dataTypeOf :: AttributeType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AttributeType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AttributeType) #

gmapT :: (forall b. Data b => b -> b) -> AttributeType -> AttributeType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AttributeType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AttributeType -> r #

gmapQ :: (forall d. Data d => d -> u) -> AttributeType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AttributeType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AttributeType -> m AttributeType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AttributeType -> m AttributeType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AttributeType -> m AttributeType #

Ord AttributeType # 
Read AttributeType # 
Show AttributeType # 
Generic AttributeType # 

Associated Types

type Rep AttributeType :: * -> * #

Hashable AttributeType # 
ToJSON AttributeType # 
FromJSON AttributeType # 
NFData AttributeType # 

Methods

rnf :: AttributeType -> () #

ToHeader AttributeType # 
ToQuery AttributeType # 
ToByteString AttributeType # 
FromText AttributeType # 
ToText AttributeType # 

Methods

toText :: AttributeType -> Text #

type Rep AttributeType # 
type Rep AttributeType = D1 * (MetaData "AttributeType" "Network.AWS.Pinpoint.Types.Sum" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) ((:+:) * (C1 * (MetaCons "Exclusive" PrefixI False) (U1 *)) (C1 * (MetaCons "Inclusive" PrefixI False) (U1 *)))

CampaignStatus

data CampaignStatus #

Instances

Bounded CampaignStatus # 
Enum CampaignStatus # 
Eq CampaignStatus # 
Data CampaignStatus # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CampaignStatus -> c CampaignStatus #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CampaignStatus #

toConstr :: CampaignStatus -> Constr #

dataTypeOf :: CampaignStatus -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CampaignStatus) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CampaignStatus) #

gmapT :: (forall b. Data b => b -> b) -> CampaignStatus -> CampaignStatus #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CampaignStatus -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CampaignStatus -> r #

gmapQ :: (forall d. Data d => d -> u) -> CampaignStatus -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CampaignStatus -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CampaignStatus -> m CampaignStatus #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CampaignStatus -> m CampaignStatus #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CampaignStatus -> m CampaignStatus #

Ord CampaignStatus # 
Read CampaignStatus # 
Show CampaignStatus # 
Generic CampaignStatus # 

Associated Types

type Rep CampaignStatus :: * -> * #

Hashable CampaignStatus # 
FromJSON CampaignStatus # 
NFData CampaignStatus # 

Methods

rnf :: CampaignStatus -> () #

ToHeader CampaignStatus # 
ToQuery CampaignStatus # 
ToByteString CampaignStatus # 
FromText CampaignStatus # 
ToText CampaignStatus # 
type Rep CampaignStatus # 
type Rep CampaignStatus = D1 * (MetaData "CampaignStatus" "Network.AWS.Pinpoint.Types.Sum" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) ((:+:) * ((:+:) * (C1 * (MetaCons "Completed" PrefixI False) (U1 *)) (C1 * (MetaCons "Executing" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "Paused" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "PendingNextRun" PrefixI False) (U1 *)) (C1 * (MetaCons "Scheduled" PrefixI False) (U1 *)))))

ChannelType

data ChannelType #

Instances

Bounded ChannelType # 
Enum ChannelType # 
Eq ChannelType # 
Data ChannelType # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ChannelType -> c ChannelType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ChannelType #

toConstr :: ChannelType -> Constr #

dataTypeOf :: ChannelType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ChannelType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ChannelType) #

gmapT :: (forall b. Data b => b -> b) -> ChannelType -> ChannelType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ChannelType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ChannelType -> r #

gmapQ :: (forall d. Data d => d -> u) -> ChannelType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ChannelType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ChannelType -> m ChannelType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ChannelType -> m ChannelType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ChannelType -> m ChannelType #

Ord ChannelType # 
Read ChannelType # 
Show ChannelType # 
Generic ChannelType # 

Associated Types

type Rep ChannelType :: * -> * #

Hashable ChannelType # 
ToJSON ChannelType # 
FromJSON ChannelType # 
NFData ChannelType # 

Methods

rnf :: ChannelType -> () #

ToHeader ChannelType # 
ToQuery ChannelType # 
ToByteString ChannelType # 
FromText ChannelType # 
ToText ChannelType # 

Methods

toText :: ChannelType -> Text #

type Rep ChannelType # 
type Rep ChannelType = D1 * (MetaData "ChannelType" "Network.AWS.Pinpoint.Types.Sum" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "ADM" PrefixI False) (U1 *)) (C1 * (MetaCons "APNS" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "APNSSandbox" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "APNSVoip" PrefixI False) (U1 *)) (C1 * (MetaCons "APNSVoipSandbox" PrefixI False) (U1 *))))) ((:+:) * ((:+:) * (C1 * (MetaCons "Baidu" PrefixI False) (U1 *)) (C1 * (MetaCons "Custom" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "Email" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "GCM" PrefixI False) (U1 *)) (C1 * (MetaCons "Sms" PrefixI False) (U1 *))))))

DefinitionFormat

data DefinitionFormat #

Constructors

CSV 
JSON 

Instances

Bounded DefinitionFormat # 
Enum DefinitionFormat # 
Eq DefinitionFormat # 
Data DefinitionFormat # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DefinitionFormat -> c DefinitionFormat #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DefinitionFormat #

toConstr :: DefinitionFormat -> Constr #

dataTypeOf :: DefinitionFormat -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DefinitionFormat) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DefinitionFormat) #

gmapT :: (forall b. Data b => b -> b) -> DefinitionFormat -> DefinitionFormat #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DefinitionFormat -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DefinitionFormat -> r #

gmapQ :: (forall d. Data d => d -> u) -> DefinitionFormat -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DefinitionFormat -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DefinitionFormat -> m DefinitionFormat #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DefinitionFormat -> m DefinitionFormat #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DefinitionFormat -> m DefinitionFormat #

Ord DefinitionFormat # 
Read DefinitionFormat # 
Show DefinitionFormat # 
Generic DefinitionFormat # 
Hashable DefinitionFormat # 
ToJSON DefinitionFormat # 
FromJSON DefinitionFormat # 
NFData DefinitionFormat # 

Methods

rnf :: DefinitionFormat -> () #

ToHeader DefinitionFormat # 
ToQuery DefinitionFormat # 
ToByteString DefinitionFormat # 
FromText DefinitionFormat # 
ToText DefinitionFormat # 
type Rep DefinitionFormat # 
type Rep DefinitionFormat = D1 * (MetaData "DefinitionFormat" "Network.AWS.Pinpoint.Types.Sum" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) ((:+:) * (C1 * (MetaCons "CSV" PrefixI False) (U1 *)) (C1 * (MetaCons "JSON" PrefixI False) (U1 *)))

DeliveryStatus

data DeliveryStatus #

Instances

Bounded DeliveryStatus # 
Enum DeliveryStatus # 
Eq DeliveryStatus # 
Data DeliveryStatus # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeliveryStatus -> c DeliveryStatus #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeliveryStatus #

toConstr :: DeliveryStatus -> Constr #

dataTypeOf :: DeliveryStatus -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeliveryStatus) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeliveryStatus) #

gmapT :: (forall b. Data b => b -> b) -> DeliveryStatus -> DeliveryStatus #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeliveryStatus -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeliveryStatus -> r #

gmapQ :: (forall d. Data d => d -> u) -> DeliveryStatus -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeliveryStatus -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeliveryStatus -> m DeliveryStatus #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeliveryStatus -> m DeliveryStatus #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeliveryStatus -> m DeliveryStatus #

Ord DeliveryStatus # 
Read DeliveryStatus # 
Show DeliveryStatus # 
Generic DeliveryStatus # 

Associated Types

type Rep DeliveryStatus :: * -> * #

Hashable DeliveryStatus # 
FromJSON DeliveryStatus # 
NFData DeliveryStatus # 

Methods

rnf :: DeliveryStatus -> () #

ToHeader DeliveryStatus # 
ToQuery DeliveryStatus # 
ToByteString DeliveryStatus # 
FromText DeliveryStatus # 
ToText DeliveryStatus # 
type Rep DeliveryStatus # 
type Rep DeliveryStatus = D1 * (MetaData "DeliveryStatus" "Network.AWS.Pinpoint.Types.Sum" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) ((:+:) * ((:+:) * (C1 * (MetaCons "Duplicate" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "OptOut" PrefixI False) (U1 *)) (C1 * (MetaCons "PermanentFailure" PrefixI False) (U1 *)))) ((:+:) * ((:+:) * (C1 * (MetaCons "Successful" PrefixI False) (U1 *)) (C1 * (MetaCons "TemporaryFailure" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "Throttled" PrefixI False) (U1 *)) (C1 * (MetaCons "UnknownFailure" PrefixI False) (U1 *)))))

DimensionType

data DimensionType #

Constructors

DTExclusive 
DTInclusive 

Instances

Bounded DimensionType # 
Enum DimensionType # 
Eq DimensionType # 
Data DimensionType # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DimensionType -> c DimensionType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DimensionType #

toConstr :: DimensionType -> Constr #

dataTypeOf :: DimensionType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DimensionType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DimensionType) #

gmapT :: (forall b. Data b => b -> b) -> DimensionType -> DimensionType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DimensionType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DimensionType -> r #

gmapQ :: (forall d. Data d => d -> u) -> DimensionType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DimensionType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DimensionType -> m DimensionType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DimensionType -> m DimensionType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DimensionType -> m DimensionType #

Ord DimensionType # 
Read DimensionType # 
Show DimensionType # 
Generic DimensionType # 

Associated Types

type Rep DimensionType :: * -> * #

Hashable DimensionType # 
ToJSON DimensionType # 
FromJSON DimensionType # 
NFData DimensionType # 

Methods

rnf :: DimensionType -> () #

ToHeader DimensionType # 
ToQuery DimensionType # 
ToByteString DimensionType # 
FromText DimensionType # 
ToText DimensionType # 

Methods

toText :: DimensionType -> Text #

type Rep DimensionType # 
type Rep DimensionType = D1 * (MetaData "DimensionType" "Network.AWS.Pinpoint.Types.Sum" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) ((:+:) * (C1 * (MetaCons "DTExclusive" PrefixI False) (U1 *)) (C1 * (MetaCons "DTInclusive" PrefixI False) (U1 *)))

Duration

data Duration #

Constructors

Day14 
Day30 
Day7 
Hr24 

Instances

Bounded Duration # 
Enum Duration # 
Eq Duration # 
Data Duration # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Duration -> c Duration #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Duration #

toConstr :: Duration -> Constr #

dataTypeOf :: Duration -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Duration) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Duration) #

gmapT :: (forall b. Data b => b -> b) -> Duration -> Duration #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Duration -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Duration -> r #

gmapQ :: (forall d. Data d => d -> u) -> Duration -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Duration -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Duration -> m Duration #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Duration -> m Duration #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Duration -> m Duration #

Ord Duration # 
Read Duration # 
Show Duration # 
Generic Duration # 

Associated Types

type Rep Duration :: * -> * #

Methods

from :: Duration -> Rep Duration x #

to :: Rep Duration x -> Duration #

Hashable Duration # 

Methods

hashWithSalt :: Int -> Duration -> Int #

hash :: Duration -> Int #

ToJSON Duration # 
FromJSON Duration # 
NFData Duration # 

Methods

rnf :: Duration -> () #

ToHeader Duration # 

Methods

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

ToQuery Duration # 
ToByteString Duration # 

Methods

toBS :: Duration -> ByteString #

FromText Duration # 
ToText Duration # 

Methods

toText :: Duration -> Text #

type Rep Duration # 
type Rep Duration = D1 * (MetaData "Duration" "Network.AWS.Pinpoint.Types.Sum" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) ((:+:) * ((:+:) * (C1 * (MetaCons "Day14" PrefixI False) (U1 *)) (C1 * (MetaCons "Day30" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "Day7" PrefixI False) (U1 *)) (C1 * (MetaCons "Hr24" PrefixI False) (U1 *))))

Frequency

data Frequency #

Constructors

Daily 
Hourly 
Monthly 
Once 
Weekly 

Instances

Bounded Frequency # 
Enum Frequency # 
Eq Frequency # 
Data Frequency # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Frequency -> c Frequency #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Frequency #

toConstr :: Frequency -> Constr #

dataTypeOf :: Frequency -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Frequency) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Frequency) #

gmapT :: (forall b. Data b => b -> b) -> Frequency -> Frequency #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Frequency -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Frequency -> r #

gmapQ :: (forall d. Data d => d -> u) -> Frequency -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Frequency -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Frequency -> m Frequency #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Frequency -> m Frequency #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Frequency -> m Frequency #

Ord Frequency # 
Read Frequency # 
Show Frequency # 
Generic Frequency # 

Associated Types

type Rep Frequency :: * -> * #

Hashable Frequency # 
ToJSON Frequency # 
FromJSON Frequency # 
NFData Frequency # 

Methods

rnf :: Frequency -> () #

ToHeader Frequency # 
ToQuery Frequency # 
ToByteString Frequency # 

Methods

toBS :: Frequency -> ByteString #

FromText Frequency # 
ToText Frequency # 

Methods

toText :: Frequency -> Text #

type Rep Frequency # 
type Rep Frequency = D1 * (MetaData "Frequency" "Network.AWS.Pinpoint.Types.Sum" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) ((:+:) * ((:+:) * (C1 * (MetaCons "Daily" PrefixI False) (U1 *)) (C1 * (MetaCons "Hourly" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "Monthly" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "Once" PrefixI False) (U1 *)) (C1 * (MetaCons "Weekly" PrefixI False) (U1 *)))))

JobStatus

data JobStatus #

Instances

Bounded JobStatus # 
Enum JobStatus # 
Eq JobStatus # 
Data JobStatus # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> JobStatus -> c JobStatus #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c JobStatus #

toConstr :: JobStatus -> Constr #

dataTypeOf :: JobStatus -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c JobStatus) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c JobStatus) #

gmapT :: (forall b. Data b => b -> b) -> JobStatus -> JobStatus #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> JobStatus -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> JobStatus -> r #

gmapQ :: (forall d. Data d => d -> u) -> JobStatus -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> JobStatus -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> JobStatus -> m JobStatus #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> JobStatus -> m JobStatus #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> JobStatus -> m JobStatus #

Ord JobStatus # 
Read JobStatus # 
Show JobStatus # 
Generic JobStatus # 

Associated Types

type Rep JobStatus :: * -> * #

Hashable JobStatus # 
FromJSON JobStatus # 
NFData JobStatus # 

Methods

rnf :: JobStatus -> () #

ToHeader JobStatus # 
ToQuery JobStatus # 
ToByteString JobStatus # 

Methods

toBS :: JobStatus -> ByteString #

FromText JobStatus # 
ToText JobStatus # 

Methods

toText :: JobStatus -> Text #

type Rep JobStatus # 
type Rep JobStatus = D1 * (MetaData "JobStatus" "Network.AWS.Pinpoint.Types.Sum" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) ((:+:) * ((:+:) * (C1 * (MetaCons "JSCompleted" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "JSCompleting" PrefixI False) (U1 *)) (C1 * (MetaCons "JSCreated" PrefixI False) (U1 *)))) ((:+:) * ((:+:) * (C1 * (MetaCons "JSFailed" PrefixI False) (U1 *)) (C1 * (MetaCons "JSFailing" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "JSInitializing" PrefixI False) (U1 *)) (C1 * (MetaCons "JSProcessing" PrefixI False) (U1 *)))))

MessageType

data MessageType #

Constructors

Promotional 
Transactional 

Instances

Bounded MessageType # 
Enum MessageType # 
Eq MessageType # 
Data MessageType # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MessageType -> c MessageType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MessageType #

toConstr :: MessageType -> Constr #

dataTypeOf :: MessageType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c MessageType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MessageType) #

gmapT :: (forall b. Data b => b -> b) -> MessageType -> MessageType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MessageType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MessageType -> r #

gmapQ :: (forall d. Data d => d -> u) -> MessageType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> MessageType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MessageType -> m MessageType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MessageType -> m MessageType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MessageType -> m MessageType #

Ord MessageType # 
Read MessageType # 
Show MessageType # 
Generic MessageType # 

Associated Types

type Rep MessageType :: * -> * #

Hashable MessageType # 
ToJSON MessageType # 
FromJSON MessageType # 
NFData MessageType # 

Methods

rnf :: MessageType -> () #

ToHeader MessageType # 
ToQuery MessageType # 
ToByteString MessageType # 
FromText MessageType # 
ToText MessageType # 

Methods

toText :: MessageType -> Text #

type Rep MessageType # 
type Rep MessageType = D1 * (MetaData "MessageType" "Network.AWS.Pinpoint.Types.Sum" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) ((:+:) * (C1 * (MetaCons "Promotional" PrefixI False) (U1 *)) (C1 * (MetaCons "Transactional" PrefixI False) (U1 *)))

Mode

data Mode #

Constructors

Delivery 
Filter 

Instances

Bounded Mode # 
Enum Mode # 

Methods

succ :: Mode -> Mode #

pred :: Mode -> Mode #

toEnum :: Int -> Mode #

fromEnum :: Mode -> Int #

enumFrom :: Mode -> [Mode] #

enumFromThen :: Mode -> Mode -> [Mode] #

enumFromTo :: Mode -> Mode -> [Mode] #

enumFromThenTo :: Mode -> Mode -> Mode -> [Mode] #

Eq Mode # 

Methods

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

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

Data Mode # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Mode -> c Mode #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Mode #

toConstr :: Mode -> Constr #

dataTypeOf :: Mode -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Mode) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Mode) #

gmapT :: (forall b. Data b => b -> b) -> Mode -> Mode #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Mode -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Mode -> r #

gmapQ :: (forall d. Data d => d -> u) -> Mode -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Mode -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Mode -> m Mode #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Mode -> m Mode #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Mode -> m Mode #

Ord 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 # 
Show Mode # 

Methods

showsPrec :: Int -> Mode -> ShowS #

show :: Mode -> String #

showList :: [Mode] -> ShowS #

Generic Mode # 

Associated Types

type Rep Mode :: * -> * #

Methods

from :: Mode -> Rep Mode x #

to :: Rep Mode x -> Mode #

Hashable Mode # 

Methods

hashWithSalt :: Int -> Mode -> Int #

hash :: Mode -> Int #

ToJSON Mode # 
FromJSON Mode # 
NFData Mode # 

Methods

rnf :: Mode -> () #

ToHeader Mode # 

Methods

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

ToQuery Mode # 

Methods

toQuery :: Mode -> QueryString #

ToByteString Mode # 

Methods

toBS :: Mode -> ByteString #

FromText Mode # 

Methods

parser :: Parser Mode #

ToText Mode # 

Methods

toText :: Mode -> Text #

type Rep Mode # 
type Rep Mode = D1 * (MetaData "Mode" "Network.AWS.Pinpoint.Types.Sum" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) ((:+:) * (C1 * (MetaCons "Delivery" PrefixI False) (U1 *)) (C1 * (MetaCons "Filter" PrefixI False) (U1 *)))

RecencyType

data RecencyType #

Constructors

Active 
Inactive 

Instances

Bounded RecencyType # 
Enum RecencyType # 
Eq RecencyType # 
Data RecencyType # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RecencyType -> c RecencyType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RecencyType #

toConstr :: RecencyType -> Constr #

dataTypeOf :: RecencyType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RecencyType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RecencyType) #

gmapT :: (forall b. Data b => b -> b) -> RecencyType -> RecencyType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RecencyType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RecencyType -> r #

gmapQ :: (forall d. Data d => d -> u) -> RecencyType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RecencyType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RecencyType -> m RecencyType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RecencyType -> m RecencyType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RecencyType -> m RecencyType #

Ord RecencyType # 
Read RecencyType # 
Show RecencyType # 
Generic RecencyType # 

Associated Types

type Rep RecencyType :: * -> * #

Hashable RecencyType # 
ToJSON RecencyType # 
FromJSON RecencyType # 
NFData RecencyType # 

Methods

rnf :: RecencyType -> () #

ToHeader RecencyType # 
ToQuery RecencyType # 
ToByteString RecencyType # 
FromText RecencyType # 
ToText RecencyType # 

Methods

toText :: RecencyType -> Text #

type Rep RecencyType # 
type Rep RecencyType = D1 * (MetaData "RecencyType" "Network.AWS.Pinpoint.Types.Sum" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) ((:+:) * (C1 * (MetaCons "Active" PrefixI False) (U1 *)) (C1 * (MetaCons "Inactive" PrefixI False) (U1 *)))

SegmentType

data SegmentType #

Constructors

Dimensional 
Import 

Instances

Bounded SegmentType # 
Enum SegmentType # 
Eq SegmentType # 
Data SegmentType # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SegmentType -> c SegmentType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SegmentType #

toConstr :: SegmentType -> Constr #

dataTypeOf :: SegmentType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SegmentType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SegmentType) #

gmapT :: (forall b. Data b => b -> b) -> SegmentType -> SegmentType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SegmentType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SegmentType -> r #

gmapQ :: (forall d. Data d => d -> u) -> SegmentType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SegmentType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SegmentType -> m SegmentType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentType -> m SegmentType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentType -> m SegmentType #

Ord SegmentType # 
Read SegmentType # 
Show SegmentType # 
Generic SegmentType # 

Associated Types

type Rep SegmentType :: * -> * #

Hashable SegmentType # 
FromJSON SegmentType # 
NFData SegmentType # 

Methods

rnf :: SegmentType -> () #

ToHeader SegmentType # 
ToQuery SegmentType # 
ToByteString SegmentType # 
FromText SegmentType # 
ToText SegmentType # 

Methods

toText :: SegmentType -> Text #

type Rep SegmentType # 
type Rep SegmentType = D1 * (MetaData "SegmentType" "Network.AWS.Pinpoint.Types.Sum" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) ((:+:) * (C1 * (MetaCons "Dimensional" PrefixI False) (U1 *)) (C1 * (MetaCons "Import" PrefixI False) (U1 *)))

ADMChannelRequest

data ADMChannelRequest #

Amazon Device Messaging channel definition.

See: aDMChannelRequest smart constructor.

Instances

Eq ADMChannelRequest # 
Data ADMChannelRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ADMChannelRequest -> c ADMChannelRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ADMChannelRequest #

toConstr :: ADMChannelRequest -> Constr #

dataTypeOf :: ADMChannelRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ADMChannelRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ADMChannelRequest) #

gmapT :: (forall b. Data b => b -> b) -> ADMChannelRequest -> ADMChannelRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ADMChannelRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ADMChannelRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> ADMChannelRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ADMChannelRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ADMChannelRequest -> m ADMChannelRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ADMChannelRequest -> m ADMChannelRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ADMChannelRequest -> m ADMChannelRequest #

Read ADMChannelRequest # 
Show ADMChannelRequest # 
Generic ADMChannelRequest # 
Hashable ADMChannelRequest # 
ToJSON ADMChannelRequest # 
NFData ADMChannelRequest # 

Methods

rnf :: ADMChannelRequest -> () #

type Rep ADMChannelRequest # 
type Rep ADMChannelRequest = D1 * (MetaData "ADMChannelRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "ADMChannelRequest'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_admcrClientId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_admcrClientSecret") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_admcrEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))))

aDMChannelRequest :: ADMChannelRequest #

Creates a value of ADMChannelRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

admcrClientId :: Lens' ADMChannelRequest (Maybe Text) #

Client ID as gotten from Amazon

admcrClientSecret :: Lens' ADMChannelRequest (Maybe Text) #

Client secret as gotten from Amazon

admcrEnabled :: Lens' ADMChannelRequest (Maybe Bool) #

If the channel is enabled for sending messages.

ADMChannelResponse

data ADMChannelResponse #

Amazon Device Messaging channel definition.

See: aDMChannelResponse smart constructor.

Instances

Eq ADMChannelResponse # 
Data ADMChannelResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ADMChannelResponse -> c ADMChannelResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ADMChannelResponse #

toConstr :: ADMChannelResponse -> Constr #

dataTypeOf :: ADMChannelResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ADMChannelResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ADMChannelResponse) #

gmapT :: (forall b. Data b => b -> b) -> ADMChannelResponse -> ADMChannelResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ADMChannelResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ADMChannelResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ADMChannelResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ADMChannelResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ADMChannelResponse -> m ADMChannelResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ADMChannelResponse -> m ADMChannelResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ADMChannelResponse -> m ADMChannelResponse #

Read ADMChannelResponse # 
Show ADMChannelResponse # 
Generic ADMChannelResponse # 
Hashable ADMChannelResponse # 
FromJSON ADMChannelResponse # 
NFData ADMChannelResponse # 

Methods

rnf :: ADMChannelResponse -> () #

type Rep ADMChannelResponse # 

aDMChannelResponse :: ADMChannelResponse #

Creates a value of ADMChannelResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

admcPlatform :: Lens' ADMChannelResponse (Maybe Text) #

Platform type. Will be ADM

admcLastModifiedDate :: Lens' ADMChannelResponse (Maybe Text) #

Last date this was updated

admcEnabled :: Lens' ADMChannelResponse (Maybe Bool) #

If the channel is enabled for sending messages.

admcIsArchived :: Lens' ADMChannelResponse (Maybe Bool) #

Is this channel archived

admcApplicationId :: Lens' ADMChannelResponse (Maybe Text) #

The ID of the application to which the channel applies.

admcId :: Lens' ADMChannelResponse (Maybe Text) #

Channel ID. Not used, only for backwards compatibility.

admcCreationDate :: Lens' ADMChannelResponse (Maybe Text) #

When was this segment created

admcLastModifiedBy :: Lens' ADMChannelResponse (Maybe Text) #

Who last updated this entry

admcHasCredential :: Lens' ADMChannelResponse (Maybe Bool) #

Indicates whether the channel is configured with ADM credentials. Amazon Pinpoint uses your credentials to authenticate push notifications with ADM. Provide your credentials by setting the ClientId and ClientSecret attributes.

ADMMessage

data ADMMessage #

ADM Message.

See: aDMMessage smart constructor.

Instances

Eq ADMMessage # 
Data ADMMessage # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ADMMessage -> c ADMMessage #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ADMMessage #

toConstr :: ADMMessage -> Constr #

dataTypeOf :: ADMMessage -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ADMMessage) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ADMMessage) #

gmapT :: (forall b. Data b => b -> b) -> ADMMessage -> ADMMessage #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ADMMessage -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ADMMessage -> r #

gmapQ :: (forall d. Data d => d -> u) -> ADMMessage -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ADMMessage -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ADMMessage -> m ADMMessage #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ADMMessage -> m ADMMessage #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ADMMessage -> m ADMMessage #

Read ADMMessage # 
Show ADMMessage # 
Generic ADMMessage # 

Associated Types

type Rep ADMMessage :: * -> * #

Hashable ADMMessage # 
ToJSON ADMMessage # 
NFData ADMMessage # 

Methods

rnf :: ADMMessage -> () #

type Rep ADMMessage # 
type Rep ADMMessage = D1 * (MetaData "ADMMessage" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "ADMMessage'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_admmSubstitutions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text [Text])))) (S1 * (MetaSel (Just Symbol "_admmExpiresAfter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_admmMD5") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_admmSilentPush") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_admmImageIconURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_admmRawContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_admmData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))) (S1 * (MetaSel (Just Symbol "_admmSmallImageIconURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_admmBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_admmURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_admmSound") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_admmAction") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Action))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_admmImageURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_admmConsolidationKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_admmTitle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_admmIconReference") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))))

aDMMessage :: ADMMessage #

Creates a value of ADMMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • admmSubstitutions - Default message substitutions. Can be overridden by individual address substitutions.
  • admmExpiresAfter - Optional. Number of seconds ADM should retain the message if the device is offline
  • admmMD5 - Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity
  • admmSilentPush - Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  • admmImageIconURL - The URL that points to an image used as the large icon to the notification content view.
  • admmRawContent - The Raw JSON formatted string to be used as the payload. This value overrides the message.
  • admmData - The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
  • admmSmallImageIconURL - The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
  • admmBody - The message body of the notification, the email body or the text message.
  • admmURL - The URL to open in the user's mobile browser. Used if the value for Action is URL.
  • admmSound - Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in resraw/
  • admmAction - The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
  • admmImageURL - The URL that points to an image used in the push notification.
  • admmConsolidationKey - Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one.
  • admmTitle - The message title that displays above the message on the user's device.
  • admmIconReference - The icon image name of the asset saved in your application.

admmSubstitutions :: Lens' ADMMessage (HashMap Text [Text]) #

Default message substitutions. Can be overridden by individual address substitutions.

admmExpiresAfter :: Lens' ADMMessage (Maybe Text) #

Optional. Number of seconds ADM should retain the message if the device is offline

admmMD5 :: Lens' ADMMessage (Maybe Text) #

Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity

admmSilentPush :: Lens' ADMMessage (Maybe Bool) #

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

admmImageIconURL :: Lens' ADMMessage (Maybe Text) #

The URL that points to an image used as the large icon to the notification content view.

admmRawContent :: Lens' ADMMessage (Maybe Text) #

The Raw JSON formatted string to be used as the payload. This value overrides the message.

admmData :: Lens' ADMMessage (HashMap Text Text) #

The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

admmSmallImageIconURL :: Lens' ADMMessage (Maybe Text) #

The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view

admmBody :: Lens' ADMMessage (Maybe Text) #

The message body of the notification, the email body or the text message.

admmURL :: Lens' ADMMessage (Maybe Text) #

The URL to open in the user's mobile browser. Used if the value for Action is URL.

admmSound :: Lens' ADMMessage (Maybe Text) #

Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in resraw/

admmAction :: Lens' ADMMessage (Maybe Action) #

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

admmImageURL :: Lens' ADMMessage (Maybe Text) #

The URL that points to an image used in the push notification.

admmConsolidationKey :: Lens' ADMMessage (Maybe Text) #

Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one.

admmTitle :: Lens' ADMMessage (Maybe Text) #

The message title that displays above the message on the user's device.

admmIconReference :: Lens' ADMMessage (Maybe Text) #

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

APNSChannelRequest

data APNSChannelRequest #

Apple Push Notification Service channel definition.

See: apnsChannelRequest smart constructor.

Instances

Eq APNSChannelRequest # 
Data APNSChannelRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> APNSChannelRequest -> c APNSChannelRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c APNSChannelRequest #

toConstr :: APNSChannelRequest -> Constr #

dataTypeOf :: APNSChannelRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c APNSChannelRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c APNSChannelRequest) #

gmapT :: (forall b. Data b => b -> b) -> APNSChannelRequest -> APNSChannelRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> APNSChannelRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> APNSChannelRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> APNSChannelRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> APNSChannelRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> APNSChannelRequest -> m APNSChannelRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSChannelRequest -> m APNSChannelRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSChannelRequest -> m APNSChannelRequest #

Read APNSChannelRequest # 
Show APNSChannelRequest # 
Generic APNSChannelRequest # 
Hashable APNSChannelRequest # 
ToJSON APNSChannelRequest # 
NFData APNSChannelRequest # 

Methods

rnf :: APNSChannelRequest -> () #

type Rep APNSChannelRequest # 
type Rep APNSChannelRequest = D1 * (MetaData "APNSChannelRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "APNSChannelRequest'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_acrTokenKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_acrPrivateKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_acrEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_acrTeamId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_acrBundleId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_acrDefaultAuthenticationMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_acrCertificate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_acrTokenKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))

apnsChannelRequest :: APNSChannelRequest #

Creates a value of APNSChannelRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

acrTokenKey :: Lens' APNSChannelRequest (Maybe Text) #

The token key used for APNs Tokens.

acrPrivateKey :: Lens' APNSChannelRequest (Maybe Text) #

The certificate private key.

acrEnabled :: Lens' APNSChannelRequest (Maybe Bool) #

If the channel is enabled for sending messages.

acrTeamId :: Lens' APNSChannelRequest (Maybe Text) #

The team id used for APNs Tokens.

acrBundleId :: Lens' APNSChannelRequest (Maybe Text) #

The bundle id used for APNs Tokens.

acrDefaultAuthenticationMethod :: Lens' APNSChannelRequest (Maybe Text) #

The default authentication method used for APNs.

acrCertificate :: Lens' APNSChannelRequest (Maybe Text) #

The distribution certificate from Apple.

acrTokenKeyId :: Lens' APNSChannelRequest (Maybe Text) #

The token key used for APNs Tokens.

APNSChannelResponse

data APNSChannelResponse #

Apple Distribution Push Notification Service channel definition.

See: apnsChannelResponse smart constructor.

Instances

Eq APNSChannelResponse # 
Data APNSChannelResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> APNSChannelResponse -> c APNSChannelResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c APNSChannelResponse #

toConstr :: APNSChannelResponse -> Constr #

dataTypeOf :: APNSChannelResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c APNSChannelResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c APNSChannelResponse) #

gmapT :: (forall b. Data b => b -> b) -> APNSChannelResponse -> APNSChannelResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> APNSChannelResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> APNSChannelResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> APNSChannelResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> APNSChannelResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> APNSChannelResponse -> m APNSChannelResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSChannelResponse -> m APNSChannelResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSChannelResponse -> m APNSChannelResponse #

Read APNSChannelResponse # 
Show APNSChannelResponse # 
Generic APNSChannelResponse # 
Hashable APNSChannelResponse # 
FromJSON APNSChannelResponse # 
NFData APNSChannelResponse # 

Methods

rnf :: APNSChannelResponse -> () #

type Rep APNSChannelResponse # 
type Rep APNSChannelResponse = D1 * (MetaData "APNSChannelResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "APNSChannelResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_acPlatform") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_acLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_acEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_acHasTokenKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_acDefaultAuthenticationMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_acIsArchived") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_acApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_acVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_acId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_acCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_acLastModifiedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_acHasCredential") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))))))

apnsChannelResponse :: APNSChannelResponse #

Creates a value of APNSChannelResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • acPlatform - The platform type. Will be APNS.
  • acLastModifiedDate - Last date this was updated
  • acEnabled - If the channel is enabled for sending messages.
  • acHasTokenKey - Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.
  • acDefaultAuthenticationMethod - The default authentication method used for APNs.
  • acIsArchived - Is this channel archived
  • acApplicationId - The ID of the application to which the channel applies.
  • acVersion - Version of channel
  • acId - Channel ID. Not used. Present only for backwards compatibility.
  • acCreationDate - When was this segment created
  • acLastModifiedBy - Who last updated this entry
  • acHasCredential - Indicates whether the channel is configured with APNs credentials. Amazon Pinpoint uses your credentials to authenticate push notifications with APNs. To use APNs token authentication, set the BundleId, TeamId, TokenKey, and TokenKeyId attributes. To use certificate authentication, set the Certificate and PrivateKey attributes.

acPlatform :: Lens' APNSChannelResponse (Maybe Text) #

The platform type. Will be APNS.

acLastModifiedDate :: Lens' APNSChannelResponse (Maybe Text) #

Last date this was updated

acEnabled :: Lens' APNSChannelResponse (Maybe Bool) #

If the channel is enabled for sending messages.

acHasTokenKey :: Lens' APNSChannelResponse (Maybe Bool) #

Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.

acDefaultAuthenticationMethod :: Lens' APNSChannelResponse (Maybe Text) #

The default authentication method used for APNs.

acIsArchived :: Lens' APNSChannelResponse (Maybe Bool) #

Is this channel archived

acApplicationId :: Lens' APNSChannelResponse (Maybe Text) #

The ID of the application to which the channel applies.

acVersion :: Lens' APNSChannelResponse (Maybe Int) #

Version of channel

acId :: Lens' APNSChannelResponse (Maybe Text) #

Channel ID. Not used. Present only for backwards compatibility.

acCreationDate :: Lens' APNSChannelResponse (Maybe Text) #

When was this segment created

acLastModifiedBy :: Lens' APNSChannelResponse (Maybe Text) #

Who last updated this entry

acHasCredential :: Lens' APNSChannelResponse (Maybe Bool) #

Indicates whether the channel is configured with APNs credentials. Amazon Pinpoint uses your credentials to authenticate push notifications with APNs. To use APNs token authentication, set the BundleId, TeamId, TokenKey, and TokenKeyId attributes. To use certificate authentication, set the Certificate and PrivateKey attributes.

APNSMessage

data APNSMessage #

APNS Message.

See: apnsMessage smart constructor.

Instances

Eq APNSMessage # 
Data APNSMessage # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> APNSMessage -> c APNSMessage #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c APNSMessage #

toConstr :: APNSMessage -> Constr #

dataTypeOf :: APNSMessage -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c APNSMessage) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c APNSMessage) #

gmapT :: (forall b. Data b => b -> b) -> APNSMessage -> APNSMessage #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> APNSMessage -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> APNSMessage -> r #

gmapQ :: (forall d. Data d => d -> u) -> APNSMessage -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> APNSMessage -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> APNSMessage -> m APNSMessage #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSMessage -> m APNSMessage #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSMessage -> m APNSMessage #

Read APNSMessage # 
Show APNSMessage # 
Generic APNSMessage # 

Associated Types

type Rep APNSMessage :: * -> * #

Hashable APNSMessage # 
ToJSON APNSMessage # 
NFData APNSMessage # 

Methods

rnf :: APNSMessage -> () #

type Rep APNSMessage # 
type Rep APNSMessage = D1 * (MetaData "APNSMessage" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "APNSMessage'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_amSubstitutions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text [Text])))) (S1 * (MetaSel (Just Symbol "_amSilentPush") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_amPriority") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_amRawContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_amData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))) (S1 * (MetaSel (Just Symbol "_amBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_amCategory") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_amTimeToLive") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_amURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_amSound") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_amAction") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Action))) (S1 * (MetaSel (Just Symbol "_amMediaURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_amPreferredAuthenticationMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_amBadge") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_amTitle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_amThreadId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_amCollapseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))))

apnsMessage :: APNSMessage #

Creates a value of APNSMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • amSubstitutions - Default message substitutions. Can be overridden by individual address substitutions.
  • amSilentPush - Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  • amPriority - The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.
  • amRawContent - The Raw JSON formatted string to be used as the payload. This value overrides the message.
  • amData - The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
  • amBody - The message body of the notification, the email body or the text message.
  • amCategory - Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.
  • amTimeToLive - The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.
  • amURL - The URL to open in the user's mobile browser. Used if the value for Action is URL.
  • amSound - Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.
  • amAction - The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
  • amMediaURL - The URL that points to a video used in the push notification.
  • amPreferredAuthenticationMethod - The preferred authentication method, either CERTIFICATE or TOKEN
  • amBadge - Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.
  • amTitle - The message title that displays above the message on the user's device.
  • amThreadId - Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
  • amCollapseId - An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.

amSubstitutions :: Lens' APNSMessage (HashMap Text [Text]) #

Default message substitutions. Can be overridden by individual address substitutions.

amSilentPush :: Lens' APNSMessage (Maybe Bool) #

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

amPriority :: Lens' APNSMessage (Maybe Text) #

The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.

amRawContent :: Lens' APNSMessage (Maybe Text) #

The Raw JSON formatted string to be used as the payload. This value overrides the message.

amData :: Lens' APNSMessage (HashMap Text Text) #

The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

amBody :: Lens' APNSMessage (Maybe Text) #

The message body of the notification, the email body or the text message.

amCategory :: Lens' APNSMessage (Maybe Text) #

Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.

amTimeToLive :: Lens' APNSMessage (Maybe Int) #

The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.

amURL :: Lens' APNSMessage (Maybe Text) #

The URL to open in the user's mobile browser. Used if the value for Action is URL.

amSound :: Lens' APNSMessage (Maybe Text) #

Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.

amAction :: Lens' APNSMessage (Maybe Action) #

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

amMediaURL :: Lens' APNSMessage (Maybe Text) #

The URL that points to a video used in the push notification.

amPreferredAuthenticationMethod :: Lens' APNSMessage (Maybe Text) #

The preferred authentication method, either CERTIFICATE or TOKEN

amBadge :: Lens' APNSMessage (Maybe Int) #

Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.

amTitle :: Lens' APNSMessage (Maybe Text) #

The message title that displays above the message on the user's device.

amThreadId :: Lens' APNSMessage (Maybe Text) #

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

amCollapseId :: Lens' APNSMessage (Maybe Text) #

An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.

APNSSandboxChannelRequest

data APNSSandboxChannelRequest #

Apple Development Push Notification Service channel definition.

See: apnsSandboxChannelRequest smart constructor.

Instances

Eq APNSSandboxChannelRequest # 
Data APNSSandboxChannelRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> APNSSandboxChannelRequest -> c APNSSandboxChannelRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c APNSSandboxChannelRequest #

toConstr :: APNSSandboxChannelRequest -> Constr #

dataTypeOf :: APNSSandboxChannelRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c APNSSandboxChannelRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c APNSSandboxChannelRequest) #

gmapT :: (forall b. Data b => b -> b) -> APNSSandboxChannelRequest -> APNSSandboxChannelRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> APNSSandboxChannelRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> APNSSandboxChannelRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> APNSSandboxChannelRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> APNSSandboxChannelRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> APNSSandboxChannelRequest -> m APNSSandboxChannelRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSSandboxChannelRequest -> m APNSSandboxChannelRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSSandboxChannelRequest -> m APNSSandboxChannelRequest #

Read APNSSandboxChannelRequest # 
Show APNSSandboxChannelRequest # 
Generic APNSSandboxChannelRequest # 
Hashable APNSSandboxChannelRequest # 
ToJSON APNSSandboxChannelRequest # 
NFData APNSSandboxChannelRequest # 
type Rep APNSSandboxChannelRequest # 
type Rep APNSSandboxChannelRequest = D1 * (MetaData "APNSSandboxChannelRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "APNSSandboxChannelRequest'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ascrTokenKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ascrPrivateKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ascrEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_ascrTeamId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ascrBundleId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ascrDefaultAuthenticationMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ascrCertificate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ascrTokenKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))

apnsSandboxChannelRequest :: APNSSandboxChannelRequest #

Creates a value of APNSSandboxChannelRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ascrTokenKey :: Lens' APNSSandboxChannelRequest (Maybe Text) #

The token key used for APNs Tokens.

ascrPrivateKey :: Lens' APNSSandboxChannelRequest (Maybe Text) #

The certificate private key.

ascrEnabled :: Lens' APNSSandboxChannelRequest (Maybe Bool) #

If the channel is enabled for sending messages.

ascrTeamId :: Lens' APNSSandboxChannelRequest (Maybe Text) #

The team id used for APNs Tokens.

ascrBundleId :: Lens' APNSSandboxChannelRequest (Maybe Text) #

The bundle id used for APNs Tokens.

ascrDefaultAuthenticationMethod :: Lens' APNSSandboxChannelRequest (Maybe Text) #

The default authentication method used for APNs.

ascrCertificate :: Lens' APNSSandboxChannelRequest (Maybe Text) #

The distribution certificate from Apple.

ascrTokenKeyId :: Lens' APNSSandboxChannelRequest (Maybe Text) #

The token key used for APNs Tokens.

APNSSandboxChannelResponse

data APNSSandboxChannelResponse #

Apple Development Push Notification Service channel definition.

See: apnsSandboxChannelResponse smart constructor.

Instances

Eq APNSSandboxChannelResponse # 
Data APNSSandboxChannelResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> APNSSandboxChannelResponse -> c APNSSandboxChannelResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c APNSSandboxChannelResponse #

toConstr :: APNSSandboxChannelResponse -> Constr #

dataTypeOf :: APNSSandboxChannelResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c APNSSandboxChannelResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c APNSSandboxChannelResponse) #

gmapT :: (forall b. Data b => b -> b) -> APNSSandboxChannelResponse -> APNSSandboxChannelResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> APNSSandboxChannelResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> APNSSandboxChannelResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> APNSSandboxChannelResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> APNSSandboxChannelResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> APNSSandboxChannelResponse -> m APNSSandboxChannelResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSSandboxChannelResponse -> m APNSSandboxChannelResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSSandboxChannelResponse -> m APNSSandboxChannelResponse #

Read APNSSandboxChannelResponse # 
Show APNSSandboxChannelResponse # 
Generic APNSSandboxChannelResponse # 
Hashable APNSSandboxChannelResponse # 
FromJSON APNSSandboxChannelResponse # 
NFData APNSSandboxChannelResponse # 
type Rep APNSSandboxChannelResponse # 
type Rep APNSSandboxChannelResponse = D1 * (MetaData "APNSSandboxChannelResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "APNSSandboxChannelResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ascPlatform") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ascLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ascEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ascHasTokenKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ascDefaultAuthenticationMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ascIsArchived") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ascApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ascVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_ascId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ascCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ascLastModifiedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ascHasCredential") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))))))

apnsSandboxChannelResponse :: APNSSandboxChannelResponse #

Creates a value of APNSSandboxChannelResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ascPlatform - The platform type. Will be APNS_SANDBOX.
  • ascLastModifiedDate - Last date this was updated
  • ascEnabled - If the channel is enabled for sending messages.
  • ascHasTokenKey - Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.
  • ascDefaultAuthenticationMethod - The default authentication method used for APNs.
  • ascIsArchived - Is this channel archived
  • ascApplicationId - The ID of the application to which the channel applies.
  • ascVersion - Version of channel
  • ascId - Channel ID. Not used, only for backwards compatibility.
  • ascCreationDate - When was this segment created
  • ascLastModifiedBy - Who last updated this entry
  • ascHasCredential - Indicates whether the channel is configured with APNs credentials. Amazon Pinpoint uses your credentials to authenticate push notifications with APNs. To use APNs token authentication, set the BundleId, TeamId, TokenKey, and TokenKeyId attributes. To use certificate authentication, set the Certificate and PrivateKey attributes.

ascPlatform :: Lens' APNSSandboxChannelResponse (Maybe Text) #

The platform type. Will be APNS_SANDBOX.

ascEnabled :: Lens' APNSSandboxChannelResponse (Maybe Bool) #

If the channel is enabled for sending messages.

ascHasTokenKey :: Lens' APNSSandboxChannelResponse (Maybe Bool) #

Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.

ascDefaultAuthenticationMethod :: Lens' APNSSandboxChannelResponse (Maybe Text) #

The default authentication method used for APNs.

ascApplicationId :: Lens' APNSSandboxChannelResponse (Maybe Text) #

The ID of the application to which the channel applies.

ascId :: Lens' APNSSandboxChannelResponse (Maybe Text) #

Channel ID. Not used, only for backwards compatibility.

ascCreationDate :: Lens' APNSSandboxChannelResponse (Maybe Text) #

When was this segment created

ascHasCredential :: Lens' APNSSandboxChannelResponse (Maybe Bool) #

Indicates whether the channel is configured with APNs credentials. Amazon Pinpoint uses your credentials to authenticate push notifications with APNs. To use APNs token authentication, set the BundleId, TeamId, TokenKey, and TokenKeyId attributes. To use certificate authentication, set the Certificate and PrivateKey attributes.

APNSVoipChannelRequest

data APNSVoipChannelRequest #

Apple VoIP Push Notification Service channel definition.

See: apnsVoipChannelRequest smart constructor.

Instances

Eq APNSVoipChannelRequest # 
Data APNSVoipChannelRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> APNSVoipChannelRequest -> c APNSVoipChannelRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c APNSVoipChannelRequest #

toConstr :: APNSVoipChannelRequest -> Constr #

dataTypeOf :: APNSVoipChannelRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c APNSVoipChannelRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c APNSVoipChannelRequest) #

gmapT :: (forall b. Data b => b -> b) -> APNSVoipChannelRequest -> APNSVoipChannelRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> APNSVoipChannelRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> APNSVoipChannelRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> APNSVoipChannelRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> APNSVoipChannelRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> APNSVoipChannelRequest -> m APNSVoipChannelRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSVoipChannelRequest -> m APNSVoipChannelRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSVoipChannelRequest -> m APNSVoipChannelRequest #

Read APNSVoipChannelRequest # 
Show APNSVoipChannelRequest # 
Generic APNSVoipChannelRequest # 
Hashable APNSVoipChannelRequest # 
ToJSON APNSVoipChannelRequest # 
NFData APNSVoipChannelRequest # 

Methods

rnf :: APNSVoipChannelRequest -> () #

type Rep APNSVoipChannelRequest # 
type Rep APNSVoipChannelRequest = D1 * (MetaData "APNSVoipChannelRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "APNSVoipChannelRequest'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_avcrTokenKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_avcrPrivateKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_avcrEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_avcrTeamId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_avcrBundleId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_avcrDefaultAuthenticationMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_avcrCertificate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_avcrTokenKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))

apnsVoipChannelRequest :: APNSVoipChannelRequest #

Creates a value of APNSVoipChannelRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

avcrTokenKey :: Lens' APNSVoipChannelRequest (Maybe Text) #

The token key used for APNs Tokens.

avcrPrivateKey :: Lens' APNSVoipChannelRequest (Maybe Text) #

The certificate private key.

avcrEnabled :: Lens' APNSVoipChannelRequest (Maybe Bool) #

If the channel is enabled for sending messages.

avcrTeamId :: Lens' APNSVoipChannelRequest (Maybe Text) #

The team id used for APNs Tokens.

avcrBundleId :: Lens' APNSVoipChannelRequest (Maybe Text) #

The bundle id used for APNs Tokens.

avcrDefaultAuthenticationMethod :: Lens' APNSVoipChannelRequest (Maybe Text) #

The default authentication method used for APNs.

avcrCertificate :: Lens' APNSVoipChannelRequest (Maybe Text) #

The distribution certificate from Apple.

avcrTokenKeyId :: Lens' APNSVoipChannelRequest (Maybe Text) #

The token key used for APNs Tokens.

APNSVoipChannelResponse

data APNSVoipChannelResponse #

Apple VoIP Push Notification Service channel definition.

See: apnsVoipChannelResponse smart constructor.

Instances

Eq APNSVoipChannelResponse # 
Data APNSVoipChannelResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> APNSVoipChannelResponse -> c APNSVoipChannelResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c APNSVoipChannelResponse #

toConstr :: APNSVoipChannelResponse -> Constr #

dataTypeOf :: APNSVoipChannelResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c APNSVoipChannelResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c APNSVoipChannelResponse) #

gmapT :: (forall b. Data b => b -> b) -> APNSVoipChannelResponse -> APNSVoipChannelResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> APNSVoipChannelResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> APNSVoipChannelResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> APNSVoipChannelResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> APNSVoipChannelResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> APNSVoipChannelResponse -> m APNSVoipChannelResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSVoipChannelResponse -> m APNSVoipChannelResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSVoipChannelResponse -> m APNSVoipChannelResponse #

Read APNSVoipChannelResponse # 
Show APNSVoipChannelResponse # 
Generic APNSVoipChannelResponse # 
Hashable APNSVoipChannelResponse # 
FromJSON APNSVoipChannelResponse # 
NFData APNSVoipChannelResponse # 

Methods

rnf :: APNSVoipChannelResponse -> () #

type Rep APNSVoipChannelResponse # 
type Rep APNSVoipChannelResponse = D1 * (MetaData "APNSVoipChannelResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "APNSVoipChannelResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_avcPlatform") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_avcLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_avcEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_avcHasTokenKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_avcDefaultAuthenticationMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_avcIsArchived") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_avcApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_avcVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_avcId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_avcCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_avcLastModifiedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_avcHasCredential") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))))))

apnsVoipChannelResponse :: APNSVoipChannelResponse #

Creates a value of APNSVoipChannelResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

avcPlatform :: Lens' APNSVoipChannelResponse (Maybe Text) #

The platform type. Will be APNS.

avcEnabled :: Lens' APNSVoipChannelResponse (Maybe Bool) #

If the channel is enabled for sending messages.

avcHasTokenKey :: Lens' APNSVoipChannelResponse (Maybe Bool) #

If the channel is registered with a token key for authentication.

avcDefaultAuthenticationMethod :: Lens' APNSVoipChannelResponse (Maybe Text) #

The default authentication method used for APNs.

avcIsArchived :: Lens' APNSVoipChannelResponse (Maybe Bool) #

Is this channel archived

avcId :: Lens' APNSVoipChannelResponse (Maybe Text) #

Channel ID. Not used, only for backwards compatibility.

avcCreationDate :: Lens' APNSVoipChannelResponse (Maybe Text) #

When was this segment created

avcHasCredential :: Lens' APNSVoipChannelResponse (Maybe Bool) #

If the channel is registered with a credential for authentication.

APNSVoipSandboxChannelRequest

data APNSVoipSandboxChannelRequest #

Apple VoIP Developer Push Notification Service channel definition.

See: apnsVoipSandboxChannelRequest smart constructor.

Instances

Eq APNSVoipSandboxChannelRequest # 
Data APNSVoipSandboxChannelRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> APNSVoipSandboxChannelRequest -> c APNSVoipSandboxChannelRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c APNSVoipSandboxChannelRequest #

toConstr :: APNSVoipSandboxChannelRequest -> Constr #

dataTypeOf :: APNSVoipSandboxChannelRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c APNSVoipSandboxChannelRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c APNSVoipSandboxChannelRequest) #

gmapT :: (forall b. Data b => b -> b) -> APNSVoipSandboxChannelRequest -> APNSVoipSandboxChannelRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> APNSVoipSandboxChannelRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> APNSVoipSandboxChannelRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> APNSVoipSandboxChannelRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> APNSVoipSandboxChannelRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> APNSVoipSandboxChannelRequest -> m APNSVoipSandboxChannelRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSVoipSandboxChannelRequest -> m APNSVoipSandboxChannelRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSVoipSandboxChannelRequest -> m APNSVoipSandboxChannelRequest #

Read APNSVoipSandboxChannelRequest # 
Show APNSVoipSandboxChannelRequest # 
Generic APNSVoipSandboxChannelRequest # 
Hashable APNSVoipSandboxChannelRequest # 
ToJSON APNSVoipSandboxChannelRequest # 
NFData APNSVoipSandboxChannelRequest # 
type Rep APNSVoipSandboxChannelRequest # 
type Rep APNSVoipSandboxChannelRequest = D1 * (MetaData "APNSVoipSandboxChannelRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "APNSVoipSandboxChannelRequest'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_avscrTokenKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_avscrPrivateKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_avscrEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_avscrTeamId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_avscrBundleId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_avscrDefaultAuthenticationMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_avscrCertificate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_avscrTokenKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))

apnsVoipSandboxChannelRequest :: APNSVoipSandboxChannelRequest #

Creates a value of APNSVoipSandboxChannelRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

avscrTokenKey :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) #

The token key used for APNs Tokens.

avscrEnabled :: Lens' APNSVoipSandboxChannelRequest (Maybe Bool) #

If the channel is enabled for sending messages.

avscrTeamId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) #

The team id used for APNs Tokens.

avscrBundleId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) #

The bundle id used for APNs Tokens.

avscrDefaultAuthenticationMethod :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) #

The default authentication method used for APNs.

avscrCertificate :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) #

The distribution certificate from Apple.

avscrTokenKeyId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) #

The token key used for APNs Tokens.

APNSVoipSandboxChannelResponse

data APNSVoipSandboxChannelResponse #

Apple VoIP Developer Push Notification Service channel definition.

See: apnsVoipSandboxChannelResponse smart constructor.

Instances

Eq APNSVoipSandboxChannelResponse # 
Data APNSVoipSandboxChannelResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> APNSVoipSandboxChannelResponse -> c APNSVoipSandboxChannelResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c APNSVoipSandboxChannelResponse #

toConstr :: APNSVoipSandboxChannelResponse -> Constr #

dataTypeOf :: APNSVoipSandboxChannelResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c APNSVoipSandboxChannelResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c APNSVoipSandboxChannelResponse) #

gmapT :: (forall b. Data b => b -> b) -> APNSVoipSandboxChannelResponse -> APNSVoipSandboxChannelResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> APNSVoipSandboxChannelResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> APNSVoipSandboxChannelResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> APNSVoipSandboxChannelResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> APNSVoipSandboxChannelResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> APNSVoipSandboxChannelResponse -> m APNSVoipSandboxChannelResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSVoipSandboxChannelResponse -> m APNSVoipSandboxChannelResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> APNSVoipSandboxChannelResponse -> m APNSVoipSandboxChannelResponse #

Read APNSVoipSandboxChannelResponse # 
Show APNSVoipSandboxChannelResponse # 
Generic APNSVoipSandboxChannelResponse # 
Hashable APNSVoipSandboxChannelResponse # 
FromJSON APNSVoipSandboxChannelResponse # 
NFData APNSVoipSandboxChannelResponse # 
type Rep APNSVoipSandboxChannelResponse # 
type Rep APNSVoipSandboxChannelResponse = D1 * (MetaData "APNSVoipSandboxChannelResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "APNSVoipSandboxChannelResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_avscPlatform") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_avscLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_avscEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_avscHasTokenKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_avscDefaultAuthenticationMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_avscIsArchived") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_avscApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_avscVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_avscId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_avscCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_avscLastModifiedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_avscHasCredential") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))))))

apnsVoipSandboxChannelResponse :: APNSVoipSandboxChannelResponse #

Creates a value of APNSVoipSandboxChannelResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

avscPlatform :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) #

The platform type. Will be APNS.

avscEnabled :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) #

If the channel is enabled for sending messages.

avscHasTokenKey :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) #

If the channel is registered with a token key for authentication.

avscDefaultAuthenticationMethod :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) #

The default authentication method used for APNs.

avscId :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) #

Channel ID. Not used, only for backwards compatibility.

avscHasCredential :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) #

If the channel is registered with a credential for authentication.

ActivitiesResponse

data ActivitiesResponse #

Activities for campaign.

See: activitiesResponse smart constructor.

Instances

Eq ActivitiesResponse # 
Data ActivitiesResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ActivitiesResponse -> c ActivitiesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ActivitiesResponse #

toConstr :: ActivitiesResponse -> Constr #

dataTypeOf :: ActivitiesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ActivitiesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ActivitiesResponse) #

gmapT :: (forall b. Data b => b -> b) -> ActivitiesResponse -> ActivitiesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ActivitiesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ActivitiesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ActivitiesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ActivitiesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ActivitiesResponse -> m ActivitiesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ActivitiesResponse -> m ActivitiesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ActivitiesResponse -> m ActivitiesResponse #

Read ActivitiesResponse # 
Show ActivitiesResponse # 
Generic ActivitiesResponse # 
Hashable ActivitiesResponse # 
FromJSON ActivitiesResponse # 
NFData ActivitiesResponse # 

Methods

rnf :: ActivitiesResponse -> () #

type Rep ActivitiesResponse # 
type Rep ActivitiesResponse = D1 * (MetaData "ActivitiesResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" True) (C1 * (MetaCons "ActivitiesResponse'" PrefixI True) (S1 * (MetaSel (Just Symbol "_aItem") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe [ActivityResponse]))))

activitiesResponse :: ActivitiesResponse #

Creates a value of ActivitiesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • aItem - List of campaign activities

aItem :: Lens' ActivitiesResponse [ActivityResponse] #

List of campaign activities

ActivityResponse

data ActivityResponse #

Activity definition

See: activityResponse smart constructor.

Instances

Eq ActivityResponse # 
Data ActivityResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ActivityResponse -> c ActivityResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ActivityResponse #

toConstr :: ActivityResponse -> Constr #

dataTypeOf :: ActivityResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ActivityResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ActivityResponse) #

gmapT :: (forall b. Data b => b -> b) -> ActivityResponse -> ActivityResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ActivityResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ActivityResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ActivityResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ActivityResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ActivityResponse -> m ActivityResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ActivityResponse -> m ActivityResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ActivityResponse -> m ActivityResponse #

Read ActivityResponse # 
Show ActivityResponse # 
Generic ActivityResponse # 
Hashable ActivityResponse # 
FromJSON ActivityResponse # 
NFData ActivityResponse # 

Methods

rnf :: ActivityResponse -> () #

type Rep ActivityResponse # 
type Rep ActivityResponse = D1 * (MetaData "ActivityResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "ActivityResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_aState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_aStart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_aCampaignId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_aTimezonesCompletedCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "_aTimezonesTotalCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_aResult") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_aTreatmentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_aSuccessfulEndpointCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_aEnd") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_aApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_aTotalEndpointCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_aId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_aScheduledStart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))))

activityResponse :: ActivityResponse #

Creates a value of ActivityResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • aState - The state of the activity. Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED
  • aStart - The actual start time of the activity in ISO 8601 format.
  • aCampaignId - The ID of the campaign to which the activity applies.
  • aTimezonesCompletedCount - The total number of timezones completed.
  • aTimezonesTotalCount - The total number of unique timezones present in the segment.
  • aResult - Indicates whether the activity succeeded. Valid values: SUCCESS, FAIL
  • aTreatmentId - The ID of a variation of the campaign used for A/B testing.
  • aSuccessfulEndpointCount - The total number of endpoints to which the campaign successfully delivered messages.
  • aEnd - The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format.
  • aApplicationId - The ID of the application to which the campaign applies.
  • aTotalEndpointCount - The total number of endpoints to which the campaign attempts to deliver messages.
  • aId - The unique activity ID.
  • aScheduledStart - The scheduled start time for the activity in ISO 8601 format.

aState :: Lens' ActivityResponse (Maybe Text) #

The state of the activity. Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED

aStart :: Lens' ActivityResponse (Maybe Text) #

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

aCampaignId :: Lens' ActivityResponse (Maybe Text) #

The ID of the campaign to which the activity applies.

aTimezonesCompletedCount :: Lens' ActivityResponse (Maybe Int) #

The total number of timezones completed.

aTimezonesTotalCount :: Lens' ActivityResponse (Maybe Int) #

The total number of unique timezones present in the segment.

aResult :: Lens' ActivityResponse (Maybe Text) #

Indicates whether the activity succeeded. Valid values: SUCCESS, FAIL

aTreatmentId :: Lens' ActivityResponse (Maybe Text) #

The ID of a variation of the campaign used for A/B testing.

aSuccessfulEndpointCount :: Lens' ActivityResponse (Maybe Int) #

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

aEnd :: Lens' ActivityResponse (Maybe Text) #

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

aApplicationId :: Lens' ActivityResponse (Maybe Text) #

The ID of the application to which the campaign applies.

aTotalEndpointCount :: Lens' ActivityResponse (Maybe Int) #

The total number of endpoints to which the campaign attempts to deliver messages.

aId :: Lens' ActivityResponse (Maybe Text) #

The unique activity ID.

aScheduledStart :: Lens' ActivityResponse (Maybe Text) #

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

AddressConfiguration

data AddressConfiguration #

Address configuration.

See: addressConfiguration smart constructor.

Instances

Eq AddressConfiguration # 
Data AddressConfiguration # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AddressConfiguration -> c AddressConfiguration #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AddressConfiguration #

toConstr :: AddressConfiguration -> Constr #

dataTypeOf :: AddressConfiguration -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AddressConfiguration) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AddressConfiguration) #

gmapT :: (forall b. Data b => b -> b) -> AddressConfiguration -> AddressConfiguration #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AddressConfiguration -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AddressConfiguration -> r #

gmapQ :: (forall d. Data d => d -> u) -> AddressConfiguration -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AddressConfiguration -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AddressConfiguration -> m AddressConfiguration #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AddressConfiguration -> m AddressConfiguration #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AddressConfiguration -> m AddressConfiguration #

Read AddressConfiguration # 
Show AddressConfiguration # 
Generic AddressConfiguration # 
Hashable AddressConfiguration # 
ToJSON AddressConfiguration # 
NFData AddressConfiguration # 

Methods

rnf :: AddressConfiguration -> () #

type Rep AddressConfiguration # 
type Rep AddressConfiguration = D1 * (MetaData "AddressConfiguration" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "AddressConfiguration'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_acSubstitutions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_acTitleOverride") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_acContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_acRawContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_acBodyOverride") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_acChannelType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ChannelType)))))))

addressConfiguration :: AddressConfiguration #

Creates a value of AddressConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • acSubstitutions - A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.
  • acTitleOverride - Title override. If specified will override default title if applicable.
  • acContext - A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
  • acRawContent - The Raw JSON formatted string to be used as the payload. This value overrides the message.
  • acBodyOverride - Body override. If specified will override default body.
  • acChannelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

acSubstitutions :: Lens' AddressConfiguration (HashMap Text [Text]) #

A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.

acTitleOverride :: Lens' AddressConfiguration (Maybe Text) #

Title override. If specified will override default title if applicable.

acContext :: Lens' AddressConfiguration (HashMap Text Text) #

A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.

acRawContent :: Lens' AddressConfiguration (Maybe Text) #

The Raw JSON formatted string to be used as the payload. This value overrides the message.

acBodyOverride :: Lens' AddressConfiguration (Maybe Text) #

Body override. If specified will override default body.

acChannelType :: Lens' AddressConfiguration (Maybe ChannelType) #

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

ApplicationResponse

data ApplicationResponse #

Application Response.

See: applicationResponse smart constructor.

Instances

Eq ApplicationResponse # 
Data ApplicationResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ApplicationResponse -> c ApplicationResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ApplicationResponse #

toConstr :: ApplicationResponse -> Constr #

dataTypeOf :: ApplicationResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ApplicationResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ApplicationResponse) #

gmapT :: (forall b. Data b => b -> b) -> ApplicationResponse -> ApplicationResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ApplicationResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ApplicationResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ApplicationResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ApplicationResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ApplicationResponse -> m ApplicationResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ApplicationResponse -> m ApplicationResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ApplicationResponse -> m ApplicationResponse #

Read ApplicationResponse # 
Show ApplicationResponse # 
Generic ApplicationResponse # 
Hashable ApplicationResponse # 
FromJSON ApplicationResponse # 
NFData ApplicationResponse # 

Methods

rnf :: ApplicationResponse -> () #

type Rep ApplicationResponse # 
type Rep ApplicationResponse = D1 * (MetaData "ApplicationResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "ApplicationResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_appName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_appId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))

applicationResponse :: ApplicationResponse #

Creates a value of ApplicationResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • appName - The display name of the application.
  • appId - The unique application ID.

appName :: Lens' ApplicationResponse (Maybe Text) #

The display name of the application.

appId :: Lens' ApplicationResponse (Maybe Text) #

The unique application ID.

ApplicationSettingsResource

data ApplicationSettingsResource #

Application settings.

See: applicationSettingsResource smart constructor.

Instances

Eq ApplicationSettingsResource # 
Data ApplicationSettingsResource # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ApplicationSettingsResource -> c ApplicationSettingsResource #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ApplicationSettingsResource #

toConstr :: ApplicationSettingsResource -> Constr #

dataTypeOf :: ApplicationSettingsResource -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ApplicationSettingsResource) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ApplicationSettingsResource) #

gmapT :: (forall b. Data b => b -> b) -> ApplicationSettingsResource -> ApplicationSettingsResource #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ApplicationSettingsResource -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ApplicationSettingsResource -> r #

gmapQ :: (forall d. Data d => d -> u) -> ApplicationSettingsResource -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ApplicationSettingsResource -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ApplicationSettingsResource -> m ApplicationSettingsResource #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ApplicationSettingsResource -> m ApplicationSettingsResource #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ApplicationSettingsResource -> m ApplicationSettingsResource #

Read ApplicationSettingsResource # 
Show ApplicationSettingsResource # 
Generic ApplicationSettingsResource # 
Hashable ApplicationSettingsResource # 
FromJSON ApplicationSettingsResource # 
NFData ApplicationSettingsResource # 
type Rep ApplicationSettingsResource # 
type Rep ApplicationSettingsResource = D1 * (MetaData "ApplicationSettingsResource" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "ApplicationSettingsResource'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_asrLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_asrLimits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe CampaignLimits)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_asrQuietTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe QuietTime))) ((:*:) * (S1 * (MetaSel (Just Symbol "_asrApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_asrCampaignHook") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe CampaignHook)))))))

applicationSettingsResource :: ApplicationSettingsResource #

Creates a value of ApplicationSettingsResource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • asrLastModifiedDate - The date that the settings were last updated in ISO 8601 format.
  • asrLimits - The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.
  • asrQuietTime - The default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own.
  • asrApplicationId - The unique ID for the application.
  • asrCampaignHook - Default campaign hook.

asrLastModifiedDate :: Lens' ApplicationSettingsResource (Maybe Text) #

The date that the settings were last updated in ISO 8601 format.

asrLimits :: Lens' ApplicationSettingsResource (Maybe CampaignLimits) #

The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.

asrQuietTime :: Lens' ApplicationSettingsResource (Maybe QuietTime) #

The default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own.

asrApplicationId :: Lens' ApplicationSettingsResource (Maybe Text) #

The unique ID for the application.

ApplicationsResponse

data ApplicationsResponse #

Get Applications Result.

See: applicationsResponse smart constructor.

Instances

Eq ApplicationsResponse # 
Data ApplicationsResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ApplicationsResponse -> c ApplicationsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ApplicationsResponse #

toConstr :: ApplicationsResponse -> Constr #

dataTypeOf :: ApplicationsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ApplicationsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ApplicationsResponse) #

gmapT :: (forall b. Data b => b -> b) -> ApplicationsResponse -> ApplicationsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ApplicationsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ApplicationsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ApplicationsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ApplicationsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ApplicationsResponse -> m ApplicationsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ApplicationsResponse -> m ApplicationsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ApplicationsResponse -> m ApplicationsResponse #

Read ApplicationsResponse # 
Show ApplicationsResponse # 
Generic ApplicationsResponse # 
Hashable ApplicationsResponse # 
FromJSON ApplicationsResponse # 
NFData ApplicationsResponse # 

Methods

rnf :: ApplicationsResponse -> () #

type Rep ApplicationsResponse # 
type Rep ApplicationsResponse = D1 * (MetaData "ApplicationsResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "ApplicationsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_appNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_appItem") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ApplicationResponse])))))

applicationsResponse :: ApplicationsResponse #

Creates a value of ApplicationsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • appNextToken - The string that you use in a subsequent request to get the next page of results in a paginated response.
  • appItem - List of applications returned in this page.

appNextToken :: Lens' ApplicationsResponse (Maybe Text) #

The string that you use in a subsequent request to get the next page of results in a paginated response.

appItem :: Lens' ApplicationsResponse [ApplicationResponse] #

List of applications returned in this page.

AttributeDimension

data AttributeDimension #

Custom attibute dimension

See: attributeDimension smart constructor.

Instances

Eq AttributeDimension # 
Data AttributeDimension # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AttributeDimension -> c AttributeDimension #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AttributeDimension #

toConstr :: AttributeDimension -> Constr #

dataTypeOf :: AttributeDimension -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AttributeDimension) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AttributeDimension) #

gmapT :: (forall b. Data b => b -> b) -> AttributeDimension -> AttributeDimension #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AttributeDimension -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AttributeDimension -> r #

gmapQ :: (forall d. Data d => d -> u) -> AttributeDimension -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AttributeDimension -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AttributeDimension -> m AttributeDimension #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AttributeDimension -> m AttributeDimension #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AttributeDimension -> m AttributeDimension #

Read AttributeDimension # 
Show AttributeDimension # 
Generic AttributeDimension # 
Hashable AttributeDimension # 
ToJSON AttributeDimension # 
FromJSON AttributeDimension # 
NFData AttributeDimension # 

Methods

rnf :: AttributeDimension -> () #

type Rep AttributeDimension # 
type Rep AttributeDimension = D1 * (MetaData "AttributeDimension" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "AttributeDimension'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_adValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_adAttributeType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe AttributeType)))))

attributeDimension :: AttributeDimension #

Creates a value of AttributeDimension with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • adValues - The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
  • adAttributeType - The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.

adValues :: Lens' AttributeDimension [Text] #

The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.

adAttributeType :: Lens' AttributeDimension (Maybe AttributeType) #

The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.

BaiduChannelRequest

data BaiduChannelRequest #

Baidu Cloud Push credentials

See: baiduChannelRequest smart constructor.

Instances

Eq BaiduChannelRequest # 
Data BaiduChannelRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BaiduChannelRequest -> c BaiduChannelRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BaiduChannelRequest #

toConstr :: BaiduChannelRequest -> Constr #

dataTypeOf :: BaiduChannelRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c BaiduChannelRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BaiduChannelRequest) #

gmapT :: (forall b. Data b => b -> b) -> BaiduChannelRequest -> BaiduChannelRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BaiduChannelRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BaiduChannelRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> BaiduChannelRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BaiduChannelRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BaiduChannelRequest -> m BaiduChannelRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BaiduChannelRequest -> m BaiduChannelRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BaiduChannelRequest -> m BaiduChannelRequest #

Read BaiduChannelRequest # 
Show BaiduChannelRequest # 
Generic BaiduChannelRequest # 
Hashable BaiduChannelRequest # 
ToJSON BaiduChannelRequest # 
NFData BaiduChannelRequest # 

Methods

rnf :: BaiduChannelRequest -> () #

type Rep BaiduChannelRequest # 
type Rep BaiduChannelRequest = D1 * (MetaData "BaiduChannelRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "BaiduChannelRequest'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_bcrAPIKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_bcrEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_bcrSecretKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))

baiduChannelRequest :: BaiduChannelRequest #

Creates a value of BaiduChannelRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • bcrAPIKey - Platform credential API key from Baidu.
  • bcrEnabled - If the channel is enabled for sending messages.
  • bcrSecretKey - Platform credential Secret key from Baidu.

bcrAPIKey :: Lens' BaiduChannelRequest (Maybe Text) #

Platform credential API key from Baidu.

bcrEnabled :: Lens' BaiduChannelRequest (Maybe Bool) #

If the channel is enabled for sending messages.

bcrSecretKey :: Lens' BaiduChannelRequest (Maybe Text) #

Platform credential Secret key from Baidu.

BaiduChannelResponse

data BaiduChannelResponse #

Baidu Cloud Messaging channel definition

See: baiduChannelResponse smart constructor.

Instances

Eq BaiduChannelResponse # 
Data BaiduChannelResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BaiduChannelResponse -> c BaiduChannelResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BaiduChannelResponse #

toConstr :: BaiduChannelResponse -> Constr #

dataTypeOf :: BaiduChannelResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c BaiduChannelResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BaiduChannelResponse) #

gmapT :: (forall b. Data b => b -> b) -> BaiduChannelResponse -> BaiduChannelResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BaiduChannelResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BaiduChannelResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> BaiduChannelResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BaiduChannelResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BaiduChannelResponse -> m BaiduChannelResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BaiduChannelResponse -> m BaiduChannelResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BaiduChannelResponse -> m BaiduChannelResponse #

Read BaiduChannelResponse # 
Show BaiduChannelResponse # 
Generic BaiduChannelResponse # 
Hashable BaiduChannelResponse # 
FromJSON BaiduChannelResponse # 
NFData BaiduChannelResponse # 

Methods

rnf :: BaiduChannelResponse -> () #

type Rep BaiduChannelResponse # 
type Rep BaiduChannelResponse = D1 * (MetaData "BaiduChannelResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "BaiduChannelResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_bcPlatform") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_bcLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_bcEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_bcCredential") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_bcIsArchived") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_bcApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_bcVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_bcId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_bcCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_bcLastModifiedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_bcHasCredential") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))))))

baiduChannelResponse :: BaiduChannelResponse #

Creates a value of BaiduChannelResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • bcPlatform - The platform type. Will be BAIDU
  • bcLastModifiedDate - Last date this was updated
  • bcEnabled - If the channel is enabled for sending messages.
  • bcCredential - The Baidu API key from Baidu.
  • bcIsArchived - Is this channel archived
  • bcApplicationId - Application id
  • bcVersion - Version of channel
  • bcId - Channel ID. Not used, only for backwards compatibility.
  • bcCreationDate - When was this segment created
  • bcLastModifiedBy - Who made the last change
  • bcHasCredential - Indicates whether the channel is configured with Baidu Cloud Push credentials. Amazon Pinpoint uses your credentials to authenticate push notifications with Baidu Cloud Push. Provide your credentials by setting the ApiKey and SecretKey attributes.

bcPlatform :: Lens' BaiduChannelResponse (Maybe Text) #

The platform type. Will be BAIDU

bcLastModifiedDate :: Lens' BaiduChannelResponse (Maybe Text) #

Last date this was updated

bcEnabled :: Lens' BaiduChannelResponse (Maybe Bool) #

If the channel is enabled for sending messages.

bcCredential :: Lens' BaiduChannelResponse (Maybe Text) #

The Baidu API key from Baidu.

bcIsArchived :: Lens' BaiduChannelResponse (Maybe Bool) #

Is this channel archived

bcId :: Lens' BaiduChannelResponse (Maybe Text) #

Channel ID. Not used, only for backwards compatibility.

bcCreationDate :: Lens' BaiduChannelResponse (Maybe Text) #

When was this segment created

bcLastModifiedBy :: Lens' BaiduChannelResponse (Maybe Text) #

Who made the last change

bcHasCredential :: Lens' BaiduChannelResponse (Maybe Bool) #

Indicates whether the channel is configured with Baidu Cloud Push credentials. Amazon Pinpoint uses your credentials to authenticate push notifications with Baidu Cloud Push. Provide your credentials by setting the ApiKey and SecretKey attributes.

BaiduMessage

data BaiduMessage #

Baidu Message.

See: baiduMessage smart constructor.

Instances

Eq BaiduMessage # 
Data BaiduMessage # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BaiduMessage -> c BaiduMessage #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BaiduMessage #

toConstr :: BaiduMessage -> Constr #

dataTypeOf :: BaiduMessage -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c BaiduMessage) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BaiduMessage) #

gmapT :: (forall b. Data b => b -> b) -> BaiduMessage -> BaiduMessage #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BaiduMessage -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BaiduMessage -> r #

gmapQ :: (forall d. Data d => d -> u) -> BaiduMessage -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BaiduMessage -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BaiduMessage -> m BaiduMessage #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BaiduMessage -> m BaiduMessage #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BaiduMessage -> m BaiduMessage #

Read BaiduMessage # 
Show BaiduMessage # 
Generic BaiduMessage # 

Associated Types

type Rep BaiduMessage :: * -> * #

Hashable BaiduMessage # 
ToJSON BaiduMessage # 
NFData BaiduMessage # 

Methods

rnf :: BaiduMessage -> () #

type Rep BaiduMessage # 
type Rep BaiduMessage = D1 * (MetaData "BaiduMessage" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "BaiduMessage'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_bmSubstitutions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_bmSilentPush") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_bmImageIconURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_bmRawContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_bmData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))) (S1 * (MetaSel (Just Symbol "_bmSmallImageIconURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_bmBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_bmURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_bmSound") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_bmAction") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Action))) (S1 * (MetaSel (Just Symbol "_bmImageURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_bmTitle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_bmIconReference") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))))

baiduMessage :: BaiduMessage #

Creates a value of BaiduMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • bmSubstitutions - Default message substitutions. Can be overridden by individual address substitutions.
  • bmSilentPush - Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  • bmImageIconURL - The URL that points to an image used as the large icon to the notification content view.
  • bmRawContent - The Raw JSON formatted string to be used as the payload. This value overrides the message.
  • bmData - The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
  • bmSmallImageIconURL - The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
  • bmBody - The message body of the notification, the email body or the text message.
  • bmURL - The URL to open in the user's mobile browser. Used if the value for Action is URL.
  • bmSound - Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in resraw/
  • bmAction - The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
  • bmImageURL - The URL that points to an image used in the push notification.
  • bmTitle - The message title that displays above the message on the user's device.
  • bmIconReference - The icon image name of the asset saved in your application.

bmSubstitutions :: Lens' BaiduMessage (HashMap Text [Text]) #

Default message substitutions. Can be overridden by individual address substitutions.

bmSilentPush :: Lens' BaiduMessage (Maybe Bool) #

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

bmImageIconURL :: Lens' BaiduMessage (Maybe Text) #

The URL that points to an image used as the large icon to the notification content view.

bmRawContent :: Lens' BaiduMessage (Maybe Text) #

The Raw JSON formatted string to be used as the payload. This value overrides the message.

bmData :: Lens' BaiduMessage (HashMap Text Text) #

The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

bmSmallImageIconURL :: Lens' BaiduMessage (Maybe Text) #

The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view

bmBody :: Lens' BaiduMessage (Maybe Text) #

The message body of the notification, the email body or the text message.

bmURL :: Lens' BaiduMessage (Maybe Text) #

The URL to open in the user's mobile browser. Used if the value for Action is URL.

bmSound :: Lens' BaiduMessage (Maybe Text) #

Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in resraw/

bmAction :: Lens' BaiduMessage (Maybe Action) #

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

bmImageURL :: Lens' BaiduMessage (Maybe Text) #

The URL that points to an image used in the push notification.

bmTitle :: Lens' BaiduMessage (Maybe Text) #

The message title that displays above the message on the user's device.

bmIconReference :: Lens' BaiduMessage (Maybe Text) #

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

CampaignEmailMessage

data CampaignEmailMessage #

The email message configuration.

See: campaignEmailMessage smart constructor.

Instances

Eq CampaignEmailMessage # 
Data CampaignEmailMessage # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CampaignEmailMessage -> c CampaignEmailMessage #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CampaignEmailMessage #

toConstr :: CampaignEmailMessage -> Constr #

dataTypeOf :: CampaignEmailMessage -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CampaignEmailMessage) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CampaignEmailMessage) #

gmapT :: (forall b. Data b => b -> b) -> CampaignEmailMessage -> CampaignEmailMessage #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CampaignEmailMessage -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CampaignEmailMessage -> r #

gmapQ :: (forall d. Data d => d -> u) -> CampaignEmailMessage -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CampaignEmailMessage -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CampaignEmailMessage -> m CampaignEmailMessage #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CampaignEmailMessage -> m CampaignEmailMessage #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CampaignEmailMessage -> m CampaignEmailMessage #

Read CampaignEmailMessage # 
Show CampaignEmailMessage # 
Generic CampaignEmailMessage # 
Hashable CampaignEmailMessage # 
ToJSON CampaignEmailMessage # 
FromJSON CampaignEmailMessage # 
NFData CampaignEmailMessage # 

Methods

rnf :: CampaignEmailMessage -> () #

type Rep CampaignEmailMessage # 
type Rep CampaignEmailMessage = D1 * (MetaData "CampaignEmailMessage" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "CampaignEmailMessage'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cemBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cemFromAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cemHTMLBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cemTitle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))

campaignEmailMessage :: CampaignEmailMessage #

Creates a value of CampaignEmailMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cemBody - The email text body.
  • cemFromAddress - The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
  • cemHTMLBody - The email html body.
  • cemTitle - The email title (Or subject).

cemBody :: Lens' CampaignEmailMessage (Maybe Text) #

The email text body.

cemFromAddress :: Lens' CampaignEmailMessage (Maybe Text) #

The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.

cemTitle :: Lens' CampaignEmailMessage (Maybe Text) #

The email title (Or subject).

CampaignHook

data CampaignHook #

See: campaignHook smart constructor.

Instances

Eq CampaignHook # 
Data CampaignHook # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CampaignHook -> c CampaignHook #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CampaignHook #

toConstr :: CampaignHook -> Constr #

dataTypeOf :: CampaignHook -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CampaignHook) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CampaignHook) #

gmapT :: (forall b. Data b => b -> b) -> CampaignHook -> CampaignHook #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CampaignHook -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CampaignHook -> r #

gmapQ :: (forall d. Data d => d -> u) -> CampaignHook -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CampaignHook -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CampaignHook -> m CampaignHook #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CampaignHook -> m CampaignHook #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CampaignHook -> m CampaignHook #

Read CampaignHook # 
Show CampaignHook # 
Generic CampaignHook # 

Associated Types

type Rep CampaignHook :: * -> * #

Hashable CampaignHook # 
ToJSON CampaignHook # 
FromJSON CampaignHook # 
NFData CampaignHook # 

Methods

rnf :: CampaignHook -> () #

type Rep CampaignHook # 
type Rep CampaignHook = D1 * (MetaData "CampaignHook" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "CampaignHook'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_chLambdaFunctionName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_chMode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Mode))) (S1 * (MetaSel (Just Symbol "_chWebURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))

campaignHook :: CampaignHook #

Creates a value of CampaignHook with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • chLambdaFunctionName - Lambda function name or arn to be called for delivery
  • chMode - What mode Lambda should be invoked in.
  • chWebURL - Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request

chLambdaFunctionName :: Lens' CampaignHook (Maybe Text) #

Lambda function name or arn to be called for delivery

chMode :: Lens' CampaignHook (Maybe Mode) #

What mode Lambda should be invoked in.

chWebURL :: Lens' CampaignHook (Maybe Text) #

Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request

CampaignLimits

data CampaignLimits #

Campaign Limits are used to limit the number of messages that can be sent to a user.

See: campaignLimits smart constructor.

Instances

Eq CampaignLimits # 
Data CampaignLimits # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CampaignLimits -> c CampaignLimits #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CampaignLimits #

toConstr :: CampaignLimits -> Constr #

dataTypeOf :: CampaignLimits -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CampaignLimits) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CampaignLimits) #

gmapT :: (forall b. Data b => b -> b) -> CampaignLimits -> CampaignLimits #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CampaignLimits -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CampaignLimits -> r #

gmapQ :: (forall d. Data d => d -> u) -> CampaignLimits -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CampaignLimits -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CampaignLimits -> m CampaignLimits #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CampaignLimits -> m CampaignLimits #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CampaignLimits -> m CampaignLimits #

Read CampaignLimits # 
Show CampaignLimits # 
Generic CampaignLimits # 

Associated Types

type Rep CampaignLimits :: * -> * #

Hashable CampaignLimits # 
ToJSON CampaignLimits # 
FromJSON CampaignLimits # 
NFData CampaignLimits # 

Methods

rnf :: CampaignLimits -> () #

type Rep CampaignLimits # 
type Rep CampaignLimits = D1 * (MetaData "CampaignLimits" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "CampaignLimits'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_clMessagesPerSecond") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_clDaily") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_clTotal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_clMaximumDuration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))))))

campaignLimits :: CampaignLimits #

Creates a value of CampaignLimits with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • clMessagesPerSecond - The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
  • clDaily - The maximum number of messages that the campaign can send daily.
  • clTotal - The maximum total number of messages that the campaign can send.
  • clMaximumDuration - The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.

clMessagesPerSecond :: Lens' CampaignLimits (Maybe Int) #

The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.

clDaily :: Lens' CampaignLimits (Maybe Int) #

The maximum number of messages that the campaign can send daily.

clTotal :: Lens' CampaignLimits (Maybe Int) #

The maximum total number of messages that the campaign can send.

clMaximumDuration :: Lens' CampaignLimits (Maybe Int) #

The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.

CampaignResponse

data CampaignResponse #

Campaign definition

See: campaignResponse smart constructor.

Instances

Eq CampaignResponse # 
Data CampaignResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CampaignResponse -> c CampaignResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CampaignResponse #

toConstr :: CampaignResponse -> Constr #

dataTypeOf :: CampaignResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CampaignResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CampaignResponse) #

gmapT :: (forall b. Data b => b -> b) -> CampaignResponse -> CampaignResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CampaignResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CampaignResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CampaignResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CampaignResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CampaignResponse -> m CampaignResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CampaignResponse -> m CampaignResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CampaignResponse -> m CampaignResponse #

Read CampaignResponse # 
Show CampaignResponse # 
Generic CampaignResponse # 
Hashable CampaignResponse # 
FromJSON CampaignResponse # 
NFData CampaignResponse # 

Methods

rnf :: CampaignResponse -> () #

type Rep CampaignResponse # 
type Rep CampaignResponse = D1 * (MetaData "CampaignResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "CampaignResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe CampaignState))) (S1 * (MetaSel (Just Symbol "_cLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cSchedule") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Schedule))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cHook") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe CampaignHook))) (S1 * (MetaSel (Just Symbol "_cTreatmentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cLimits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe CampaignLimits))) (S1 * (MetaSel (Just Symbol "_cIsPaused") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cDefaultState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe CampaignState))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_cHoldoutPercent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cTreatmentDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cMessageConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe MessageConfiguration))) (S1 * (MetaSel (Just Symbol "_cDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cSegmentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cAdditionalTreatments") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [TreatmentResource]))) (S1 * (MetaSel (Just Symbol "_cSegmentVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))))))))

campaignResponse :: CampaignResponse #

Creates a value of CampaignResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cState - The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
  • cLastModifiedDate - The date the campaign was last updated in ISO 8601 format.
  • cSchedule - The campaign schedule.
  • cHook - Campaign hook information.
  • cTreatmentName - The custom name of a variation of the campaign used for A/B testing.
  • cLimits - The campaign limits settings.
  • cIsPaused - Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
  • cDefaultState - The status of the campaign's default treatment. Only present for A/B test campaigns.
  • cApplicationId - The ID of the application to which the campaign applies.
  • cName - The custom name of the campaign.
  • cVersion - The campaign version number.
  • cHoldoutPercent - The allocated percentage of end users who will not receive messages from this campaign.
  • cTreatmentDescription - A custom description for the treatment.
  • cId - The unique campaign ID.
  • cCreationDate - The date the campaign was created in ISO 8601 format.
  • cMessageConfiguration - The message configuration settings.
  • cDescription - A description of the campaign.
  • cSegmentId - The ID of the segment to which the campaign sends messages.
  • cAdditionalTreatments - Treatments that are defined in addition to the default treatment.
  • cSegmentVersion - The version of the segment to which the campaign sends messages.

cState :: Lens' CampaignResponse (Maybe CampaignState) #

The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.

cLastModifiedDate :: Lens' CampaignResponse (Maybe Text) #

The date the campaign was last updated in ISO 8601 format.

cSchedule :: Lens' CampaignResponse (Maybe Schedule) #

The campaign schedule.

cHook :: Lens' CampaignResponse (Maybe CampaignHook) #

Campaign hook information.

cTreatmentName :: Lens' CampaignResponse (Maybe Text) #

The custom name of a variation of the campaign used for A/B testing.

cLimits :: Lens' CampaignResponse (Maybe CampaignLimits) #

The campaign limits settings.

cIsPaused :: Lens' CampaignResponse (Maybe Bool) #

Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.

cDefaultState :: Lens' CampaignResponse (Maybe CampaignState) #

The status of the campaign's default treatment. Only present for A/B test campaigns.

cApplicationId :: Lens' CampaignResponse (Maybe Text) #

The ID of the application to which the campaign applies.

cName :: Lens' CampaignResponse (Maybe Text) #

The custom name of the campaign.

cVersion :: Lens' CampaignResponse (Maybe Int) #

The campaign version number.

cHoldoutPercent :: Lens' CampaignResponse (Maybe Int) #

The allocated percentage of end users who will not receive messages from this campaign.

cTreatmentDescription :: Lens' CampaignResponse (Maybe Text) #

A custom description for the treatment.

cId :: Lens' CampaignResponse (Maybe Text) #

The unique campaign ID.

cCreationDate :: Lens' CampaignResponse (Maybe Text) #

The date the campaign was created in ISO 8601 format.

cDescription :: Lens' CampaignResponse (Maybe Text) #

A description of the campaign.

cSegmentId :: Lens' CampaignResponse (Maybe Text) #

The ID of the segment to which the campaign sends messages.

cAdditionalTreatments :: Lens' CampaignResponse [TreatmentResource] #

Treatments that are defined in addition to the default treatment.

cSegmentVersion :: Lens' CampaignResponse (Maybe Int) #

The version of the segment to which the campaign sends messages.

CampaignSmsMessage

data CampaignSmsMessage #

SMS message configuration.

See: campaignSmsMessage smart constructor.

Instances

Eq CampaignSmsMessage # 
Data CampaignSmsMessage # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CampaignSmsMessage -> c CampaignSmsMessage #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CampaignSmsMessage #

toConstr :: CampaignSmsMessage -> Constr #

dataTypeOf :: CampaignSmsMessage -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CampaignSmsMessage) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CampaignSmsMessage) #

gmapT :: (forall b. Data b => b -> b) -> CampaignSmsMessage -> CampaignSmsMessage #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CampaignSmsMessage -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CampaignSmsMessage -> r #

gmapQ :: (forall d. Data d => d -> u) -> CampaignSmsMessage -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CampaignSmsMessage -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CampaignSmsMessage -> m CampaignSmsMessage #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CampaignSmsMessage -> m CampaignSmsMessage #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CampaignSmsMessage -> m CampaignSmsMessage #

Read CampaignSmsMessage # 
Show CampaignSmsMessage # 
Generic CampaignSmsMessage # 
Hashable CampaignSmsMessage # 
ToJSON CampaignSmsMessage # 
FromJSON CampaignSmsMessage # 
NFData CampaignSmsMessage # 

Methods

rnf :: CampaignSmsMessage -> () #

type Rep CampaignSmsMessage # 
type Rep CampaignSmsMessage = D1 * (MetaData "CampaignSmsMessage" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "CampaignSmsMessage'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_csmBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_csmMessageType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe MessageType))) (S1 * (MetaSel (Just Symbol "_csmSenderId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))

campaignSmsMessage :: CampaignSmsMessage #

Creates a value of CampaignSmsMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

csmBody :: Lens' CampaignSmsMessage (Maybe Text) #

The SMS text body.

csmMessageType :: Lens' CampaignSmsMessage (Maybe MessageType) #

Is this is a transactional SMS message, otherwise a promotional message.

csmSenderId :: Lens' CampaignSmsMessage (Maybe Text) #

Sender ID of sent message.

CampaignState

data CampaignState #

State of the Campaign

See: campaignState smart constructor.

Instances

Eq CampaignState # 
Data CampaignState # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CampaignState -> c CampaignState #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CampaignState #

toConstr :: CampaignState -> Constr #

dataTypeOf :: CampaignState -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CampaignState) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CampaignState) #

gmapT :: (forall b. Data b => b -> b) -> CampaignState -> CampaignState #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CampaignState -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CampaignState -> r #

gmapQ :: (forall d. Data d => d -> u) -> CampaignState -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CampaignState -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CampaignState -> m CampaignState #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CampaignState -> m CampaignState #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CampaignState -> m CampaignState #

Read CampaignState # 
Show CampaignState # 
Generic CampaignState # 

Associated Types

type Rep CampaignState :: * -> * #

Hashable CampaignState # 
FromJSON CampaignState # 
NFData CampaignState # 

Methods

rnf :: CampaignState -> () #

type Rep CampaignState # 
type Rep CampaignState = D1 * (MetaData "CampaignState" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" True) (C1 * (MetaCons "CampaignState'" PrefixI True) (S1 * (MetaSel (Just Symbol "_csCampaignStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe CampaignStatus))))

campaignState :: CampaignState #

Creates a value of CampaignState with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • csCampaignStatus - The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED

csCampaignStatus :: Lens' CampaignState (Maybe CampaignStatus) #

The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED

CampaignsResponse

data CampaignsResponse #

List of available campaigns.

See: campaignsResponse smart constructor.

Instances

Eq CampaignsResponse # 
Data CampaignsResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CampaignsResponse -> c CampaignsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CampaignsResponse #

toConstr :: CampaignsResponse -> Constr #

dataTypeOf :: CampaignsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CampaignsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CampaignsResponse) #

gmapT :: (forall b. Data b => b -> b) -> CampaignsResponse -> CampaignsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CampaignsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CampaignsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CampaignsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CampaignsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CampaignsResponse -> m CampaignsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CampaignsResponse -> m CampaignsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CampaignsResponse -> m CampaignsResponse #

Read CampaignsResponse # 
Show CampaignsResponse # 
Generic CampaignsResponse # 
Hashable CampaignsResponse # 
FromJSON CampaignsResponse # 
NFData CampaignsResponse # 

Methods

rnf :: CampaignsResponse -> () #

type Rep CampaignsResponse # 
type Rep CampaignsResponse = D1 * (MetaData "CampaignsResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "CampaignsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cItem") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [CampaignResponse])))))

campaignsResponse :: CampaignsResponse #

Creates a value of CampaignsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cNextToken - The string that you use in a subsequent request to get the next page of results in a paginated response.
  • cItem - A list of campaigns.

cNextToken :: Lens' CampaignsResponse (Maybe Text) #

The string that you use in a subsequent request to get the next page of results in a paginated response.

CreateApplicationRequest

data CreateApplicationRequest #

Application Request.

See: createApplicationRequest smart constructor.

Instances

Eq CreateApplicationRequest # 
Data CreateApplicationRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateApplicationRequest -> c CreateApplicationRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateApplicationRequest #

toConstr :: CreateApplicationRequest -> Constr #

dataTypeOf :: CreateApplicationRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateApplicationRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateApplicationRequest) #

gmapT :: (forall b. Data b => b -> b) -> CreateApplicationRequest -> CreateApplicationRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateApplicationRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateApplicationRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateApplicationRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateApplicationRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateApplicationRequest -> m CreateApplicationRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateApplicationRequest -> m CreateApplicationRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateApplicationRequest -> m CreateApplicationRequest #

Read CreateApplicationRequest # 
Show CreateApplicationRequest # 
Generic CreateApplicationRequest # 
Hashable CreateApplicationRequest # 
ToJSON CreateApplicationRequest # 
NFData CreateApplicationRequest # 
type Rep CreateApplicationRequest # 
type Rep CreateApplicationRequest = D1 * (MetaData "CreateApplicationRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" True) (C1 * (MetaCons "CreateApplicationRequest'" PrefixI True) (S1 * (MetaSel (Just Symbol "_carName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Text))))

createApplicationRequest :: CreateApplicationRequest #

Creates a value of CreateApplicationRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • carName - The display name of the application. Used in the Amazon Pinpoint console.

carName :: Lens' CreateApplicationRequest (Maybe Text) #

The display name of the application. Used in the Amazon Pinpoint console.

DefaultMessage

data DefaultMessage #

Default Message across push notification, email, and sms.

See: defaultMessage smart constructor.

Instances

Eq DefaultMessage # 
Data DefaultMessage # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DefaultMessage -> c DefaultMessage #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DefaultMessage #

toConstr :: DefaultMessage -> Constr #

dataTypeOf :: DefaultMessage -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DefaultMessage) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DefaultMessage) #

gmapT :: (forall b. Data b => b -> b) -> DefaultMessage -> DefaultMessage #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DefaultMessage -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DefaultMessage -> r #

gmapQ :: (forall d. Data d => d -> u) -> DefaultMessage -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DefaultMessage -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DefaultMessage -> m DefaultMessage #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DefaultMessage -> m DefaultMessage #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DefaultMessage -> m DefaultMessage #

Read DefaultMessage # 
Show DefaultMessage # 
Generic DefaultMessage # 

Associated Types

type Rep DefaultMessage :: * -> * #

Hashable DefaultMessage # 
ToJSON DefaultMessage # 
NFData DefaultMessage # 

Methods

rnf :: DefaultMessage -> () #

type Rep DefaultMessage # 
type Rep DefaultMessage = D1 * (MetaData "DefaultMessage" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "DefaultMessage'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dmSubstitutions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text [Text])))) (S1 * (MetaSel (Just Symbol "_dmBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))

defaultMessage :: DefaultMessage #

Creates a value of DefaultMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dmSubstitutions - Default message substitutions. Can be overridden by individual address substitutions.
  • dmBody - The message body of the notification, the email body or the text message.

dmSubstitutions :: Lens' DefaultMessage (HashMap Text [Text]) #

Default message substitutions. Can be overridden by individual address substitutions.

dmBody :: Lens' DefaultMessage (Maybe Text) #

The message body of the notification, the email body or the text message.

DefaultPushNotificationMessage

data DefaultPushNotificationMessage #

Default Push Notification Message.

See: defaultPushNotificationMessage smart constructor.

Instances

Eq DefaultPushNotificationMessage # 
Data DefaultPushNotificationMessage # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DefaultPushNotificationMessage -> c DefaultPushNotificationMessage #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DefaultPushNotificationMessage #

toConstr :: DefaultPushNotificationMessage -> Constr #

dataTypeOf :: DefaultPushNotificationMessage -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DefaultPushNotificationMessage) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DefaultPushNotificationMessage) #

gmapT :: (forall b. Data b => b -> b) -> DefaultPushNotificationMessage -> DefaultPushNotificationMessage #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DefaultPushNotificationMessage -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DefaultPushNotificationMessage -> r #

gmapQ :: (forall d. Data d => d -> u) -> DefaultPushNotificationMessage -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DefaultPushNotificationMessage -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DefaultPushNotificationMessage -> m DefaultPushNotificationMessage #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DefaultPushNotificationMessage -> m DefaultPushNotificationMessage #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DefaultPushNotificationMessage -> m DefaultPushNotificationMessage #

Read DefaultPushNotificationMessage # 
Show DefaultPushNotificationMessage # 
Generic DefaultPushNotificationMessage # 
Hashable DefaultPushNotificationMessage # 
ToJSON DefaultPushNotificationMessage # 
NFData DefaultPushNotificationMessage # 
type Rep DefaultPushNotificationMessage # 
type Rep DefaultPushNotificationMessage = D1 * (MetaData "DefaultPushNotificationMessage" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "DefaultPushNotificationMessage'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dpnmSubstitutions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dpnmSilentPush") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_dpnmData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dpnmBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dpnmURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dpnmAction") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Action))) (S1 * (MetaSel (Just Symbol "_dpnmTitle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))

defaultPushNotificationMessage :: DefaultPushNotificationMessage #

Creates a value of DefaultPushNotificationMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dpnmSubstitutions - Default message substitutions. Can be overridden by individual address substitutions.
  • dpnmSilentPush - Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  • dpnmData - The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
  • dpnmBody - The message body of the notification, the email body or the text message.
  • dpnmURL - The URL to open in the user's mobile browser. Used if the value for Action is URL.
  • dpnmAction - The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
  • dpnmTitle - The message title that displays above the message on the user's device.

dpnmSubstitutions :: Lens' DefaultPushNotificationMessage (HashMap Text [Text]) #

Default message substitutions. Can be overridden by individual address substitutions.

dpnmSilentPush :: Lens' DefaultPushNotificationMessage (Maybe Bool) #

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

dpnmData :: Lens' DefaultPushNotificationMessage (HashMap Text Text) #

The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

dpnmBody :: Lens' DefaultPushNotificationMessage (Maybe Text) #

The message body of the notification, the email body or the text message.

dpnmURL :: Lens' DefaultPushNotificationMessage (Maybe Text) #

The URL to open in the user's mobile browser. Used if the value for Action is URL.

dpnmAction :: Lens' DefaultPushNotificationMessage (Maybe Action) #

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

dpnmTitle :: Lens' DefaultPushNotificationMessage (Maybe Text) #

The message title that displays above the message on the user's device.

DirectMessageConfiguration

data DirectMessageConfiguration #

The message configuration.

See: directMessageConfiguration smart constructor.

Instances

Eq DirectMessageConfiguration # 
Data DirectMessageConfiguration # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DirectMessageConfiguration -> c DirectMessageConfiguration #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DirectMessageConfiguration #

toConstr :: DirectMessageConfiguration -> Constr #

dataTypeOf :: DirectMessageConfiguration -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DirectMessageConfiguration) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DirectMessageConfiguration) #

gmapT :: (forall b. Data b => b -> b) -> DirectMessageConfiguration -> DirectMessageConfiguration #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DirectMessageConfiguration -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DirectMessageConfiguration -> r #

gmapQ :: (forall d. Data d => d -> u) -> DirectMessageConfiguration -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DirectMessageConfiguration -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DirectMessageConfiguration -> m DirectMessageConfiguration #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DirectMessageConfiguration -> m DirectMessageConfiguration #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DirectMessageConfiguration -> m DirectMessageConfiguration #

Read DirectMessageConfiguration # 
Show DirectMessageConfiguration # 
Generic DirectMessageConfiguration # 
Hashable DirectMessageConfiguration # 
ToJSON DirectMessageConfiguration # 
NFData DirectMessageConfiguration # 
type Rep DirectMessageConfiguration # 
type Rep DirectMessageConfiguration = D1 * (MetaData "DirectMessageConfiguration" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "DirectMessageConfiguration'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dmcAPNSMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe APNSMessage))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dmcGCMMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe GCMMessage))) (S1 * (MetaSel (Just Symbol "_dmcDefaultMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DefaultMessage))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dmcADMMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ADMMessage))) (S1 * (MetaSel (Just Symbol "_dmcSMSMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe SMSMessage)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dmcBaiduMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe BaiduMessage))) (S1 * (MetaSel (Just Symbol "_dmcDefaultPushNotificationMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DefaultPushNotificationMessage)))))))

directMessageConfiguration :: DirectMessageConfiguration #

Creates a value of DirectMessageConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dmcAPNSMessage - The message to APNS channels. Overrides the default push notification message.
  • dmcGCMMessage - The message to GCM channels. Overrides the default push notification message.
  • dmcDefaultMessage - The default message for all channels.
  • dmcADMMessage - The message to ADM channels. Overrides the default push notification message.
  • dmcSMSMessage - The message to SMS channels. Overrides the default message.
  • dmcBaiduMessage - The message to Baidu GCM channels. Overrides the default push notification message.
  • dmcDefaultPushNotificationMessage - The default push notification message for all push channels.

dmcAPNSMessage :: Lens' DirectMessageConfiguration (Maybe APNSMessage) #

The message to APNS channels. Overrides the default push notification message.

dmcGCMMessage :: Lens' DirectMessageConfiguration (Maybe GCMMessage) #

The message to GCM channels. Overrides the default push notification message.

dmcDefaultMessage :: Lens' DirectMessageConfiguration (Maybe DefaultMessage) #

The default message for all channels.

dmcADMMessage :: Lens' DirectMessageConfiguration (Maybe ADMMessage) #

The message to ADM channels. Overrides the default push notification message.

dmcSMSMessage :: Lens' DirectMessageConfiguration (Maybe SMSMessage) #

The message to SMS channels. Overrides the default message.

dmcBaiduMessage :: Lens' DirectMessageConfiguration (Maybe BaiduMessage) #

The message to Baidu GCM channels. Overrides the default push notification message.

dmcDefaultPushNotificationMessage :: Lens' DirectMessageConfiguration (Maybe DefaultPushNotificationMessage) #

The default push notification message for all push channels.

EmailChannelRequest

data EmailChannelRequest #

Email Channel Request

See: emailChannelRequest smart constructor.

Instances

Eq EmailChannelRequest # 
Data EmailChannelRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EmailChannelRequest -> c EmailChannelRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EmailChannelRequest #

toConstr :: EmailChannelRequest -> Constr #

dataTypeOf :: EmailChannelRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EmailChannelRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EmailChannelRequest) #

gmapT :: (forall b. Data b => b -> b) -> EmailChannelRequest -> EmailChannelRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EmailChannelRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EmailChannelRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> EmailChannelRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EmailChannelRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EmailChannelRequest -> m EmailChannelRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EmailChannelRequest -> m EmailChannelRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EmailChannelRequest -> m EmailChannelRequest #

Read EmailChannelRequest # 
Show EmailChannelRequest # 
Generic EmailChannelRequest # 
Hashable EmailChannelRequest # 
ToJSON EmailChannelRequest # 
NFData EmailChannelRequest # 

Methods

rnf :: EmailChannelRequest -> () #

type Rep EmailChannelRequest # 
type Rep EmailChannelRequest = D1 * (MetaData "EmailChannelRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "EmailChannelRequest'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ecrEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_ecrFromAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ecrIdentity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ecrRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))

emailChannelRequest :: EmailChannelRequest #

Creates a value of EmailChannelRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ecrEnabled - If the channel is enabled for sending messages.
  • ecrFromAddress - The email address used to send emails from.
  • ecrIdentity - The ARN of an identity verified with SES.
  • ecrRoleARN - The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service

ecrEnabled :: Lens' EmailChannelRequest (Maybe Bool) #

If the channel is enabled for sending messages.

ecrFromAddress :: Lens' EmailChannelRequest (Maybe Text) #

The email address used to send emails from.

ecrIdentity :: Lens' EmailChannelRequest (Maybe Text) #

The ARN of an identity verified with SES.

ecrRoleARN :: Lens' EmailChannelRequest (Maybe Text) #

The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service

EmailChannelResponse

data EmailChannelResponse #

Email Channel Response.

See: emailChannelResponse smart constructor.

Instances

Eq EmailChannelResponse # 
Data EmailChannelResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EmailChannelResponse -> c EmailChannelResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EmailChannelResponse #

toConstr :: EmailChannelResponse -> Constr #

dataTypeOf :: EmailChannelResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EmailChannelResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EmailChannelResponse) #

gmapT :: (forall b. Data b => b -> b) -> EmailChannelResponse -> EmailChannelResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EmailChannelResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EmailChannelResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> EmailChannelResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EmailChannelResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EmailChannelResponse -> m EmailChannelResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EmailChannelResponse -> m EmailChannelResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EmailChannelResponse -> m EmailChannelResponse #

Read EmailChannelResponse # 
Show EmailChannelResponse # 
Generic EmailChannelResponse # 
Hashable EmailChannelResponse # 
FromJSON EmailChannelResponse # 
NFData EmailChannelResponse # 

Methods

rnf :: EmailChannelResponse -> () #

type Rep EmailChannelResponse # 
type Rep EmailChannelResponse = D1 * (MetaData "EmailChannelResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "EmailChannelResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ecPlatform") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ecLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ecEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ecFromAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ecIsArchived") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_ecApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ecVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ecId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ecCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ecLastModifiedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ecIdentity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ecHasCredential") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_ecRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))))

emailChannelResponse :: EmailChannelResponse #

Creates a value of EmailChannelResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ecLastModifiedDate :: Lens' EmailChannelResponse (Maybe Text) #

Last date this was updated

ecEnabled :: Lens' EmailChannelResponse (Maybe Bool) #

If the channel is enabled for sending messages.

ecFromAddress :: Lens' EmailChannelResponse (Maybe Text) #

The email address used to send emails from.

ecIsArchived :: Lens' EmailChannelResponse (Maybe Bool) #

Is this channel archived

ecApplicationId :: Lens' EmailChannelResponse (Maybe Text) #

The unique ID of the application to which the email channel belongs.

ecId :: Lens' EmailChannelResponse (Maybe Text) #

Channel ID. Not used, only for backwards compatibility.

ecCreationDate :: Lens' EmailChannelResponse (Maybe Text) #

The date that the settings were last updated in ISO 8601 format.

ecLastModifiedBy :: Lens' EmailChannelResponse (Maybe Text) #

Who last updated this entry

ecIdentity :: Lens' EmailChannelResponse (Maybe Text) #

The ARN of an identity verified with SES.

ecHasCredential :: Lens' EmailChannelResponse (Maybe Bool) #

If the channel is registered with a credential for authentication.

ecRoleARN :: Lens' EmailChannelResponse (Maybe Text) #

The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service

EndpointBatchItem

data EndpointBatchItem #

Endpoint update request

See: endpointBatchItem smart constructor.

Instances

Eq EndpointBatchItem # 
Data EndpointBatchItem # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EndpointBatchItem -> c EndpointBatchItem #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EndpointBatchItem #

toConstr :: EndpointBatchItem -> Constr #

dataTypeOf :: EndpointBatchItem -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EndpointBatchItem) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EndpointBatchItem) #

gmapT :: (forall b. Data b => b -> b) -> EndpointBatchItem -> EndpointBatchItem #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EndpointBatchItem -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EndpointBatchItem -> r #

gmapQ :: (forall d. Data d => d -> u) -> EndpointBatchItem -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EndpointBatchItem -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EndpointBatchItem -> m EndpointBatchItem #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointBatchItem -> m EndpointBatchItem #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointBatchItem -> m EndpointBatchItem #

Read EndpointBatchItem # 
Show EndpointBatchItem # 
Generic EndpointBatchItem # 
Hashable EndpointBatchItem # 
ToJSON EndpointBatchItem # 
NFData EndpointBatchItem # 

Methods

rnf :: EndpointBatchItem -> () #

type Rep EndpointBatchItem # 
type Rep EndpointBatchItem = D1 * (MetaData "EndpointBatchItem" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "EndpointBatchItem'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ebiRequestId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ebiMetrics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Double)))) (S1 * (MetaSel (Just Symbol "_ebiLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EndpointLocation))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ebiDemographic") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EndpointDemographic))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ebiAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ebiEffectiveDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ebiUser") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EndpointUser))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ebiAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text [Text])))) (S1 * (MetaSel (Just Symbol "_ebiEndpointStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ebiOptOut") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ebiId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ebiChannelType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ChannelType))))))))

endpointBatchItem :: EndpointBatchItem #

Creates a value of EndpointBatchItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ebiRequestId - The unique ID for the most recent request to update the endpoint.
  • ebiMetrics - Custom metrics that your app reports to Amazon Pinpoint.
  • ebiLocation - The endpoint location attributes.
  • ebiDemographic - The endpoint demographic attributes.
  • ebiAddress - The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
  • ebiEffectiveDate - The last time the endpoint was updated. Provided in ISO 8601 format.
  • ebiUser - Custom user-specific attributes that your app reports to Amazon Pinpoint.
  • ebiAttributes - Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
  • ebiEndpointStatus - The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
  • ebiOptOut - Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
  • ebiId - The unique Id for the Endpoint in the batch.
  • ebiChannelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

ebiRequestId :: Lens' EndpointBatchItem (Maybe Text) #

The unique ID for the most recent request to update the endpoint.

ebiMetrics :: Lens' EndpointBatchItem (HashMap Text Double) #

Custom metrics that your app reports to Amazon Pinpoint.

ebiLocation :: Lens' EndpointBatchItem (Maybe EndpointLocation) #

The endpoint location attributes.

ebiDemographic :: Lens' EndpointBatchItem (Maybe EndpointDemographic) #

The endpoint demographic attributes.

ebiAddress :: Lens' EndpointBatchItem (Maybe Text) #

The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).

ebiEffectiveDate :: Lens' EndpointBatchItem (Maybe Text) #

The last time the endpoint was updated. Provided in ISO 8601 format.

ebiUser :: Lens' EndpointBatchItem (Maybe EndpointUser) #

Custom user-specific attributes that your app reports to Amazon Pinpoint.

ebiAttributes :: Lens' EndpointBatchItem (HashMap Text [Text]) #

Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.

ebiEndpointStatus :: Lens' EndpointBatchItem (Maybe Text) #

The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.

ebiOptOut :: Lens' EndpointBatchItem (Maybe Text) #

Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.

ebiId :: Lens' EndpointBatchItem (Maybe Text) #

The unique Id for the Endpoint in the batch.

ebiChannelType :: Lens' EndpointBatchItem (Maybe ChannelType) #

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

EndpointBatchRequest

data EndpointBatchRequest #

Endpoint batch update request.

See: endpointBatchRequest smart constructor.

Instances

Eq EndpointBatchRequest # 
Data EndpointBatchRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EndpointBatchRequest -> c EndpointBatchRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EndpointBatchRequest #

toConstr :: EndpointBatchRequest -> Constr #

dataTypeOf :: EndpointBatchRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EndpointBatchRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EndpointBatchRequest) #

gmapT :: (forall b. Data b => b -> b) -> EndpointBatchRequest -> EndpointBatchRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EndpointBatchRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EndpointBatchRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> EndpointBatchRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EndpointBatchRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EndpointBatchRequest -> m EndpointBatchRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointBatchRequest -> m EndpointBatchRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointBatchRequest -> m EndpointBatchRequest #

Read EndpointBatchRequest # 
Show EndpointBatchRequest # 
Generic EndpointBatchRequest # 
Hashable EndpointBatchRequest # 
ToJSON EndpointBatchRequest # 
NFData EndpointBatchRequest # 

Methods

rnf :: EndpointBatchRequest -> () #

type Rep EndpointBatchRequest # 
type Rep EndpointBatchRequest = D1 * (MetaData "EndpointBatchRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" True) (C1 * (MetaCons "EndpointBatchRequest'" PrefixI True) (S1 * (MetaSel (Just Symbol "_ebrItem") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe [EndpointBatchItem]))))

endpointBatchRequest :: EndpointBatchRequest #

Creates a value of EndpointBatchRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ebrItem - List of items to update. Maximum 100 items

ebrItem :: Lens' EndpointBatchRequest [EndpointBatchItem] #

List of items to update. Maximum 100 items

EndpointDemographic

data EndpointDemographic #

Endpoint demographic data

See: endpointDemographic smart constructor.

Instances

Eq EndpointDemographic # 
Data EndpointDemographic # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EndpointDemographic -> c EndpointDemographic #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EndpointDemographic #

toConstr :: EndpointDemographic -> Constr #

dataTypeOf :: EndpointDemographic -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EndpointDemographic) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EndpointDemographic) #

gmapT :: (forall b. Data b => b -> b) -> EndpointDemographic -> EndpointDemographic #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EndpointDemographic -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EndpointDemographic -> r #

gmapQ :: (forall d. Data d => d -> u) -> EndpointDemographic -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EndpointDemographic -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EndpointDemographic -> m EndpointDemographic #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointDemographic -> m EndpointDemographic #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointDemographic -> m EndpointDemographic #

Read EndpointDemographic # 
Show EndpointDemographic # 
Generic EndpointDemographic # 
Hashable EndpointDemographic # 
ToJSON EndpointDemographic # 
FromJSON EndpointDemographic # 
NFData EndpointDemographic # 

Methods

rnf :: EndpointDemographic -> () #

type Rep EndpointDemographic # 

endpointDemographic :: EndpointDemographic #

Creates a value of EndpointDemographic with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • edPlatform - The endpoint platform, such as ios or android.
  • edPlatformVersion - The endpoint platform version.
  • edLocale - The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
  • edAppVersion - The version of the application associated with the endpoint.
  • edModel - The endpoint model, such as iPhone.
  • edMake - The endpoint make, such as such as Apple or Samsung.
  • edModelVersion - The endpoint model version.
  • edTimezone - The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.

edPlatform :: Lens' EndpointDemographic (Maybe Text) #

The endpoint platform, such as ios or android.

edPlatformVersion :: Lens' EndpointDemographic (Maybe Text) #

The endpoint platform version.

edLocale :: Lens' EndpointDemographic (Maybe Text) #

The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.

edAppVersion :: Lens' EndpointDemographic (Maybe Text) #

The version of the application associated with the endpoint.

edModel :: Lens' EndpointDemographic (Maybe Text) #

The endpoint model, such as iPhone.

edMake :: Lens' EndpointDemographic (Maybe Text) #

The endpoint make, such as such as Apple or Samsung.

edModelVersion :: Lens' EndpointDemographic (Maybe Text) #

The endpoint model version.

edTimezone :: Lens' EndpointDemographic (Maybe Text) #

The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.

EndpointLocation

data EndpointLocation #

Endpoint location data

See: endpointLocation smart constructor.

Instances

Eq EndpointLocation # 
Data EndpointLocation # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EndpointLocation -> c EndpointLocation #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EndpointLocation #

toConstr :: EndpointLocation -> Constr #

dataTypeOf :: EndpointLocation -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EndpointLocation) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EndpointLocation) #

gmapT :: (forall b. Data b => b -> b) -> EndpointLocation -> EndpointLocation #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EndpointLocation -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EndpointLocation -> r #

gmapQ :: (forall d. Data d => d -> u) -> EndpointLocation -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EndpointLocation -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EndpointLocation -> m EndpointLocation #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointLocation -> m EndpointLocation #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointLocation -> m EndpointLocation #

Read EndpointLocation # 
Show EndpointLocation # 
Generic EndpointLocation # 
Hashable EndpointLocation # 
ToJSON EndpointLocation # 
FromJSON EndpointLocation # 
NFData EndpointLocation # 

Methods

rnf :: EndpointLocation -> () #

type Rep EndpointLocation # 
type Rep EndpointLocation = D1 * (MetaData "EndpointLocation" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "EndpointLocation'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_elPostalCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_elLatitude") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Double))) (S1 * (MetaSel (Just Symbol "_elCountry") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_elCity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_elRegion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_elLongitude") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Double)))))))

endpointLocation :: EndpointLocation #

Creates a value of EndpointLocation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • elPostalCode - The postal code or zip code of the endpoint.
  • elLatitude - The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
  • elCountry - Country according to ISO 3166-1 Alpha-2 codes. For example, US.
  • elCity - The city where the endpoint is located.
  • elRegion - The region of the endpoint location. For example, corresponds to a state in US.
  • elLongitude - The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).

elPostalCode :: Lens' EndpointLocation (Maybe Text) #

The postal code or zip code of the endpoint.

elLatitude :: Lens' EndpointLocation (Maybe Double) #

The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).

elCountry :: Lens' EndpointLocation (Maybe Text) #

Country according to ISO 3166-1 Alpha-2 codes. For example, US.

elCity :: Lens' EndpointLocation (Maybe Text) #

The city where the endpoint is located.

elRegion :: Lens' EndpointLocation (Maybe Text) #

The region of the endpoint location. For example, corresponds to a state in US.

elLongitude :: Lens' EndpointLocation (Maybe Double) #

The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).

EndpointMessageResult

data EndpointMessageResult #

The result from sending a message to an endpoint.

See: endpointMessageResult smart constructor.

Instances

Eq EndpointMessageResult # 
Data EndpointMessageResult # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EndpointMessageResult -> c EndpointMessageResult #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EndpointMessageResult #

toConstr :: EndpointMessageResult -> Constr #

dataTypeOf :: EndpointMessageResult -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EndpointMessageResult) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EndpointMessageResult) #

gmapT :: (forall b. Data b => b -> b) -> EndpointMessageResult -> EndpointMessageResult #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EndpointMessageResult -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EndpointMessageResult -> r #

gmapQ :: (forall d. Data d => d -> u) -> EndpointMessageResult -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EndpointMessageResult -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EndpointMessageResult -> m EndpointMessageResult #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointMessageResult -> m EndpointMessageResult #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointMessageResult -> m EndpointMessageResult #

Read EndpointMessageResult # 
Show EndpointMessageResult # 
Generic EndpointMessageResult # 
Hashable EndpointMessageResult # 
FromJSON EndpointMessageResult # 
NFData EndpointMessageResult # 

Methods

rnf :: EndpointMessageResult -> () #

type Rep EndpointMessageResult # 
type Rep EndpointMessageResult = D1 * (MetaData "EndpointMessageResult" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "EndpointMessageResult'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_emrDeliveryStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DeliveryStatus))) (S1 * (MetaSel (Just Symbol "_emrAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_emrStatusMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_emrUpdatedToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_emrStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))))))

endpointMessageResult :: EndpointMessageResult #

Creates a value of EndpointMessageResult with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

emrAddress :: Lens' EndpointMessageResult (Maybe Text) #

Address that endpoint message was delivered to.

emrStatusMessage :: Lens' EndpointMessageResult (Maybe Text) #

Status message for message delivery.

emrUpdatedToken :: Lens' EndpointMessageResult (Maybe Text) #

If token was updated as part of delivery. (This is GCM Specific)

emrStatusCode :: Lens' EndpointMessageResult (Maybe Int) #

Downstream service status code.

EndpointRequest

data EndpointRequest #

Endpoint update request

See: endpointRequest smart constructor.

Instances

Eq EndpointRequest # 
Data EndpointRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EndpointRequest -> c EndpointRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EndpointRequest #

toConstr :: EndpointRequest -> Constr #

dataTypeOf :: EndpointRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EndpointRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EndpointRequest) #

gmapT :: (forall b. Data b => b -> b) -> EndpointRequest -> EndpointRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EndpointRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EndpointRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> EndpointRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EndpointRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EndpointRequest -> m EndpointRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointRequest -> m EndpointRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointRequest -> m EndpointRequest #

Read EndpointRequest # 
Show EndpointRequest # 
Generic EndpointRequest # 
Hashable EndpointRequest # 
ToJSON EndpointRequest # 
NFData EndpointRequest # 

Methods

rnf :: EndpointRequest -> () #

type Rep EndpointRequest # 
type Rep EndpointRequest = D1 * (MetaData "EndpointRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "EndpointRequest'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_erRequestId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_erMetrics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Double))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_erLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EndpointLocation))) ((:*:) * (S1 * (MetaSel (Just Symbol "_erDemographic") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EndpointDemographic))) (S1 * (MetaSel (Just Symbol "_erAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_erEffectiveDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_erUser") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EndpointUser))) (S1 * (MetaSel (Just Symbol "_erAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text [Text])))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_erEndpointStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_erOptOut") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_erChannelType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ChannelType))))))))

endpointRequest :: EndpointRequest #

Creates a value of EndpointRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • erRequestId - The unique ID for the most recent request to update the endpoint.
  • erMetrics - Custom metrics that your app reports to Amazon Pinpoint.
  • erLocation - The endpoint location attributes.
  • erDemographic - The endpoint demographic attributes.
  • erAddress - The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
  • erEffectiveDate - The last time the endpoint was updated. Provided in ISO 8601 format.
  • erUser - Custom user-specific attributes that your app reports to Amazon Pinpoint.
  • erAttributes - Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
  • erEndpointStatus - The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
  • erOptOut - Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
  • erChannelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

erRequestId :: Lens' EndpointRequest (Maybe Text) #

The unique ID for the most recent request to update the endpoint.

erMetrics :: Lens' EndpointRequest (HashMap Text Double) #

Custom metrics that your app reports to Amazon Pinpoint.

erLocation :: Lens' EndpointRequest (Maybe EndpointLocation) #

The endpoint location attributes.

erDemographic :: Lens' EndpointRequest (Maybe EndpointDemographic) #

The endpoint demographic attributes.

erAddress :: Lens' EndpointRequest (Maybe Text) #

The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).

erEffectiveDate :: Lens' EndpointRequest (Maybe Text) #

The last time the endpoint was updated. Provided in ISO 8601 format.

erUser :: Lens' EndpointRequest (Maybe EndpointUser) #

Custom user-specific attributes that your app reports to Amazon Pinpoint.

erAttributes :: Lens' EndpointRequest (HashMap Text [Text]) #

Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.

erEndpointStatus :: Lens' EndpointRequest (Maybe Text) #

The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.

erOptOut :: Lens' EndpointRequest (Maybe Text) #

Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.

erChannelType :: Lens' EndpointRequest (Maybe ChannelType) #

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

EndpointResponse

data EndpointResponse #

Endpoint response

See: endpointResponse smart constructor.

Instances

Eq EndpointResponse # 
Data EndpointResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EndpointResponse -> c EndpointResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EndpointResponse #

toConstr :: EndpointResponse -> Constr #

dataTypeOf :: EndpointResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EndpointResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EndpointResponse) #

gmapT :: (forall b. Data b => b -> b) -> EndpointResponse -> EndpointResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EndpointResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EndpointResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> EndpointResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EndpointResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EndpointResponse -> m EndpointResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointResponse -> m EndpointResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointResponse -> m EndpointResponse #

Read EndpointResponse # 
Show EndpointResponse # 
Generic EndpointResponse # 
Hashable EndpointResponse # 
FromJSON EndpointResponse # 
NFData EndpointResponse # 

Methods

rnf :: EndpointResponse -> () #

type Rep EndpointResponse # 
type Rep EndpointResponse = D1 * (MetaData "EndpointResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "EndpointResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_eRequestId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_eMetrics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Double)))) (S1 * (MetaSel (Just Symbol "_eLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EndpointLocation))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_eDemographic") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EndpointDemographic))) (S1 * (MetaSel (Just Symbol "_eCohortId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_eAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_eEffectiveDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_eUser") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EndpointUser))) (S1 * (MetaSel (Just Symbol "_eApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_eAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text [Text])))) (S1 * (MetaSel (Just Symbol "_eEndpointStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_eOptOut") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_eId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_eCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_eChannelType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ChannelType))))))))

endpointResponse :: EndpointResponse #

Creates a value of EndpointResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • eRequestId - The unique ID for the most recent request to update the endpoint.
  • eMetrics - Custom metrics that your app reports to Amazon Pinpoint.
  • eLocation - The endpoint location attributes.
  • eDemographic - The endpoint demographic attributes.
  • eCohortId - A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
  • eAddress - The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
  • eEffectiveDate - The last time the endpoint was updated. Provided in ISO 8601 format.
  • eUser - Custom user-specific attributes that your app reports to Amazon Pinpoint.
  • eApplicationId - The ID of the application associated with the endpoint.
  • eAttributes - Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
  • eEndpointStatus - The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
  • eOptOut - Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
  • eId - The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.
  • eCreationDate - The last time the endpoint was created. Provided in ISO 8601 format.
  • eChannelType - The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

eRequestId :: Lens' EndpointResponse (Maybe Text) #

The unique ID for the most recent request to update the endpoint.

eMetrics :: Lens' EndpointResponse (HashMap Text Double) #

Custom metrics that your app reports to Amazon Pinpoint.

eLocation :: Lens' EndpointResponse (Maybe EndpointLocation) #

The endpoint location attributes.

eDemographic :: Lens' EndpointResponse (Maybe EndpointDemographic) #

The endpoint demographic attributes.

eCohortId :: Lens' EndpointResponse (Maybe Text) #

A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.

eAddress :: Lens' EndpointResponse (Maybe Text) #

The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).

eEffectiveDate :: Lens' EndpointResponse (Maybe Text) #

The last time the endpoint was updated. Provided in ISO 8601 format.

eUser :: Lens' EndpointResponse (Maybe EndpointUser) #

Custom user-specific attributes that your app reports to Amazon Pinpoint.

eApplicationId :: Lens' EndpointResponse (Maybe Text) #

The ID of the application associated with the endpoint.

eAttributes :: Lens' EndpointResponse (HashMap Text [Text]) #

Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.

eEndpointStatus :: Lens' EndpointResponse (Maybe Text) #

The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.

eOptOut :: Lens' EndpointResponse (Maybe Text) #

Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.

eId :: Lens' EndpointResponse (Maybe Text) #

The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.

eCreationDate :: Lens' EndpointResponse (Maybe Text) #

The last time the endpoint was created. Provided in ISO 8601 format.

eChannelType :: Lens' EndpointResponse (Maybe ChannelType) #

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

EndpointSendConfiguration

data EndpointSendConfiguration #

Endpoint send configuration.

See: endpointSendConfiguration smart constructor.

Instances

Eq EndpointSendConfiguration # 
Data EndpointSendConfiguration # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EndpointSendConfiguration -> c EndpointSendConfiguration #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EndpointSendConfiguration #

toConstr :: EndpointSendConfiguration -> Constr #

dataTypeOf :: EndpointSendConfiguration -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EndpointSendConfiguration) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EndpointSendConfiguration) #

gmapT :: (forall b. Data b => b -> b) -> EndpointSendConfiguration -> EndpointSendConfiguration #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EndpointSendConfiguration -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EndpointSendConfiguration -> r #

gmapQ :: (forall d. Data d => d -> u) -> EndpointSendConfiguration -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EndpointSendConfiguration -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EndpointSendConfiguration -> m EndpointSendConfiguration #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointSendConfiguration -> m EndpointSendConfiguration #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointSendConfiguration -> m EndpointSendConfiguration #

Read EndpointSendConfiguration # 
Show EndpointSendConfiguration # 
Generic EndpointSendConfiguration # 
Hashable EndpointSendConfiguration # 
ToJSON EndpointSendConfiguration # 
NFData EndpointSendConfiguration # 
type Rep EndpointSendConfiguration # 
type Rep EndpointSendConfiguration = D1 * (MetaData "EndpointSendConfiguration" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "EndpointSendConfiguration'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_escSubstitutions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text [Text])))) (S1 * (MetaSel (Just Symbol "_escTitleOverride") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_escContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_escRawContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_escBodyOverride") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))

endpointSendConfiguration :: EndpointSendConfiguration #

Creates a value of EndpointSendConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • escSubstitutions - A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.
  • escTitleOverride - Title override. If specified will override default title if applicable.
  • escContext - A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
  • escRawContent - The Raw JSON formatted string to be used as the payload. This value overrides the message.
  • escBodyOverride - Body override. If specified will override default body.

escSubstitutions :: Lens' EndpointSendConfiguration (HashMap Text [Text]) #

A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.

escTitleOverride :: Lens' EndpointSendConfiguration (Maybe Text) #

Title override. If specified will override default title if applicable.

escContext :: Lens' EndpointSendConfiguration (HashMap Text Text) #

A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.

escRawContent :: Lens' EndpointSendConfiguration (Maybe Text) #

The Raw JSON formatted string to be used as the payload. This value overrides the message.

escBodyOverride :: Lens' EndpointSendConfiguration (Maybe Text) #

Body override. If specified will override default body.

EndpointUser

data EndpointUser #

Endpoint user specific custom userAttributes

See: endpointUser smart constructor.

Instances

Eq EndpointUser # 
Data EndpointUser # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EndpointUser -> c EndpointUser #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EndpointUser #

toConstr :: EndpointUser -> Constr #

dataTypeOf :: EndpointUser -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EndpointUser) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EndpointUser) #

gmapT :: (forall b. Data b => b -> b) -> EndpointUser -> EndpointUser #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EndpointUser -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EndpointUser -> r #

gmapQ :: (forall d. Data d => d -> u) -> EndpointUser -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EndpointUser -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EndpointUser -> m EndpointUser #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointUser -> m EndpointUser #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointUser -> m EndpointUser #

Read EndpointUser # 
Show EndpointUser # 
Generic EndpointUser # 

Associated Types

type Rep EndpointUser :: * -> * #

Hashable EndpointUser # 
ToJSON EndpointUser # 
FromJSON EndpointUser # 
NFData EndpointUser # 

Methods

rnf :: EndpointUser -> () #

type Rep EndpointUser # 
type Rep EndpointUser = D1 * (MetaData "EndpointUser" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "EndpointUser'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_euUserAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text [Text])))) (S1 * (MetaSel (Just Symbol "_euUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))

endpointUser :: EndpointUser #

Creates a value of EndpointUser with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • euUserAttributes - Custom attributes that describe an end user by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
  • euUserId - The unique ID of the user.

euUserAttributes :: Lens' EndpointUser (HashMap Text [Text]) #

Custom attributes that describe an end user by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.

euUserId :: Lens' EndpointUser (Maybe Text) #

The unique ID of the user.

EventStream

data EventStream #

Model for an event publishing subscription export.

See: eventStream smart constructor.

Instances

Eq EventStream # 
Data EventStream # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EventStream -> c EventStream #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EventStream #

toConstr :: EventStream -> Constr #

dataTypeOf :: EventStream -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EventStream) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EventStream) #

gmapT :: (forall b. Data b => b -> b) -> EventStream -> EventStream #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EventStream -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EventStream -> r #

gmapQ :: (forall d. Data d => d -> u) -> EventStream -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EventStream -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EventStream -> m EventStream #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EventStream -> m EventStream #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EventStream -> m EventStream #

Read EventStream # 
Show EventStream # 
Generic EventStream # 

Associated Types

type Rep EventStream :: * -> * #

Hashable EventStream # 
FromJSON EventStream # 
NFData EventStream # 

Methods

rnf :: EventStream -> () #

type Rep EventStream # 
type Rep EventStream = D1 * (MetaData "EventStream" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "EventStream'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_esLastUpdatedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_esLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_esDestinationStreamARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_esApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_esExternalId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_esRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))

eventStream :: EventStream #

Creates a value of EventStream with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • esLastUpdatedBy - The IAM user who last modified the event stream.
  • esLastModifiedDate - The date the event stream was last updated in ISO 8601 format.
  • esDestinationStreamARN - The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystreamSTREAM_NAME Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:streamSTREAM_NAME
  • esApplicationId - The ID of the application from which events should be published.
  • esExternalId - DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
  • esRoleARN - The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

esLastUpdatedBy :: Lens' EventStream (Maybe Text) #

The IAM user who last modified the event stream.

esLastModifiedDate :: Lens' EventStream (Maybe Text) #

The date the event stream was last updated in ISO 8601 format.

esDestinationStreamARN :: Lens' EventStream (Maybe Text) #

The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystreamSTREAM_NAME Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:streamSTREAM_NAME

esApplicationId :: Lens' EventStream (Maybe Text) #

The ID of the application from which events should be published.

esExternalId :: Lens' EventStream (Maybe Text) #

DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

esRoleARN :: Lens' EventStream (Maybe Text) #

The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

ExportJobRequest

data ExportJobRequest #

See: exportJobRequest smart constructor.

Instances

Eq ExportJobRequest # 
Data ExportJobRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExportJobRequest -> c ExportJobRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExportJobRequest #

toConstr :: ExportJobRequest -> Constr #

dataTypeOf :: ExportJobRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ExportJobRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExportJobRequest) #

gmapT :: (forall b. Data b => b -> b) -> ExportJobRequest -> ExportJobRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExportJobRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExportJobRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> ExportJobRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExportJobRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExportJobRequest -> m ExportJobRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExportJobRequest -> m ExportJobRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExportJobRequest -> m ExportJobRequest #

Read ExportJobRequest # 
Show ExportJobRequest # 
Generic ExportJobRequest # 
Hashable ExportJobRequest # 
ToJSON ExportJobRequest # 
NFData ExportJobRequest # 

Methods

rnf :: ExportJobRequest -> () #

type Rep ExportJobRequest # 
type Rep ExportJobRequest = D1 * (MetaData "ExportJobRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "ExportJobRequest'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_eS3URLPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_eSegmentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_eRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))

exportJobRequest :: ExportJobRequest #

Creates a value of ExportJobRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • eS3URLPrefix - A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3:/bucket-namefolder-name/ Amazon Pinpoint will export endpoints to this location.
  • eSegmentId - The ID of the segment to export endpoints from. If not present all endpoints will be exported.
  • eRoleARN - The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.

eS3URLPrefix :: Lens' ExportJobRequest (Maybe Text) #

A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3:/bucket-namefolder-name/ Amazon Pinpoint will export endpoints to this location.

eSegmentId :: Lens' ExportJobRequest (Maybe Text) #

The ID of the segment to export endpoints from. If not present all endpoints will be exported.

eRoleARN :: Lens' ExportJobRequest (Maybe Text) #

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.

ExportJobResource

data ExportJobResource #

See: exportJobResource smart constructor.

Instances

Eq ExportJobResource # 
Data ExportJobResource # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExportJobResource -> c ExportJobResource #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExportJobResource #

toConstr :: ExportJobResource -> Constr #

dataTypeOf :: ExportJobResource -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ExportJobResource) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExportJobResource) #

gmapT :: (forall b. Data b => b -> b) -> ExportJobResource -> ExportJobResource #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExportJobResource -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExportJobResource -> r #

gmapQ :: (forall d. Data d => d -> u) -> ExportJobResource -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExportJobResource -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExportJobResource -> m ExportJobResource #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExportJobResource -> m ExportJobResource #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExportJobResource -> m ExportJobResource #

Read ExportJobResource # 
Show ExportJobResource # 
Generic ExportJobResource # 
Hashable ExportJobResource # 
FromJSON ExportJobResource # 
NFData ExportJobResource # 

Methods

rnf :: ExportJobResource -> () #

type Rep ExportJobResource # 
type Rep ExportJobResource = D1 * (MetaData "ExportJobResource" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "ExportJobResource'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ejrS3URLPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ejrSegmentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ejrRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))

exportJobResource :: ExportJobResource #

Creates a value of ExportJobResource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ejrS3URLPrefix - A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3:/bucket-namefolder-name/ Amazon Pinpoint will export endpoints to this location.
  • ejrSegmentId - The ID of the segment to export endpoints from. If not present, all endpoints are exported.
  • ejrRoleARN - The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.

ejrS3URLPrefix :: Lens' ExportJobResource (Maybe Text) #

A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3:/bucket-namefolder-name/ Amazon Pinpoint will export endpoints to this location.

ejrSegmentId :: Lens' ExportJobResource (Maybe Text) #

The ID of the segment to export endpoints from. If not present, all endpoints are exported.

ejrRoleARN :: Lens' ExportJobResource (Maybe Text) #

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.

ExportJobResponse

data ExportJobResponse #

See: exportJobResponse smart constructor.

Instances

Eq ExportJobResponse # 
Data ExportJobResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExportJobResponse -> c ExportJobResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExportJobResponse #

toConstr :: ExportJobResponse -> Constr #

dataTypeOf :: ExportJobResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ExportJobResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExportJobResponse) #

gmapT :: (forall b. Data b => b -> b) -> ExportJobResponse -> ExportJobResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExportJobResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExportJobResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ExportJobResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExportJobResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExportJobResponse -> m ExportJobResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExportJobResponse -> m ExportJobResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExportJobResponse -> m ExportJobResponse #

Read ExportJobResponse # 
Show ExportJobResponse # 
Generic ExportJobResponse # 
Hashable ExportJobResponse # 
FromJSON ExportJobResponse # 
NFData ExportJobResponse # 

Methods

rnf :: ExportJobResponse -> () #

type Rep ExportJobResponse # 
type Rep ExportJobResponse = D1 * (MetaData "ExportJobResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "ExportJobResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ejCompletedPieces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ejFailedPieces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_ejDefinition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ExportJobResource))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ejTotalProcessed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ejFailures") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_ejTotalPieces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ejApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ejId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ejCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ejType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ejCompletionDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ejJobStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe JobStatus))) (S1 * (MetaSel (Just Symbol "_ejTotalFailures") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))))))))

exportJobResponse :: ExportJobResponse #

Creates a value of ExportJobResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ejCompletedPieces - The number of pieces that have successfully completed as of the time of the request.
  • ejFailedPieces - The number of pieces that failed to be processed as of the time of the request.
  • ejDefinition - The export job settings.
  • ejTotalProcessed - The number of endpoints that were processed by the job.
  • ejFailures - Provides up to 100 of the first failed entries for the job, if any exist.
  • ejTotalPieces - The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.
  • ejApplicationId - The unique ID of the application to which the job applies.
  • ejId - The unique ID of the job.
  • ejCreationDate - The date the job was created in ISO 8601 format.
  • ejType - The job type. Will be EXPORT.
  • ejCompletionDate - The date the job completed in ISO 8601 format.
  • ejJobStatus - The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.
  • ejTotalFailures - The number of endpoints that were not processed; for example, because of syntax errors.

ejCompletedPieces :: Lens' ExportJobResponse (Maybe Int) #

The number of pieces that have successfully completed as of the time of the request.

ejFailedPieces :: Lens' ExportJobResponse (Maybe Int) #

The number of pieces that failed to be processed as of the time of the request.

ejTotalProcessed :: Lens' ExportJobResponse (Maybe Int) #

The number of endpoints that were processed by the job.

ejFailures :: Lens' ExportJobResponse [Text] #

Provides up to 100 of the first failed entries for the job, if any exist.

ejTotalPieces :: Lens' ExportJobResponse (Maybe Int) #

The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.

ejApplicationId :: Lens' ExportJobResponse (Maybe Text) #

The unique ID of the application to which the job applies.

ejId :: Lens' ExportJobResponse (Maybe Text) #

The unique ID of the job.

ejCreationDate :: Lens' ExportJobResponse (Maybe Text) #

The date the job was created in ISO 8601 format.

ejType :: Lens' ExportJobResponse (Maybe Text) #

The job type. Will be EXPORT.

ejCompletionDate :: Lens' ExportJobResponse (Maybe Text) #

The date the job completed in ISO 8601 format.

ejJobStatus :: Lens' ExportJobResponse (Maybe JobStatus) #

The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.

ejTotalFailures :: Lens' ExportJobResponse (Maybe Int) #

The number of endpoints that were not processed; for example, because of syntax errors.

ExportJobsResponse

data ExportJobsResponse #

Export job list.

See: exportJobsResponse smart constructor.

Instances

Eq ExportJobsResponse # 
Data ExportJobsResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExportJobsResponse -> c ExportJobsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExportJobsResponse #

toConstr :: ExportJobsResponse -> Constr #

dataTypeOf :: ExportJobsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ExportJobsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExportJobsResponse) #

gmapT :: (forall b. Data b => b -> b) -> ExportJobsResponse -> ExportJobsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExportJobsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExportJobsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ExportJobsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExportJobsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExportJobsResponse -> m ExportJobsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExportJobsResponse -> m ExportJobsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExportJobsResponse -> m ExportJobsResponse #

Read ExportJobsResponse # 
Show ExportJobsResponse # 
Generic ExportJobsResponse # 
Hashable ExportJobsResponse # 
FromJSON ExportJobsResponse # 
NFData ExportJobsResponse # 

Methods

rnf :: ExportJobsResponse -> () #

type Rep ExportJobsResponse # 
type Rep ExportJobsResponse = D1 * (MetaData "ExportJobsResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "ExportJobsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ejNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ejItem") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ExportJobResponse])))))

exportJobsResponse :: ExportJobsResponse #

Creates a value of ExportJobsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ejNextToken - The string that you use in a subsequent request to get the next page of results in a paginated response.
  • ejItem - A list of export jobs for the application.

ejNextToken :: Lens' ExportJobsResponse (Maybe Text) #

The string that you use in a subsequent request to get the next page of results in a paginated response.

ejItem :: Lens' ExportJobsResponse [ExportJobResponse] #

A list of export jobs for the application.

GCMChannelRequest

data GCMChannelRequest #

Google Cloud Messaging credentials

See: gcmChannelRequest smart constructor.

Instances

Eq GCMChannelRequest # 
Data GCMChannelRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GCMChannelRequest -> c GCMChannelRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GCMChannelRequest #

toConstr :: GCMChannelRequest -> Constr #

dataTypeOf :: GCMChannelRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GCMChannelRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GCMChannelRequest) #

gmapT :: (forall b. Data b => b -> b) -> GCMChannelRequest -> GCMChannelRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GCMChannelRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GCMChannelRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> GCMChannelRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GCMChannelRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GCMChannelRequest -> m GCMChannelRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GCMChannelRequest -> m GCMChannelRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GCMChannelRequest -> m GCMChannelRequest #

Read GCMChannelRequest # 
Show GCMChannelRequest # 
Generic GCMChannelRequest # 
Hashable GCMChannelRequest # 
ToJSON GCMChannelRequest # 
NFData GCMChannelRequest # 

Methods

rnf :: GCMChannelRequest -> () #

type Rep GCMChannelRequest # 
type Rep GCMChannelRequest = D1 * (MetaData "GCMChannelRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "GCMChannelRequest'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gcrAPIKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gcrEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))))

gcmChannelRequest :: GCMChannelRequest #

Creates a value of GCMChannelRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • gcrAPIKey - Platform credential API key from Google.
  • gcrEnabled - If the channel is enabled for sending messages.

gcrAPIKey :: Lens' GCMChannelRequest (Maybe Text) #

Platform credential API key from Google.

gcrEnabled :: Lens' GCMChannelRequest (Maybe Bool) #

If the channel is enabled for sending messages.

GCMChannelResponse

data GCMChannelResponse #

Google Cloud Messaging channel definition

See: gcmChannelResponse smart constructor.

Instances

Eq GCMChannelResponse # 
Data GCMChannelResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GCMChannelResponse -> c GCMChannelResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GCMChannelResponse #

toConstr :: GCMChannelResponse -> Constr #

dataTypeOf :: GCMChannelResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GCMChannelResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GCMChannelResponse) #

gmapT :: (forall b. Data b => b -> b) -> GCMChannelResponse -> GCMChannelResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GCMChannelResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GCMChannelResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> GCMChannelResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GCMChannelResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GCMChannelResponse -> m GCMChannelResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GCMChannelResponse -> m GCMChannelResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GCMChannelResponse -> m GCMChannelResponse #

Read GCMChannelResponse # 
Show GCMChannelResponse # 
Generic GCMChannelResponse # 
Hashable GCMChannelResponse # 
FromJSON GCMChannelResponse # 
NFData GCMChannelResponse # 

Methods

rnf :: GCMChannelResponse -> () #

type Rep GCMChannelResponse # 
type Rep GCMChannelResponse = D1 * (MetaData "GCMChannelResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "GCMChannelResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gcPlatform") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gcLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gcEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gcCredential") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gcIsArchived") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gcApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gcVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_gcId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gcCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gcLastModifiedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gcHasCredential") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))))))

gcmChannelResponse :: GCMChannelResponse #

Creates a value of GCMChannelResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • gcPlatform - The platform type. Will be GCM
  • gcLastModifiedDate - Last date this was updated
  • gcEnabled - If the channel is enabled for sending messages.
  • gcCredential - The GCM API key from Google.
  • gcIsArchived - Is this channel archived
  • gcApplicationId - The ID of the application to which the channel applies.
  • gcVersion - Version of channel
  • gcId - Channel ID. Not used. Present only for backwards compatibility.
  • gcCreationDate - When was this segment created
  • gcLastModifiedBy - Who last updated this entry
  • gcHasCredential - Indicates whether the channel is configured with FCM or GCM credentials. Amazon Pinpoint uses your credentials to authenticate push notifications with FCM or GCM. Provide your credentials by setting the ApiKey attribute.

gcPlatform :: Lens' GCMChannelResponse (Maybe Text) #

The platform type. Will be GCM

gcLastModifiedDate :: Lens' GCMChannelResponse (Maybe Text) #

Last date this was updated

gcEnabled :: Lens' GCMChannelResponse (Maybe Bool) #

If the channel is enabled for sending messages.

gcCredential :: Lens' GCMChannelResponse (Maybe Text) #

The GCM API key from Google.

gcIsArchived :: Lens' GCMChannelResponse (Maybe Bool) #

Is this channel archived

gcApplicationId :: Lens' GCMChannelResponse (Maybe Text) #

The ID of the application to which the channel applies.

gcVersion :: Lens' GCMChannelResponse (Maybe Int) #

Version of channel

gcId :: Lens' GCMChannelResponse (Maybe Text) #

Channel ID. Not used. Present only for backwards compatibility.

gcCreationDate :: Lens' GCMChannelResponse (Maybe Text) #

When was this segment created

gcLastModifiedBy :: Lens' GCMChannelResponse (Maybe Text) #

Who last updated this entry

gcHasCredential :: Lens' GCMChannelResponse (Maybe Bool) #

Indicates whether the channel is configured with FCM or GCM credentials. Amazon Pinpoint uses your credentials to authenticate push notifications with FCM or GCM. Provide your credentials by setting the ApiKey attribute.

GCMMessage

data GCMMessage #

GCM Message.

See: gcmMessage smart constructor.

Instances

Eq GCMMessage # 
Data GCMMessage # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GCMMessage -> c GCMMessage #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GCMMessage #

toConstr :: GCMMessage -> Constr #

dataTypeOf :: GCMMessage -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GCMMessage) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GCMMessage) #

gmapT :: (forall b. Data b => b -> b) -> GCMMessage -> GCMMessage #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GCMMessage -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GCMMessage -> r #

gmapQ :: (forall d. Data d => d -> u) -> GCMMessage -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GCMMessage -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GCMMessage -> m GCMMessage #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GCMMessage -> m GCMMessage #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GCMMessage -> m GCMMessage #

Read GCMMessage # 
Show GCMMessage # 
Generic GCMMessage # 

Associated Types

type Rep GCMMessage :: * -> * #

Hashable GCMMessage # 
ToJSON GCMMessage # 
NFData GCMMessage # 

Methods

rnf :: GCMMessage -> () #

type Rep GCMMessage # 
type Rep GCMMessage = D1 * (MetaData "GCMMessage" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "GCMMessage'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gmSubstitutions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text [Text])))) (S1 * (MetaSel (Just Symbol "_gmSilentPush") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gmImageIconURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gmPriority") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gmRawContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gmData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gmRestrictedPackageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gmSmallImageIconURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gmBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gmTimeToLive") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gmURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gmSound") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gmAction") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Action))) (S1 * (MetaSel (Just Symbol "_gmCollapseKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gmImageURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gmTitle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gmIconReference") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))))

gcmMessage :: GCMMessage #

Creates a value of GCMMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • gmSubstitutions - Default message substitutions. Can be overridden by individual address substitutions.
  • gmSilentPush - Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  • gmImageIconURL - The URL that points to an image used as the large icon to the notification content view.
  • gmPriority - The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values: Normal - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required. High - Messages are sent immediately and might wake a sleeping device. The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them. For more information, see About FCM Messages in the Firebase documentation.
  • gmRawContent - The Raw JSON formatted string to be used as the payload. This value overrides the message.
  • gmData - The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
  • gmRestrictedPackageName - This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
  • gmSmallImageIconURL - The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
  • gmBody - The message body of the notification, the email body or the text message.
  • gmTimeToLive - The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.
  • gmURL - The URL to open in the user's mobile browser. Used if the value for Action is URL.
  • gmSound - Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in resraw/
  • gmAction - The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
  • gmCollapseKey - This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.
  • gmImageURL - The URL that points to an image used in the push notification.
  • gmTitle - The message title that displays above the message on the user's device.
  • gmIconReference - The icon image name of the asset saved in your application.

gmSubstitutions :: Lens' GCMMessage (HashMap Text [Text]) #

Default message substitutions. Can be overridden by individual address substitutions.

gmSilentPush :: Lens' GCMMessage (Maybe Bool) #

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

gmImageIconURL :: Lens' GCMMessage (Maybe Text) #

The URL that points to an image used as the large icon to the notification content view.

gmPriority :: Lens' GCMMessage (Maybe Text) #

The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values: Normal - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required. High - Messages are sent immediately and might wake a sleeping device. The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them. For more information, see About FCM Messages in the Firebase documentation.

gmRawContent :: Lens' GCMMessage (Maybe Text) #

The Raw JSON formatted string to be used as the payload. This value overrides the message.

gmData :: Lens' GCMMessage (HashMap Text Text) #

The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

gmRestrictedPackageName :: Lens' GCMMessage (Maybe Text) #

This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.

gmSmallImageIconURL :: Lens' GCMMessage (Maybe Text) #

The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view

gmBody :: Lens' GCMMessage (Maybe Text) #

The message body of the notification, the email body or the text message.

gmTimeToLive :: Lens' GCMMessage (Maybe Int) #

The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.

gmURL :: Lens' GCMMessage (Maybe Text) #

The URL to open in the user's mobile browser. Used if the value for Action is URL.

gmSound :: Lens' GCMMessage (Maybe Text) #

Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in resraw/

gmAction :: Lens' GCMMessage (Maybe Action) #

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

gmCollapseKey :: Lens' GCMMessage (Maybe Text) #

This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.

gmImageURL :: Lens' GCMMessage (Maybe Text) #

The URL that points to an image used in the push notification.

gmTitle :: Lens' GCMMessage (Maybe Text) #

The message title that displays above the message on the user's device.

gmIconReference :: Lens' GCMMessage (Maybe Text) #

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

ImportJobRequest

data ImportJobRequest #

See: importJobRequest smart constructor.

Instances

Eq ImportJobRequest # 
Data ImportJobRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ImportJobRequest -> c ImportJobRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ImportJobRequest #

toConstr :: ImportJobRequest -> Constr #

dataTypeOf :: ImportJobRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ImportJobRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ImportJobRequest) #

gmapT :: (forall b. Data b => b -> b) -> ImportJobRequest -> ImportJobRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ImportJobRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ImportJobRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> ImportJobRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ImportJobRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ImportJobRequest -> m ImportJobRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ImportJobRequest -> m ImportJobRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ImportJobRequest -> m ImportJobRequest #

Read ImportJobRequest # 
Show ImportJobRequest # 
Generic ImportJobRequest # 
Hashable ImportJobRequest # 
ToJSON ImportJobRequest # 
NFData ImportJobRequest # 

Methods

rnf :: ImportJobRequest -> () #

type Rep ImportJobRequest # 

importJobRequest :: ImportJobRequest #

Creates a value of ImportJobRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • iSegmentName - A custom name for the segment created by the import job. Use if DefineSegment is true.
  • iFormat - The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
  • iDefineSegment - Sets whether the endpoints create a segment when they are imported.
  • iRegisterEndpoints - Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
  • iExternalId - DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
  • iS3URL - A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file. The URL should follow this format: s3:/bucket-namefolder-name/file-name Amazon Pinpoint will import endpoints from this location and any subfolders it contains.
  • iSegmentId - The ID of the segment to update if the import job is meant to update an existing segment.
  • iRoleARN - The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.

iSegmentName :: Lens' ImportJobRequest (Maybe Text) #

A custom name for the segment created by the import job. Use if DefineSegment is true.

iFormat :: Lens' ImportJobRequest (Maybe DefinitionFormat) #

The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

iDefineSegment :: Lens' ImportJobRequest (Maybe Bool) #

Sets whether the endpoints create a segment when they are imported.

iRegisterEndpoints :: Lens' ImportJobRequest (Maybe Bool) #

Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.

iExternalId :: Lens' ImportJobRequest (Maybe Text) #

DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

iS3URL :: Lens' ImportJobRequest (Maybe Text) #

A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file. The URL should follow this format: s3:/bucket-namefolder-name/file-name Amazon Pinpoint will import endpoints from this location and any subfolders it contains.

iSegmentId :: Lens' ImportJobRequest (Maybe Text) #

The ID of the segment to update if the import job is meant to update an existing segment.

iRoleARN :: Lens' ImportJobRequest (Maybe Text) #

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.

ImportJobResource

data ImportJobResource #

See: importJobResource smart constructor.

Instances

Eq ImportJobResource # 
Data ImportJobResource # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ImportJobResource -> c ImportJobResource #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ImportJobResource #

toConstr :: ImportJobResource -> Constr #

dataTypeOf :: ImportJobResource -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ImportJobResource) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ImportJobResource) #

gmapT :: (forall b. Data b => b -> b) -> ImportJobResource -> ImportJobResource #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ImportJobResource -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ImportJobResource -> r #

gmapQ :: (forall d. Data d => d -> u) -> ImportJobResource -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ImportJobResource -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ImportJobResource -> m ImportJobResource #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ImportJobResource -> m ImportJobResource #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ImportJobResource -> m ImportJobResource #

Read ImportJobResource # 
Show ImportJobResource # 
Generic ImportJobResource # 
Hashable ImportJobResource # 
FromJSON ImportJobResource # 
NFData ImportJobResource # 

Methods

rnf :: ImportJobResource -> () #

type Rep ImportJobResource # 

importJobResource :: ImportJobResource #

Creates a value of ImportJobResource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ijrSegmentName - A custom name for the segment created by the import job. Use if DefineSegment is true.
  • ijrFormat - The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
  • ijrDefineSegment - Sets whether the endpoints create a segment when they are imported.
  • ijrRegisterEndpoints - Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
  • ijrExternalId - DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
  • ijrS3URL - A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file. The URL should follow this format: s3:/bucket-namefolder-name/file-name Amazon Pinpoint will import endpoints from this location and any subfolders it contains.
  • ijrSegmentId - The ID of the segment to update if the import job is meant to update an existing segment.
  • ijrRoleARN - The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.

ijrSegmentName :: Lens' ImportJobResource (Maybe Text) #

A custom name for the segment created by the import job. Use if DefineSegment is true.

ijrFormat :: Lens' ImportJobResource (Maybe DefinitionFormat) #

The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

ijrDefineSegment :: Lens' ImportJobResource (Maybe Bool) #

Sets whether the endpoints create a segment when they are imported.

ijrRegisterEndpoints :: Lens' ImportJobResource (Maybe Bool) #

Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.

ijrExternalId :: Lens' ImportJobResource (Maybe Text) #

DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

ijrS3URL :: Lens' ImportJobResource (Maybe Text) #

A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file. The URL should follow this format: s3:/bucket-namefolder-name/file-name Amazon Pinpoint will import endpoints from this location and any subfolders it contains.

ijrSegmentId :: Lens' ImportJobResource (Maybe Text) #

The ID of the segment to update if the import job is meant to update an existing segment.

ijrRoleARN :: Lens' ImportJobResource (Maybe Text) #

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.

ImportJobResponse

data ImportJobResponse #

See: importJobResponse smart constructor.

Instances

Eq ImportJobResponse # 
Data ImportJobResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ImportJobResponse -> c ImportJobResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ImportJobResponse #

toConstr :: ImportJobResponse -> Constr #

dataTypeOf :: ImportJobResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ImportJobResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ImportJobResponse) #

gmapT :: (forall b. Data b => b -> b) -> ImportJobResponse -> ImportJobResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ImportJobResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ImportJobResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ImportJobResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ImportJobResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ImportJobResponse -> m ImportJobResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ImportJobResponse -> m ImportJobResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ImportJobResponse -> m ImportJobResponse #

Read ImportJobResponse # 
Show ImportJobResponse # 
Generic ImportJobResponse # 
Hashable ImportJobResponse # 
FromJSON ImportJobResponse # 
NFData ImportJobResponse # 

Methods

rnf :: ImportJobResponse -> () #

type Rep ImportJobResponse # 
type Rep ImportJobResponse = D1 * (MetaData "ImportJobResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "ImportJobResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ijCompletedPieces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ijFailedPieces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_ijDefinition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ImportJobResource))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ijTotalProcessed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ijFailures") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_ijTotalPieces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ijApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ijId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ijCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ijType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ijCompletionDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ijJobStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe JobStatus))) (S1 * (MetaSel (Just Symbol "_ijTotalFailures") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))))))))

importJobResponse :: ImportJobResponse #

Creates a value of ImportJobResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ijCompletedPieces - The number of pieces that have successfully imported as of the time of the request.
  • ijFailedPieces - The number of pieces that have failed to import as of the time of the request.
  • ijDefinition - The import job settings.
  • ijTotalProcessed - The number of endpoints that were processed by the import job.
  • ijFailures - Provides up to 100 of the first failed entries for the job, if any exist.
  • ijTotalPieces - The total number of pieces that must be imported to finish the job. Each piece is an approximately equal portion of the endpoints to import.
  • ijApplicationId - The unique ID of the application to which the import job applies.
  • ijId - The unique ID of the import job.
  • ijCreationDate - The date the import job was created in ISO 8601 format.
  • ijType - The job type. Will be Import.
  • ijCompletionDate - The date the import job completed in ISO 8601 format.
  • ijJobStatus - The status of the import job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed to import.
  • ijTotalFailures - The number of endpoints that failed to import; for example, because of syntax errors.

ijCompletedPieces :: Lens' ImportJobResponse (Maybe Int) #

The number of pieces that have successfully imported as of the time of the request.

ijFailedPieces :: Lens' ImportJobResponse (Maybe Int) #

The number of pieces that have failed to import as of the time of the request.

ijTotalProcessed :: Lens' ImportJobResponse (Maybe Int) #

The number of endpoints that were processed by the import job.

ijFailures :: Lens' ImportJobResponse [Text] #

Provides up to 100 of the first failed entries for the job, if any exist.

ijTotalPieces :: Lens' ImportJobResponse (Maybe Int) #

The total number of pieces that must be imported to finish the job. Each piece is an approximately equal portion of the endpoints to import.

ijApplicationId :: Lens' ImportJobResponse (Maybe Text) #

The unique ID of the application to which the import job applies.

ijId :: Lens' ImportJobResponse (Maybe Text) #

The unique ID of the import job.

ijCreationDate :: Lens' ImportJobResponse (Maybe Text) #

The date the import job was created in ISO 8601 format.

ijType :: Lens' ImportJobResponse (Maybe Text) #

The job type. Will be Import.

ijCompletionDate :: Lens' ImportJobResponse (Maybe Text) #

The date the import job completed in ISO 8601 format.

ijJobStatus :: Lens' ImportJobResponse (Maybe JobStatus) #

The status of the import job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed to import.

ijTotalFailures :: Lens' ImportJobResponse (Maybe Int) #

The number of endpoints that failed to import; for example, because of syntax errors.

ImportJobsResponse

data ImportJobsResponse #

Import job list.

See: importJobsResponse smart constructor.

Instances

Eq ImportJobsResponse # 
Data ImportJobsResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ImportJobsResponse -> c ImportJobsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ImportJobsResponse #

toConstr :: ImportJobsResponse -> Constr #

dataTypeOf :: ImportJobsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ImportJobsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ImportJobsResponse) #

gmapT :: (forall b. Data b => b -> b) -> ImportJobsResponse -> ImportJobsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ImportJobsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ImportJobsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ImportJobsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ImportJobsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ImportJobsResponse -> m ImportJobsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ImportJobsResponse -> m ImportJobsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ImportJobsResponse -> m ImportJobsResponse #

Read ImportJobsResponse # 
Show ImportJobsResponse # 
Generic ImportJobsResponse # 
Hashable ImportJobsResponse # 
FromJSON ImportJobsResponse # 
NFData ImportJobsResponse # 

Methods

rnf :: ImportJobsResponse -> () #

type Rep ImportJobsResponse # 
type Rep ImportJobsResponse = D1 * (MetaData "ImportJobsResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "ImportJobsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ijNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ijItem") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ImportJobResponse])))))

importJobsResponse :: ImportJobsResponse #

Creates a value of ImportJobsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ijNextToken - The string that you use in a subsequent request to get the next page of results in a paginated response.
  • ijItem - A list of import jobs for the application.

ijNextToken :: Lens' ImportJobsResponse (Maybe Text) #

The string that you use in a subsequent request to get the next page of results in a paginated response.

ijItem :: Lens' ImportJobsResponse [ImportJobResponse] #

A list of import jobs for the application.

Message

data Message #

See: message smart constructor.

Instances

Eq Message # 

Methods

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

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

Data Message # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Message -> c Message #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Message #

toConstr :: Message -> Constr #

dataTypeOf :: Message -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Message) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Message) #

gmapT :: (forall b. Data b => b -> b) -> Message -> Message #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Message -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Message -> r #

gmapQ :: (forall d. Data d => d -> u) -> Message -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Message -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Message -> m Message #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Message -> m Message #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Message -> m Message #

Read Message # 
Show Message # 
Generic Message # 

Associated Types

type Rep Message :: * -> * #

Methods

from :: Message -> Rep Message x #

to :: Rep Message x -> Message #

Hashable Message # 

Methods

hashWithSalt :: Int -> Message -> Int #

hash :: Message -> Int #

ToJSON Message # 
FromJSON Message # 
NFData Message # 

Methods

rnf :: Message -> () #

type Rep Message # 
type Rep Message = D1 * (MetaData "Message" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "Message'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_mSilentPush") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_mImageIconURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mRawContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_mImageSmallIconURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_mJSONBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_mAction") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Action))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mImageURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mMediaURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_mTitle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))))

message :: Message #

Creates a value of Message with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • mSilentPush - Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  • mImageIconURL - The URL that points to the icon image for the push notification icon, for example, the app icon.
  • mRawContent - The Raw JSON formatted string to be used as the payload. This value overrides the message.
  • mBody - The message body. Can include up to 140 characters.
  • mImageSmallIconURL - The URL that points to the small icon image for the push notification icon, for example, the app icon.
  • mJSONBody - The JSON payload used for a silent push.
  • mURL - The URL to open in the user's mobile browser. Used if the value for Action is URL.
  • mAction - The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
  • mImageURL - The URL that points to an image used in the push notification.
  • mMediaURL - The URL that points to the media resource, for example a .mp4 or .gif file.
  • mTitle - The message title that displays above the message on the user's device.

mSilentPush :: Lens' Message (Maybe Bool) #

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

mImageIconURL :: Lens' Message (Maybe Text) #

The URL that points to the icon image for the push notification icon, for example, the app icon.

mRawContent :: Lens' Message (Maybe Text) #

The Raw JSON formatted string to be used as the payload. This value overrides the message.

mBody :: Lens' Message (Maybe Text) #

The message body. Can include up to 140 characters.

mImageSmallIconURL :: Lens' Message (Maybe Text) #

The URL that points to the small icon image for the push notification icon, for example, the app icon.

mJSONBody :: Lens' Message (Maybe Text) #

The JSON payload used for a silent push.

mURL :: Lens' Message (Maybe Text) #

The URL to open in the user's mobile browser. Used if the value for Action is URL.

mAction :: Lens' Message (Maybe Action) #

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.

mImageURL :: Lens' Message (Maybe Text) #

The URL that points to an image used in the push notification.

mMediaURL :: Lens' Message (Maybe Text) #

The URL that points to the media resource, for example a .mp4 or .gif file.

mTitle :: Lens' Message (Maybe Text) #

The message title that displays above the message on the user's device.

MessageBody

data MessageBody #

Simple message object.

See: messageBody smart constructor.

Instances

Eq MessageBody # 
Data MessageBody # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MessageBody -> c MessageBody #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MessageBody #

toConstr :: MessageBody -> Constr #

dataTypeOf :: MessageBody -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c MessageBody) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MessageBody) #

gmapT :: (forall b. Data b => b -> b) -> MessageBody -> MessageBody #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MessageBody -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MessageBody -> r #

gmapQ :: (forall d. Data d => d -> u) -> MessageBody -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> MessageBody -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MessageBody -> m MessageBody #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MessageBody -> m MessageBody #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MessageBody -> m MessageBody #

Read MessageBody # 
Show MessageBody # 
Generic MessageBody # 

Associated Types

type Rep MessageBody :: * -> * #

Hashable MessageBody # 
FromJSON MessageBody # 
NFData MessageBody # 

Methods

rnf :: MessageBody -> () #

type Rep MessageBody # 
type Rep MessageBody = D1 * (MetaData "MessageBody" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "MessageBody'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_mbRequestId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_mbMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))

messageBody :: MessageBody #

Creates a value of MessageBody with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

mbRequestId :: Lens' MessageBody (Maybe Text) #

The unique message body ID.

mbMessage :: Lens' MessageBody (Maybe Text) #

The error message returned from the API.

MessageConfiguration

data MessageConfiguration #

Message configuration for a campaign.

See: messageConfiguration smart constructor.

Instances

Eq MessageConfiguration # 
Data MessageConfiguration # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MessageConfiguration -> c MessageConfiguration #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MessageConfiguration #

toConstr :: MessageConfiguration -> Constr #

dataTypeOf :: MessageConfiguration -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c MessageConfiguration) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MessageConfiguration) #

gmapT :: (forall b. Data b => b -> b) -> MessageConfiguration -> MessageConfiguration #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MessageConfiguration -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MessageConfiguration -> r #

gmapQ :: (forall d. Data d => d -> u) -> MessageConfiguration -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> MessageConfiguration -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MessageConfiguration -> m MessageConfiguration #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MessageConfiguration -> m MessageConfiguration #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MessageConfiguration -> m MessageConfiguration #

Read MessageConfiguration # 
Show MessageConfiguration # 
Generic MessageConfiguration # 
Hashable MessageConfiguration # 
ToJSON MessageConfiguration # 
FromJSON MessageConfiguration # 
NFData MessageConfiguration # 

Methods

rnf :: MessageConfiguration -> () #

type Rep MessageConfiguration # 

messageConfiguration :: MessageConfiguration #

Creates a value of MessageConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • mcAPNSMessage - The message that the campaign delivers to APNS channels. Overrides the default message.
  • mcGCMMessage - The message that the campaign delivers to GCM channels. Overrides the default message.
  • mcDefaultMessage - The default message for all channels.
  • mcADMMessage - The message that the campaign delivers to ADM channels. Overrides the default message.
  • mcSMSMessage - The SMS message configuration.
  • mcEmailMessage - The email message configuration.
  • mcBaiduMessage - The message that the campaign delivers to Baidu channels. Overrides the default message.

mcAPNSMessage :: Lens' MessageConfiguration (Maybe Message) #

The message that the campaign delivers to APNS channels. Overrides the default message.

mcGCMMessage :: Lens' MessageConfiguration (Maybe Message) #

The message that the campaign delivers to GCM channels. Overrides the default message.

mcDefaultMessage :: Lens' MessageConfiguration (Maybe Message) #

The default message for all channels.

mcADMMessage :: Lens' MessageConfiguration (Maybe Message) #

The message that the campaign delivers to ADM channels. Overrides the default message.

mcBaiduMessage :: Lens' MessageConfiguration (Maybe Message) #

The message that the campaign delivers to Baidu channels. Overrides the default message.

MessageRequest

data MessageRequest #

Send message request.

See: messageRequest smart constructor.

Instances

Eq MessageRequest # 
Data MessageRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MessageRequest -> c MessageRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MessageRequest #

toConstr :: MessageRequest -> Constr #

dataTypeOf :: MessageRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c MessageRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MessageRequest) #

gmapT :: (forall b. Data b => b -> b) -> MessageRequest -> MessageRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MessageRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MessageRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> MessageRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> MessageRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MessageRequest -> m MessageRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MessageRequest -> m MessageRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MessageRequest -> m MessageRequest #

Read MessageRequest # 
Show MessageRequest # 
Generic MessageRequest # 

Associated Types

type Rep MessageRequest :: * -> * #

Hashable MessageRequest # 
ToJSON MessageRequest # 
NFData MessageRequest # 

Methods

rnf :: MessageRequest -> () #

type Rep MessageRequest # 
type Rep MessageRequest = D1 * (MetaData "MessageRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "MessageRequest'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_mrContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))) (S1 * (MetaSel (Just Symbol "_mrAddresses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text AddressConfiguration))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mrEndpoints") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text EndpointSendConfiguration)))) (S1 * (MetaSel (Just Symbol "_mrMessageConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DirectMessageConfiguration))))))

messageRequest :: MessageRequest #

Creates a value of MessageRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • mrContext - A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
  • mrAddresses - A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
  • mrEndpoints - A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.
  • mrMessageConfiguration - Message configuration.

mrContext :: Lens' MessageRequest (HashMap Text Text) #

A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.

mrAddresses :: Lens' MessageRequest (HashMap Text AddressConfiguration) #

A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.

mrEndpoints :: Lens' MessageRequest (HashMap Text EndpointSendConfiguration) #

A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.

MessageResponse

data MessageResponse #

Send message response.

See: messageResponse smart constructor.

Instances

Eq MessageResponse # 
Data MessageResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MessageResponse -> c MessageResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MessageResponse #

toConstr :: MessageResponse -> Constr #

dataTypeOf :: MessageResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c MessageResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MessageResponse) #

gmapT :: (forall b. Data b => b -> b) -> MessageResponse -> MessageResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MessageResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MessageResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> MessageResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> MessageResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MessageResponse -> m MessageResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MessageResponse -> m MessageResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MessageResponse -> m MessageResponse #

Read MessageResponse # 
Show MessageResponse # 
Generic MessageResponse # 
Hashable MessageResponse # 
FromJSON MessageResponse # 
NFData MessageResponse # 

Methods

rnf :: MessageResponse -> () #

type Rep MessageResponse # 
type Rep MessageResponse = D1 * (MetaData "MessageResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "MessageResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_mRequestId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_mResult") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text MessageResult))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_mEndpointResult") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text EndpointMessageResult)))))))

messageResponse :: MessageResponse #

Creates a value of MessageResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • mRequestId - Original request Id for which this message was delivered.
  • mResult - A map containing a multi part response for each address, with the address as the key(Email address, phone number or push token) and the result as the value.
  • mApplicationId - Application id of the message.
  • mEndpointResult - A map containing a multi part response for each address, with the endpointId as the key and the result as the value.

mRequestId :: Lens' MessageResponse (Maybe Text) #

Original request Id for which this message was delivered.

mResult :: Lens' MessageResponse (HashMap Text MessageResult) #

A map containing a multi part response for each address, with the address as the key(Email address, phone number or push token) and the result as the value.

mApplicationId :: Lens' MessageResponse (Maybe Text) #

Application id of the message.

mEndpointResult :: Lens' MessageResponse (HashMap Text EndpointMessageResult) #

A map containing a multi part response for each address, with the endpointId as the key and the result as the value.

MessageResult

data MessageResult #

The result from sending a message to an address.

See: messageResult smart constructor.

Instances

Eq MessageResult # 
Data MessageResult # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MessageResult -> c MessageResult #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MessageResult #

toConstr :: MessageResult -> Constr #

dataTypeOf :: MessageResult -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c MessageResult) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MessageResult) #

gmapT :: (forall b. Data b => b -> b) -> MessageResult -> MessageResult #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MessageResult -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MessageResult -> r #

gmapQ :: (forall d. Data d => d -> u) -> MessageResult -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> MessageResult -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MessageResult -> m MessageResult #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MessageResult -> m MessageResult #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MessageResult -> m MessageResult #

Read MessageResult # 
Show MessageResult # 
Generic MessageResult # 

Associated Types

type Rep MessageResult :: * -> * #

Hashable MessageResult # 
FromJSON MessageResult # 
NFData MessageResult # 

Methods

rnf :: MessageResult -> () #

type Rep MessageResult # 
type Rep MessageResult = D1 * (MetaData "MessageResult" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "MessageResult'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_mrDeliveryStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DeliveryStatus))) (S1 * (MetaSel (Just Symbol "_mrStatusMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mrUpdatedToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_mrStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))))))

messageResult :: MessageResult #

Creates a value of MessageResult with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

mrDeliveryStatus :: Lens' MessageResult (Maybe DeliveryStatus) #

Delivery status of message.

mrStatusMessage :: Lens' MessageResult (Maybe Text) #

Status message for message delivery.

mrUpdatedToken :: Lens' MessageResult (Maybe Text) #

If token was updated as part of delivery. (This is GCM Specific)

mrStatusCode :: Lens' MessageResult (Maybe Int) #

Downstream service status code.

QuietTime

data QuietTime #

Quiet Time

See: quietTime smart constructor.

Instances

Eq QuietTime # 
Data QuietTime # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> QuietTime -> c QuietTime #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c QuietTime #

toConstr :: QuietTime -> Constr #

dataTypeOf :: QuietTime -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c QuietTime) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c QuietTime) #

gmapT :: (forall b. Data b => b -> b) -> QuietTime -> QuietTime #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> QuietTime -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> QuietTime -> r #

gmapQ :: (forall d. Data d => d -> u) -> QuietTime -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> QuietTime -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> QuietTime -> m QuietTime #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> QuietTime -> m QuietTime #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> QuietTime -> m QuietTime #

Read QuietTime # 
Show QuietTime # 
Generic QuietTime # 

Associated Types

type Rep QuietTime :: * -> * #

Hashable QuietTime # 
ToJSON QuietTime # 
FromJSON QuietTime # 
NFData QuietTime # 

Methods

rnf :: QuietTime -> () #

type Rep QuietTime # 
type Rep QuietTime = D1 * (MetaData "QuietTime" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "QuietTime'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_qtStart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_qtEnd") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))

quietTime :: QuietTime #

Creates a value of QuietTime with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • qtStart - The default start time for quiet time in ISO 8601 format.
  • qtEnd - The default end time for quiet time in ISO 8601 format.

qtStart :: Lens' QuietTime (Maybe Text) #

The default start time for quiet time in ISO 8601 format.

qtEnd :: Lens' QuietTime (Maybe Text) #

The default end time for quiet time in ISO 8601 format.

RecencyDimension

data RecencyDimension #

Define how a segment based on recency of use.

See: recencyDimension smart constructor.

Instances

Eq RecencyDimension # 
Data RecencyDimension # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RecencyDimension -> c RecencyDimension #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RecencyDimension #

toConstr :: RecencyDimension -> Constr #

dataTypeOf :: RecencyDimension -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RecencyDimension) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RecencyDimension) #

gmapT :: (forall b. Data b => b -> b) -> RecencyDimension -> RecencyDimension #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RecencyDimension -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RecencyDimension -> r #

gmapQ :: (forall d. Data d => d -> u) -> RecencyDimension -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RecencyDimension -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RecencyDimension -> m RecencyDimension #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RecencyDimension -> m RecencyDimension #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RecencyDimension -> m RecencyDimension #

Read RecencyDimension # 
Show RecencyDimension # 
Generic RecencyDimension # 
Hashable RecencyDimension # 
ToJSON RecencyDimension # 
FromJSON RecencyDimension # 
NFData RecencyDimension # 

Methods

rnf :: RecencyDimension -> () #

type Rep RecencyDimension # 
type Rep RecencyDimension = D1 * (MetaData "RecencyDimension" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "RecencyDimension'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_rdRecencyType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe RecencyType))) (S1 * (MetaSel (Just Symbol "_rdDuration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Duration)))))

recencyDimension :: RecencyDimension #

Creates a value of RecencyDimension with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • rdRecencyType - The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
  • rdDuration - The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30

rdRecencyType :: Lens' RecencyDimension (Maybe RecencyType) #

The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.

rdDuration :: Lens' RecencyDimension (Maybe Duration) #

The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30

SMSChannelRequest

data SMSChannelRequest #

SMS Channel Request

See: sMSChannelRequest smart constructor.

Instances

Eq SMSChannelRequest # 
Data SMSChannelRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SMSChannelRequest -> c SMSChannelRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SMSChannelRequest #

toConstr :: SMSChannelRequest -> Constr #

dataTypeOf :: SMSChannelRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SMSChannelRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SMSChannelRequest) #

gmapT :: (forall b. Data b => b -> b) -> SMSChannelRequest -> SMSChannelRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SMSChannelRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SMSChannelRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> SMSChannelRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SMSChannelRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SMSChannelRequest -> m SMSChannelRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SMSChannelRequest -> m SMSChannelRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SMSChannelRequest -> m SMSChannelRequest #

Read SMSChannelRequest # 
Show SMSChannelRequest # 
Generic SMSChannelRequest # 
Hashable SMSChannelRequest # 
ToJSON SMSChannelRequest # 
NFData SMSChannelRequest # 

Methods

rnf :: SMSChannelRequest -> () #

type Rep SMSChannelRequest # 
type Rep SMSChannelRequest = D1 * (MetaData "SMSChannelRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "SMSChannelRequest'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_smscrShortCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_smscrEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_smscrSenderId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))

sMSChannelRequest :: SMSChannelRequest #

Creates a value of SMSChannelRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

smscrShortCode :: Lens' SMSChannelRequest (Maybe Text) #

ShortCode registered with phone provider.

smscrEnabled :: Lens' SMSChannelRequest (Maybe Bool) #

If the channel is enabled for sending messages.

smscrSenderId :: Lens' SMSChannelRequest (Maybe Text) #

Sender identifier of your messages.

SMSChannelResponse

data SMSChannelResponse #

SMS Channel Response.

See: sMSChannelResponse smart constructor.

Instances

Eq SMSChannelResponse # 
Data SMSChannelResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SMSChannelResponse -> c SMSChannelResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SMSChannelResponse #

toConstr :: SMSChannelResponse -> Constr #

dataTypeOf :: SMSChannelResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SMSChannelResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SMSChannelResponse) #

gmapT :: (forall b. Data b => b -> b) -> SMSChannelResponse -> SMSChannelResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SMSChannelResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SMSChannelResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> SMSChannelResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SMSChannelResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SMSChannelResponse -> m SMSChannelResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SMSChannelResponse -> m SMSChannelResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SMSChannelResponse -> m SMSChannelResponse #

Read SMSChannelResponse # 
Show SMSChannelResponse # 
Generic SMSChannelResponse # 
Hashable SMSChannelResponse # 
FromJSON SMSChannelResponse # 
NFData SMSChannelResponse # 

Methods

rnf :: SMSChannelResponse -> () #

type Rep SMSChannelResponse # 
type Rep SMSChannelResponse = D1 * (MetaData "SMSChannelResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "SMSChannelResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_smscPlatform") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_smscShortCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_smscLastModifiedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_smscEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_smscSenderId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_smscIsArchived") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_smscApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_smscVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_smscId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_smscCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_smscLastModifiedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_smscHasCredential") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))))))

sMSChannelResponse :: SMSChannelResponse #

Creates a value of SMSChannelResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

smscPlatform :: Lens' SMSChannelResponse (Maybe Text) #

Platform type. Will be SMS

smscShortCode :: Lens' SMSChannelResponse (Maybe Text) #

The short code registered with the phone provider.

smscLastModifiedDate :: Lens' SMSChannelResponse (Maybe Text) #

Last date this was updated

smscEnabled :: Lens' SMSChannelResponse (Maybe Bool) #

If the channel is enabled for sending messages.

smscSenderId :: Lens' SMSChannelResponse (Maybe Text) #

Sender identifier of your messages.

smscIsArchived :: Lens' SMSChannelResponse (Maybe Bool) #

Is this channel archived

smscApplicationId :: Lens' SMSChannelResponse (Maybe Text) #

The unique ID of the application to which the SMS channel belongs.

smscId :: Lens' SMSChannelResponse (Maybe Text) #

Channel ID. Not used, only for backwards compatibility.

smscCreationDate :: Lens' SMSChannelResponse (Maybe Text) #

The date that the settings were last updated in ISO 8601 format.

smscLastModifiedBy :: Lens' SMSChannelResponse (Maybe Text) #

Who last updated this entry

smscHasCredential :: Lens' SMSChannelResponse (Maybe Bool) #

If the channel is registered with a credential for authentication.

SMSMessage

data SMSMessage #

SMS Message.

See: sMSMessage smart constructor.

Instances

Eq SMSMessage # 
Data SMSMessage # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SMSMessage -> c SMSMessage #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SMSMessage #

toConstr :: SMSMessage -> Constr #

dataTypeOf :: SMSMessage -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SMSMessage) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SMSMessage) #

gmapT :: (forall b. Data b => b -> b) -> SMSMessage -> SMSMessage #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SMSMessage -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SMSMessage -> r #

gmapQ :: (forall d. Data d => d -> u) -> SMSMessage -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SMSMessage -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SMSMessage -> m SMSMessage #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SMSMessage -> m SMSMessage #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SMSMessage -> m SMSMessage #

Read SMSMessage # 
Show SMSMessage # 
Generic SMSMessage # 

Associated Types

type Rep SMSMessage :: * -> * #

Hashable SMSMessage # 
ToJSON SMSMessage # 
NFData SMSMessage # 

Methods

rnf :: SMSMessage -> () #

type Rep SMSMessage # 
type Rep SMSMessage = D1 * (MetaData "SMSMessage" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "SMSMessage'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_smsmSubstitutions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text [Text])))) (S1 * (MetaSel (Just Symbol "_smsmOriginationNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_smsmBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_smsmMessageType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe MessageType))) (S1 * (MetaSel (Just Symbol "_smsmSenderId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))

sMSMessage :: SMSMessage #

Creates a value of SMSMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • smsmSubstitutions - Default message substitutions. Can be overridden by individual address substitutions.
  • smsmOriginationNumber - The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.
  • smsmBody - The message body of the notification, the email body or the text message.
  • smsmMessageType - Is this a transaction priority message or lower priority.
  • smsmSenderId - The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.

smsmSubstitutions :: Lens' SMSMessage (HashMap Text [Text]) #

Default message substitutions. Can be overridden by individual address substitutions.

smsmOriginationNumber :: Lens' SMSMessage (Maybe Text) #

The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.

smsmBody :: Lens' SMSMessage (Maybe Text) #

The message body of the notification, the email body or the text message.

smsmMessageType :: Lens' SMSMessage (Maybe MessageType) #

Is this a transaction priority message or lower priority.

smsmSenderId :: Lens' SMSMessage (Maybe Text) #

The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.

Schedule

data Schedule #

Shcedule that defines when a campaign is run.

See: schedule smart constructor.

Instances

Eq Schedule # 
Data Schedule # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Schedule -> c Schedule #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Schedule #

toConstr :: Schedule -> Constr #

dataTypeOf :: Schedule -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Schedule) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Schedule) #

gmapT :: (forall b. Data b => b -> b) -> Schedule -> Schedule #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Schedule -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Schedule -> r #

gmapQ :: (forall d. Data d => d -> u) -> Schedule -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Schedule -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Schedule -> m Schedule #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Schedule -> m Schedule #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Schedule -> m Schedule #

Read Schedule # 
Show Schedule # 
Generic Schedule # 

Associated Types

type Rep Schedule :: * -> * #

Methods

from :: Schedule -> Rep Schedule x #

to :: Rep Schedule x -> Schedule #

Hashable Schedule # 

Methods

hashWithSalt :: Int -> Schedule -> Int #

hash :: Schedule -> Int #

ToJSON Schedule # 
FromJSON Schedule # 
NFData Schedule # 

Methods

rnf :: Schedule -> () #

type Rep Schedule # 

schedule :: Schedule #

Creates a value of Schedule with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • sFrequency - How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
  • sStartTime - The scheduled time that the campaign begins in ISO 8601 format.
  • sQuietTime - The time during which the campaign sends no messages.
  • sIsLocalTime - Indicates whether the campaign schedule takes effect according to each user's local time.
  • sEndTime - The scheduled time that the campaign ends in ISO 8601 format.
  • sTimezone - The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: 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 UTC-11

sFrequency :: Lens' Schedule (Maybe Frequency) #

How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY

sStartTime :: Lens' Schedule (Maybe Text) #

The scheduled time that the campaign begins in ISO 8601 format.

sQuietTime :: Lens' Schedule (Maybe QuietTime) #

The time during which the campaign sends no messages.

sIsLocalTime :: Lens' Schedule (Maybe Bool) #

Indicates whether the campaign schedule takes effect according to each user's local time.

sEndTime :: Lens' Schedule (Maybe Text) #

The scheduled time that the campaign ends in ISO 8601 format.

sTimezone :: Lens' Schedule (Maybe Text) #

The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: 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 UTC-11

SegmentBehaviors

data SegmentBehaviors #

Segment behavior dimensions

See: segmentBehaviors smart constructor.

Instances

Eq SegmentBehaviors # 
Data SegmentBehaviors # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SegmentBehaviors -> c SegmentBehaviors #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SegmentBehaviors #

toConstr :: SegmentBehaviors -> Constr #

dataTypeOf :: SegmentBehaviors -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SegmentBehaviors) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SegmentBehaviors) #

gmapT :: (forall b. Data b => b -> b) -> SegmentBehaviors -> SegmentBehaviors #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SegmentBehaviors -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SegmentBehaviors -> r #

gmapQ :: (forall d. Data d => d -> u) -> SegmentBehaviors -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SegmentBehaviors -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SegmentBehaviors -> m SegmentBehaviors #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentBehaviors -> m SegmentBehaviors #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentBehaviors -> m SegmentBehaviors #

Read SegmentBehaviors # 
Show SegmentBehaviors # 
Generic SegmentBehaviors # 
Hashable SegmentBehaviors # 
ToJSON SegmentBehaviors # 
FromJSON SegmentBehaviors # 
NFData SegmentBehaviors # 

Methods

rnf :: SegmentBehaviors -> () #

type Rep SegmentBehaviors # 
type Rep SegmentBehaviors = D1 * (MetaData "SegmentBehaviors" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" True) (C1 * (MetaCons "SegmentBehaviors'" PrefixI True) (S1 * (MetaSel (Just Symbol "_sbRecency") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe RecencyDimension))))

segmentBehaviors :: SegmentBehaviors #

Creates a value of SegmentBehaviors with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

SegmentDemographics

data SegmentDemographics #

Segment demographic dimensions

See: segmentDemographics smart constructor.

Instances

Eq SegmentDemographics # 
Data SegmentDemographics # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SegmentDemographics -> c SegmentDemographics #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SegmentDemographics #

toConstr :: SegmentDemographics -> Constr #

dataTypeOf :: SegmentDemographics -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SegmentDemographics) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SegmentDemographics) #

gmapT :: (forall b. Data b => b -> b) -> SegmentDemographics -> SegmentDemographics #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SegmentDemographics -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SegmentDemographics -> r #

gmapQ :: (forall d. Data d => d -> u) -> SegmentDemographics -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SegmentDemographics -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SegmentDemographics -> m SegmentDemographics #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentDemographics -> m SegmentDemographics #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentDemographics -> m SegmentDemographics #

Read SegmentDemographics # 
Show SegmentDemographics # 
Generic SegmentDemographics # 
Hashable SegmentDemographics # 
ToJSON SegmentDemographics # 
FromJSON SegmentDemographics # 
NFData SegmentDemographics # 

Methods

rnf :: SegmentDemographics -> () #

type Rep SegmentDemographics # 

segmentDemographics :: SegmentDemographics #

Creates a value of SegmentDemographics with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • sdPlatform - The device platform criteria for the segment.
  • sdAppVersion - The app version criteria for the segment.
  • sdChannel - The channel criteria for the segment.
  • sdModel - The device model criteria for the segment.
  • sdMake - The device make criteria for the segment.
  • sdDeviceType - The device type criteria for the segment.

sdPlatform :: Lens' SegmentDemographics (Maybe SetDimension) #

The device platform criteria for the segment.

sdAppVersion :: Lens' SegmentDemographics (Maybe SetDimension) #

The app version criteria for the segment.

sdChannel :: Lens' SegmentDemographics (Maybe SetDimension) #

The channel criteria for the segment.

sdModel :: Lens' SegmentDemographics (Maybe SetDimension) #

The device model criteria for the segment.

sdMake :: Lens' SegmentDemographics (Maybe SetDimension) #

The device make criteria for the segment.

sdDeviceType :: Lens' SegmentDemographics (Maybe SetDimension) #

The device type criteria for the segment.

SegmentDimensions

data SegmentDimensions #

Segment dimensions

See: segmentDimensions smart constructor.

Instances

Eq SegmentDimensions # 
Data SegmentDimensions # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SegmentDimensions -> c SegmentDimensions #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SegmentDimensions #

toConstr :: SegmentDimensions -> Constr #

dataTypeOf :: SegmentDimensions -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SegmentDimensions) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SegmentDimensions) #

gmapT :: (forall b. Data b => b -> b) -> SegmentDimensions -> SegmentDimensions #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SegmentDimensions -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SegmentDimensions -> r #

gmapQ :: (forall d. Data d => d -> u) -> SegmentDimensions -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SegmentDimensions -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SegmentDimensions -> m SegmentDimensions #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentDimensions -> m SegmentDimensions #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentDimensions -> m SegmentDimensions #

Read SegmentDimensions # 
Show SegmentDimensions # 
Generic SegmentDimensions # 
Hashable SegmentDimensions # 
ToJSON SegmentDimensions # 
FromJSON SegmentDimensions # 
NFData SegmentDimensions # 

Methods

rnf :: SegmentDimensions -> () #

type Rep SegmentDimensions # 

segmentDimensions :: SegmentDimensions #

Creates a value of SegmentDimensions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sdLocation :: Lens' SegmentDimensions (Maybe SegmentLocation) #

The segment location attributes.

sdDemographic :: Lens' SegmentDimensions (Maybe SegmentDemographics) #

The segment demographics attributes.

sdBehavior :: Lens' SegmentDimensions (Maybe SegmentBehaviors) #

The segment behaviors attributes.

SegmentImportResource

data SegmentImportResource #

Segment import definition.

See: segmentImportResource smart constructor.

Instances

Eq SegmentImportResource # 
Data SegmentImportResource # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SegmentImportResource -> c SegmentImportResource #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SegmentImportResource #

toConstr :: SegmentImportResource -> Constr #

dataTypeOf :: SegmentImportResource -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SegmentImportResource) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SegmentImportResource) #

gmapT :: (forall b. Data b => b -> b) -> SegmentImportResource -> SegmentImportResource #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SegmentImportResource -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SegmentImportResource -> r #

gmapQ :: (forall d. Data d => d -> u) -> SegmentImportResource -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SegmentImportResource -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SegmentImportResource -> m SegmentImportResource #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentImportResource -> m SegmentImportResource #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentImportResource -> m SegmentImportResource #

Read SegmentImportResource # 
Show SegmentImportResource # 
Generic SegmentImportResource # 
Hashable SegmentImportResource # 
FromJSON SegmentImportResource # 
NFData SegmentImportResource # 

Methods

rnf :: SegmentImportResource -> () #

type Rep SegmentImportResource # 
type Rep SegmentImportResource = D1 * (MetaData "SegmentImportResource" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "SegmentImportResource'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sirSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sirFormat") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DefinitionFormat))) (S1 * (MetaSel (Just Symbol "_sirChannelCounts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Int)))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sirExternalId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sirS3URL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sirRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))

segmentImportResource :: SegmentImportResource #

Creates a value of SegmentImportResource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • sirSize - The number of endpoints that were successfully imported to create this segment.
  • sirFormat - The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
  • sirChannelCounts - Channel type counts
  • sirExternalId - DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
  • sirS3URL - A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.
  • sirRoleARN - The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.

sirSize :: Lens' SegmentImportResource (Maybe Int) #

The number of endpoints that were successfully imported to create this segment.

sirFormat :: Lens' SegmentImportResource (Maybe DefinitionFormat) #

The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON

sirExternalId :: Lens' SegmentImportResource (Maybe Text) #

DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

sirS3URL :: Lens' SegmentImportResource (Maybe Text) #

A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.

sirRoleARN :: Lens' SegmentImportResource (Maybe Text) #

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.

SegmentLocation

data SegmentLocation #

Segment location dimensions

See: segmentLocation smart constructor.

Instances

Eq SegmentLocation # 
Data SegmentLocation # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SegmentLocation -> c SegmentLocation #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SegmentLocation #

toConstr :: SegmentLocation -> Constr #

dataTypeOf :: SegmentLocation -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SegmentLocation) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SegmentLocation) #

gmapT :: (forall b. Data b => b -> b) -> SegmentLocation -> SegmentLocation #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SegmentLocation -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SegmentLocation -> r #

gmapQ :: (forall d. Data d => d -> u) -> SegmentLocation -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SegmentLocation -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SegmentLocation -> m SegmentLocation #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentLocation -> m SegmentLocation #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentLocation -> m SegmentLocation #

Read SegmentLocation # 
Show SegmentLocation # 
Generic SegmentLocation # 
Hashable SegmentLocation # 
ToJSON SegmentLocation # 
FromJSON SegmentLocation # 
NFData SegmentLocation # 

Methods

rnf :: SegmentLocation -> () #

type Rep SegmentLocation # 
type Rep SegmentLocation = D1 * (MetaData "SegmentLocation" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" True) (C1 * (MetaCons "SegmentLocation'" PrefixI True) (S1 * (MetaSel (Just Symbol "_slCountry") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe SetDimension))))

segmentLocation :: SegmentLocation #

Creates a value of SegmentLocation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • slCountry - The country filter according to ISO 3166-1 Alpha-2 codes.

slCountry :: Lens' SegmentLocation (Maybe SetDimension) #

The country filter according to ISO 3166-1 Alpha-2 codes.

SegmentResponse

data SegmentResponse #

Segment definition.

See: segmentResponse smart constructor.

Instances

Eq SegmentResponse # 
Data SegmentResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SegmentResponse -> c SegmentResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SegmentResponse #

toConstr :: SegmentResponse -> Constr #

dataTypeOf :: SegmentResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SegmentResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SegmentResponse) #

gmapT :: (forall b. Data b => b -> b) -> SegmentResponse -> SegmentResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SegmentResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SegmentResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> SegmentResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SegmentResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SegmentResponse -> m SegmentResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentResponse -> m SegmentResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentResponse -> m SegmentResponse #

Read SegmentResponse # 
Show SegmentResponse # 
Generic SegmentResponse # 
Hashable SegmentResponse # 
FromJSON SegmentResponse # 
NFData SegmentResponse # 

Methods

rnf :: SegmentResponse -> () #

type Rep SegmentResponse # 

segmentResponse :: SegmentResponse #

Creates a value of SegmentResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • sLastModifiedDate - The date the segment was last updated in ISO 8601 format.
  • sSegmentType - The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
  • sApplicationId - The ID of the application to which the segment applies.
  • sName - The name of segment
  • sVersion - The segment version number.
  • sId - The unique segment ID.
  • sCreationDate - The date the segment was created in ISO 8601 format.
  • sImportDefinition - The import job settings.
  • sDimensions - The segment dimensions attributes.

sLastModifiedDate :: Lens' SegmentResponse (Maybe Text) #

The date the segment was last updated in ISO 8601 format.

sSegmentType :: Lens' SegmentResponse (Maybe SegmentType) #

The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.

sApplicationId :: Lens' SegmentResponse (Maybe Text) #

The ID of the application to which the segment applies.

sName :: Lens' SegmentResponse (Maybe Text) #

The name of segment

sVersion :: Lens' SegmentResponse (Maybe Int) #

The segment version number.

sId :: Lens' SegmentResponse (Maybe Text) #

The unique segment ID.

sCreationDate :: Lens' SegmentResponse (Maybe Text) #

The date the segment was created in ISO 8601 format.

sDimensions :: Lens' SegmentResponse (Maybe SegmentDimensions) #

The segment dimensions attributes.

SegmentsResponse

data SegmentsResponse #

Segments in your account.

See: segmentsResponse smart constructor.

Instances

Eq SegmentsResponse # 
Data SegmentsResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SegmentsResponse -> c SegmentsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SegmentsResponse #

toConstr :: SegmentsResponse -> Constr #

dataTypeOf :: SegmentsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SegmentsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SegmentsResponse) #

gmapT :: (forall b. Data b => b -> b) -> SegmentsResponse -> SegmentsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SegmentsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SegmentsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> SegmentsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SegmentsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SegmentsResponse -> m SegmentsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentsResponse -> m SegmentsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SegmentsResponse -> m SegmentsResponse #

Read SegmentsResponse # 
Show SegmentsResponse # 
Generic SegmentsResponse # 
Hashable SegmentsResponse # 
FromJSON SegmentsResponse # 
NFData SegmentsResponse # 

Methods

rnf :: SegmentsResponse -> () #

type Rep SegmentsResponse # 
type Rep SegmentsResponse = D1 * (MetaData "SegmentsResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "SegmentsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sItem") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [SegmentResponse])))))

segmentsResponse :: SegmentsResponse #

Creates a value of SegmentsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • sNextToken - An identifier used to retrieve the next page of results. The token is null if no additional pages exist.
  • sItem - The list of segments.

sNextToken :: Lens' SegmentsResponse (Maybe Text) #

An identifier used to retrieve the next page of results. The token is null if no additional pages exist.

sItem :: Lens' SegmentsResponse [SegmentResponse] #

The list of segments.

SendUsersMessageRequest

data SendUsersMessageRequest #

Send message request.

See: sendUsersMessageRequest smart constructor.

Instances

Eq SendUsersMessageRequest # 
Data SendUsersMessageRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SendUsersMessageRequest -> c SendUsersMessageRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SendUsersMessageRequest #

toConstr :: SendUsersMessageRequest -> Constr #

dataTypeOf :: SendUsersMessageRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SendUsersMessageRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SendUsersMessageRequest) #

gmapT :: (forall b. Data b => b -> b) -> SendUsersMessageRequest -> SendUsersMessageRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SendUsersMessageRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SendUsersMessageRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> SendUsersMessageRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SendUsersMessageRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SendUsersMessageRequest -> m SendUsersMessageRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SendUsersMessageRequest -> m SendUsersMessageRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SendUsersMessageRequest -> m SendUsersMessageRequest #

Read SendUsersMessageRequest # 
Show SendUsersMessageRequest # 
Generic SendUsersMessageRequest # 
Hashable SendUsersMessageRequest # 
ToJSON SendUsersMessageRequest # 
NFData SendUsersMessageRequest # 

Methods

rnf :: SendUsersMessageRequest -> () #

type Rep SendUsersMessageRequest # 
type Rep SendUsersMessageRequest = D1 * (MetaData "SendUsersMessageRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "SendUsersMessageRequest'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sumrContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sumrUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text EndpointSendConfiguration)))) (S1 * (MetaSel (Just Symbol "_sumrMessageConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DirectMessageConfiguration))))))

sendUsersMessageRequest :: SendUsersMessageRequest #

Creates a value of SendUsersMessageRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • sumrContext - A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
  • sumrUsers - A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value.
  • sumrMessageConfiguration - Message configuration.

sumrContext :: Lens' SendUsersMessageRequest (HashMap Text Text) #

A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.

sumrUsers :: Lens' SendUsersMessageRequest (HashMap Text EndpointSendConfiguration) #

A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value.

SendUsersMessageResponse

data SendUsersMessageResponse #

User send message response.

See: sendUsersMessageResponse smart constructor.

Instances

Eq SendUsersMessageResponse # 
Data SendUsersMessageResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SendUsersMessageResponse -> c SendUsersMessageResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SendUsersMessageResponse #

toConstr :: SendUsersMessageResponse -> Constr #

dataTypeOf :: SendUsersMessageResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SendUsersMessageResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SendUsersMessageResponse) #

gmapT :: (forall b. Data b => b -> b) -> SendUsersMessageResponse -> SendUsersMessageResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SendUsersMessageResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SendUsersMessageResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> SendUsersMessageResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SendUsersMessageResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SendUsersMessageResponse -> m SendUsersMessageResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SendUsersMessageResponse -> m SendUsersMessageResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SendUsersMessageResponse -> m SendUsersMessageResponse #

Read SendUsersMessageResponse # 
Show SendUsersMessageResponse # 
Generic SendUsersMessageResponse # 
Hashable SendUsersMessageResponse # 
FromJSON SendUsersMessageResponse # 
NFData SendUsersMessageResponse # 
type Rep SendUsersMessageResponse # 
type Rep SendUsersMessageResponse = D1 * (MetaData "SendUsersMessageResponse" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "SendUsersMessageResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sumRequestId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sumResult") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text (Map Text EndpointMessageResult))))) (S1 * (MetaSel (Just Symbol "_sumApplicationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))

sendUsersMessageResponse :: SendUsersMessageResponse #

Creates a value of SendUsersMessageResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • sumRequestId - Original request Id for which this message was delivered.
  • sumResult - A map containing of UserId to Map of EndpointId to Endpoint Message Result.
  • sumApplicationId - Application id of the message.

sumRequestId :: Lens' SendUsersMessageResponse (Maybe Text) #

Original request Id for which this message was delivered.

sumResult :: Lens' SendUsersMessageResponse (HashMap Text (HashMap Text EndpointMessageResult)) #

A map containing of UserId to Map of EndpointId to Endpoint Message Result.

sumApplicationId :: Lens' SendUsersMessageResponse (Maybe Text) #

Application id of the message.

SetDimension

data SetDimension #

Dimension specification of a segment.

See: setDimension smart constructor.

Instances

Eq SetDimension # 
Data SetDimension # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetDimension -> c SetDimension #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetDimension #

toConstr :: SetDimension -> Constr #

dataTypeOf :: SetDimension -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SetDimension) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetDimension) #

gmapT :: (forall b. Data b => b -> b) -> SetDimension -> SetDimension #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetDimension -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetDimension -> r #

gmapQ :: (forall d. Data d => d -> u) -> SetDimension -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SetDimension -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetDimension -> m SetDimension #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetDimension -> m SetDimension #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetDimension -> m SetDimension #

Read SetDimension # 
Show SetDimension # 
Generic SetDimension # 

Associated Types

type Rep SetDimension :: * -> * #

Hashable SetDimension # 
ToJSON SetDimension # 
FromJSON SetDimension # 
NFData SetDimension # 

Methods

rnf :: SetDimension -> () #

type Rep SetDimension # 
type Rep SetDimension = D1 * (MetaData "SetDimension" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "SetDimension'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sdValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_sdDimensionType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DimensionType)))))

setDimension :: SetDimension #

Creates a value of SetDimension with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • sdValues - The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
  • sdDimensionType - The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.

sdValues :: Lens' SetDimension [Text] #

The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.

sdDimensionType :: Lens' SetDimension (Maybe DimensionType) #

The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.

TreatmentResource

data TreatmentResource #

Treatment resource

See: treatmentResource smart constructor.

Instances

Eq TreatmentResource # 
Data TreatmentResource # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TreatmentResource -> c TreatmentResource #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TreatmentResource #

toConstr :: TreatmentResource -> Constr #

dataTypeOf :: TreatmentResource -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c TreatmentResource) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TreatmentResource) #

gmapT :: (forall b. Data b => b -> b) -> TreatmentResource -> TreatmentResource #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TreatmentResource -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TreatmentResource -> r #

gmapQ :: (forall d. Data d => d -> u) -> TreatmentResource -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> TreatmentResource -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TreatmentResource -> m TreatmentResource #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TreatmentResource -> m TreatmentResource #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TreatmentResource -> m TreatmentResource #

Read TreatmentResource # 
Show TreatmentResource # 
Generic TreatmentResource # 
Hashable TreatmentResource # 
FromJSON TreatmentResource # 
NFData TreatmentResource # 

Methods

rnf :: TreatmentResource -> () #

type Rep TreatmentResource # 

treatmentResource :: TreatmentResource #

Creates a value of TreatmentResource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

trSchedule :: Lens' TreatmentResource (Maybe Schedule) #

The campaign schedule.

trTreatmentName :: Lens' TreatmentResource (Maybe Text) #

The custom name of a variation of the campaign used for A/B testing.

trSizePercent :: Lens' TreatmentResource (Maybe Int) #

The allocated percentage of users for this treatment.

trTreatmentDescription :: Lens' TreatmentResource (Maybe Text) #

A custom description for the treatment.

trId :: Lens' TreatmentResource (Maybe Text) #

The unique treatment ID.

WriteApplicationSettingsRequest

data WriteApplicationSettingsRequest #

Creating application setting request

See: writeApplicationSettingsRequest smart constructor.

Instances

Eq WriteApplicationSettingsRequest # 
Data WriteApplicationSettingsRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WriteApplicationSettingsRequest -> c WriteApplicationSettingsRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c WriteApplicationSettingsRequest #

toConstr :: WriteApplicationSettingsRequest -> Constr #

dataTypeOf :: WriteApplicationSettingsRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c WriteApplicationSettingsRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c WriteApplicationSettingsRequest) #

gmapT :: (forall b. Data b => b -> b) -> WriteApplicationSettingsRequest -> WriteApplicationSettingsRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WriteApplicationSettingsRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WriteApplicationSettingsRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> WriteApplicationSettingsRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> WriteApplicationSettingsRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> WriteApplicationSettingsRequest -> m WriteApplicationSettingsRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WriteApplicationSettingsRequest -> m WriteApplicationSettingsRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WriteApplicationSettingsRequest -> m WriteApplicationSettingsRequest #

Read WriteApplicationSettingsRequest # 
Show WriteApplicationSettingsRequest # 
Generic WriteApplicationSettingsRequest # 
Hashable WriteApplicationSettingsRequest # 
ToJSON WriteApplicationSettingsRequest # 
NFData WriteApplicationSettingsRequest # 
type Rep WriteApplicationSettingsRequest # 
type Rep WriteApplicationSettingsRequest = D1 * (MetaData "WriteApplicationSettingsRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "WriteApplicationSettingsRequest'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_wasrLimits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe CampaignLimits))) ((:*:) * (S1 * (MetaSel (Just Symbol "_wasrQuietTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe QuietTime))) (S1 * (MetaSel (Just Symbol "_wasrCampaignHook") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe CampaignHook))))))

writeApplicationSettingsRequest :: WriteApplicationSettingsRequest #

Creates a value of WriteApplicationSettingsRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • wasrLimits - The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.
  • wasrQuietTime - The default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own.
  • wasrCampaignHook - Default campaign hook information.

wasrLimits :: Lens' WriteApplicationSettingsRequest (Maybe CampaignLimits) #

The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.

wasrQuietTime :: Lens' WriteApplicationSettingsRequest (Maybe QuietTime) #

The default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own.

WriteCampaignRequest

data WriteCampaignRequest #

Used to create a campaign.

See: writeCampaignRequest smart constructor.

Instances

Eq WriteCampaignRequest # 
Data WriteCampaignRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WriteCampaignRequest -> c WriteCampaignRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c WriteCampaignRequest #

toConstr :: WriteCampaignRequest -> Constr #

dataTypeOf :: WriteCampaignRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c WriteCampaignRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c WriteCampaignRequest) #

gmapT :: (forall b. Data b => b -> b) -> WriteCampaignRequest -> WriteCampaignRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WriteCampaignRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WriteCampaignRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> WriteCampaignRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> WriteCampaignRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> WriteCampaignRequest -> m WriteCampaignRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WriteCampaignRequest -> m WriteCampaignRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WriteCampaignRequest -> m WriteCampaignRequest #

Read WriteCampaignRequest # 
Show WriteCampaignRequest # 
Generic WriteCampaignRequest # 
Hashable WriteCampaignRequest # 
ToJSON WriteCampaignRequest # 
NFData WriteCampaignRequest # 

Methods

rnf :: WriteCampaignRequest -> () #

type Rep WriteCampaignRequest # 
type Rep WriteCampaignRequest = D1 * (MetaData "WriteCampaignRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "WriteCampaignRequest'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_wcrSchedule") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Schedule))) ((:*:) * (S1 * (MetaSel (Just Symbol "_wcrHook") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe CampaignHook))) (S1 * (MetaSel (Just Symbol "_wcrTreatmentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_wcrLimits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe CampaignLimits))) ((:*:) * (S1 * (MetaSel (Just Symbol "_wcrIsPaused") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_wcrName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_wcrHoldoutPercent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "_wcrTreatmentDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_wcrMessageConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe MessageConfiguration))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_wcrDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_wcrSegmentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_wcrAdditionalTreatments") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [WriteTreatmentResource]))) (S1 * (MetaSel (Just Symbol "_wcrSegmentVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))))))))

writeCampaignRequest :: WriteCampaignRequest #

Creates a value of WriteCampaignRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

wcrHook :: Lens' WriteCampaignRequest (Maybe CampaignHook) #

Campaign hook information.

wcrTreatmentName :: Lens' WriteCampaignRequest (Maybe Text) #

The custom name of a variation of the campaign used for A/B testing.

wcrLimits :: Lens' WriteCampaignRequest (Maybe CampaignLimits) #

The campaign limits settings.

wcrIsPaused :: Lens' WriteCampaignRequest (Maybe Bool) #

Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.

wcrName :: Lens' WriteCampaignRequest (Maybe Text) #

The custom name of the campaign.

wcrHoldoutPercent :: Lens' WriteCampaignRequest (Maybe Int) #

The allocated percentage of end users who will not receive messages from this campaign.

wcrTreatmentDescription :: Lens' WriteCampaignRequest (Maybe Text) #

A custom description for the treatment.

wcrDescription :: Lens' WriteCampaignRequest (Maybe Text) #

A description of the campaign.

wcrSegmentId :: Lens' WriteCampaignRequest (Maybe Text) #

The ID of the segment to which the campaign sends messages.

wcrAdditionalTreatments :: Lens' WriteCampaignRequest [WriteTreatmentResource] #

Treatments that are defined in addition to the default treatment.

wcrSegmentVersion :: Lens' WriteCampaignRequest (Maybe Int) #

The version of the segment to which the campaign sends messages.

WriteEventStream

data WriteEventStream #

Request to save an EventStream.

See: writeEventStream smart constructor.

Instances

Eq WriteEventStream # 
Data WriteEventStream # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WriteEventStream -> c WriteEventStream #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c WriteEventStream #

toConstr :: WriteEventStream -> Constr #

dataTypeOf :: WriteEventStream -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c WriteEventStream) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c WriteEventStream) #

gmapT :: (forall b. Data b => b -> b) -> WriteEventStream -> WriteEventStream #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WriteEventStream -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WriteEventStream -> r #

gmapQ :: (forall d. Data d => d -> u) -> WriteEventStream -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> WriteEventStream -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> WriteEventStream -> m WriteEventStream #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WriteEventStream -> m WriteEventStream #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WriteEventStream -> m WriteEventStream #

Read WriteEventStream # 
Show WriteEventStream # 
Generic WriteEventStream # 
Hashable WriteEventStream # 
ToJSON WriteEventStream # 
NFData WriteEventStream # 

Methods

rnf :: WriteEventStream -> () #

type Rep WriteEventStream # 
type Rep WriteEventStream = D1 * (MetaData "WriteEventStream" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "WriteEventStream'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_wesDestinationStreamARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_wesRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))

writeEventStream :: WriteEventStream #

Creates a value of WriteEventStream with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • wesDestinationStreamARN - The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystreamSTREAM_NAME Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:streamSTREAM_NAME
  • wesRoleARN - The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

wesDestinationStreamARN :: Lens' WriteEventStream (Maybe Text) #

The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystreamSTREAM_NAME Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:streamSTREAM_NAME

wesRoleARN :: Lens' WriteEventStream (Maybe Text) #

The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

WriteSegmentRequest

data WriteSegmentRequest #

Segment definition.

See: writeSegmentRequest smart constructor.

Instances

Eq WriteSegmentRequest # 
Data WriteSegmentRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WriteSegmentRequest -> c WriteSegmentRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c WriteSegmentRequest #

toConstr :: WriteSegmentRequest -> Constr #

dataTypeOf :: WriteSegmentRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c WriteSegmentRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c WriteSegmentRequest) #

gmapT :: (forall b. Data b => b -> b) -> WriteSegmentRequest -> WriteSegmentRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WriteSegmentRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WriteSegmentRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> WriteSegmentRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> WriteSegmentRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> WriteSegmentRequest -> m WriteSegmentRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WriteSegmentRequest -> m WriteSegmentRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WriteSegmentRequest -> m WriteSegmentRequest #

Read WriteSegmentRequest # 
Show WriteSegmentRequest # 
Generic WriteSegmentRequest # 
Hashable WriteSegmentRequest # 
ToJSON WriteSegmentRequest # 
NFData WriteSegmentRequest # 

Methods

rnf :: WriteSegmentRequest -> () #

type Rep WriteSegmentRequest # 
type Rep WriteSegmentRequest = D1 * (MetaData "WriteSegmentRequest" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "WriteSegmentRequest'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_wsrName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_wsrDimensions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe SegmentDimensions)))))

writeSegmentRequest :: WriteSegmentRequest #

Creates a value of WriteSegmentRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

wsrName :: Lens' WriteSegmentRequest (Maybe Text) #

The name of segment

wsrDimensions :: Lens' WriteSegmentRequest (Maybe SegmentDimensions) #

The segment dimensions attributes.

WriteTreatmentResource

data WriteTreatmentResource #

Used to create a campaign treatment.

See: writeTreatmentResource smart constructor.

Instances

Eq WriteTreatmentResource # 
Data WriteTreatmentResource # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WriteTreatmentResource -> c WriteTreatmentResource #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c WriteTreatmentResource #

toConstr :: WriteTreatmentResource -> Constr #

dataTypeOf :: WriteTreatmentResource -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c WriteTreatmentResource) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c WriteTreatmentResource) #

gmapT :: (forall b. Data b => b -> b) -> WriteTreatmentResource -> WriteTreatmentResource #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WriteTreatmentResource -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WriteTreatmentResource -> r #

gmapQ :: (forall d. Data d => d -> u) -> WriteTreatmentResource -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> WriteTreatmentResource -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> WriteTreatmentResource -> m WriteTreatmentResource #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WriteTreatmentResource -> m WriteTreatmentResource #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WriteTreatmentResource -> m WriteTreatmentResource #

Read WriteTreatmentResource # 
Show WriteTreatmentResource # 
Generic WriteTreatmentResource # 
Hashable WriteTreatmentResource # 
ToJSON WriteTreatmentResource # 
NFData WriteTreatmentResource # 

Methods

rnf :: WriteTreatmentResource -> () #

type Rep WriteTreatmentResource # 
type Rep WriteTreatmentResource = D1 * (MetaData "WriteTreatmentResource" "Network.AWS.Pinpoint.Types.Product" "amazonka-pinpoint-1.6.0-GGmcAobjjkd29SkAbz3WDe" False) (C1 * (MetaCons "WriteTreatmentResource'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_wtrSchedule") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Schedule))) (S1 * (MetaSel (Just Symbol "_wtrTreatmentName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_wtrSizePercent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "_wtrTreatmentDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_wtrMessageConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe MessageConfiguration)))))))

writeTreatmentResource :: WriteTreatmentResource #

Creates a value of WriteTreatmentResource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

wtrTreatmentName :: Lens' WriteTreatmentResource (Maybe Text) #

The custom name of a variation of the campaign used for A/B testing.

wtrSizePercent :: Lens' WriteTreatmentResource (Maybe Int) #

The allocated percentage of users for this treatment.

wtrTreatmentDescription :: Lens' WriteTreatmentResource (Maybe Text) #

A custom description for the treatment.