Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- GetGCMChannel
- GetSegmentImportJobs
- GetImportJob
- GetSegmentVersions
- DeleteCampaign
- UpdateCampaign
- GetSegmentVersion
- CreateSegment
- UpdateEndpoint
- CreateCampaign
- GetEndpoint
- GetSegment
- UpdateEndpointsBatch
- GetCampaign
- UpdateGCMChannel
- DeleteGCMChannel
- GetCampaignActivities
- DeleteAPNSChannel
- UpdateAPNSChannel
- GetCampaignVersions
- GetAPNSChannel
- GetImportJobs
- GetCampaignVersion
- DeleteSegment
- UpdateSegment
- GetCampaigns
- UpdateApplicationSettings
- GetSegments
- CreateImportJob
- GetApplicationSettings
- Types
- Action
- AttributeType
- CampaignStatus
- ChannelType
- DefinitionFormat
- DimensionType
- Duration
- Frequency
- JobStatus
- RecencyType
- SegmentType
- APNSChannelRequest
- APNSChannelResponse
- ActivitiesResponse
- ActivityResponse
- ApplicationSettingsResource
- AttributeDimension
- CampaignLimits
- CampaignResponse
- CampaignState
- CampaignsResponse
- EndpointBatchItem
- EndpointBatchRequest
- EndpointDemographic
- EndpointLocation
- EndpointRequest
- EndpointResponse
- EndpointUser
- GCMChannelRequest
- GCMChannelResponse
- ImportJobRequest
- ImportJobResource
- ImportJobResponse
- ImportJobsResponse
- Message
- MessageBody
- MessageConfiguration
- QuietTime
- RecencyDimension
- Schedule
- SegmentBehaviors
- SegmentDemographics
- SegmentDimensions
- SegmentImportResource
- SegmentLocation
- SegmentResponse
- SegmentsResponse
- SetDimension
- TreatmentResource
- WriteApplicationSettingsRequest
- WriteCampaignRequest
- WriteSegmentRequest
- WriteTreatmentResource
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.
- pinpoint :: Service
- _ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _MethodNotAllowedException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.Pinpoint.GetGCMChannel
- module Network.AWS.Pinpoint.GetSegmentImportJobs
- module Network.AWS.Pinpoint.GetImportJob
- module Network.AWS.Pinpoint.GetSegmentVersions
- module Network.AWS.Pinpoint.DeleteCampaign
- module Network.AWS.Pinpoint.UpdateCampaign
- module Network.AWS.Pinpoint.GetSegmentVersion
- module Network.AWS.Pinpoint.CreateSegment
- module Network.AWS.Pinpoint.UpdateEndpoint
- module Network.AWS.Pinpoint.CreateCampaign
- module Network.AWS.Pinpoint.GetEndpoint
- module Network.AWS.Pinpoint.GetSegment
- module Network.AWS.Pinpoint.UpdateEndpointsBatch
- module Network.AWS.Pinpoint.GetCampaign
- module Network.AWS.Pinpoint.UpdateGCMChannel
- module Network.AWS.Pinpoint.DeleteGCMChannel
- module Network.AWS.Pinpoint.GetCampaignActivities
- module Network.AWS.Pinpoint.DeleteAPNSChannel
- module Network.AWS.Pinpoint.UpdateAPNSChannel
- module Network.AWS.Pinpoint.GetCampaignVersions
- module Network.AWS.Pinpoint.GetAPNSChannel
- module Network.AWS.Pinpoint.GetImportJobs
- module Network.AWS.Pinpoint.GetCampaignVersion
- module Network.AWS.Pinpoint.DeleteSegment
- module Network.AWS.Pinpoint.UpdateSegment
- module Network.AWS.Pinpoint.GetCampaigns
- module Network.AWS.Pinpoint.UpdateApplicationSettings
- module Network.AWS.Pinpoint.GetSegments
- module Network.AWS.Pinpoint.CreateImportJob
- module Network.AWS.Pinpoint.GetApplicationSettings
- data Action
- data AttributeType
- data CampaignStatus
- data ChannelType
- data DefinitionFormat
- data DimensionType
- data Duration
- data Frequency
- data JobStatus
- data RecencyType
- data SegmentType
- data APNSChannelRequest
- apnsChannelRequest :: APNSChannelRequest
- acrPrivateKey :: Lens' APNSChannelRequest (Maybe Text)
- acrCertificate :: Lens' APNSChannelRequest (Maybe Text)
- data APNSChannelResponse
- apnsChannelResponse :: APNSChannelResponse
- acPlatform :: Lens' APNSChannelResponse (Maybe Text)
- acLastModifiedDate :: Lens' APNSChannelResponse (Maybe Text)
- acIsArchived :: Lens' APNSChannelResponse (Maybe Bool)
- acApplicationId :: Lens' APNSChannelResponse (Maybe Text)
- acVersion :: Lens' APNSChannelResponse (Maybe Int)
- acId :: Lens' APNSChannelResponse (Maybe Text)
- acCreationDate :: Lens' APNSChannelResponse (Maybe Text)
- acLastModifiedBy :: Lens' APNSChannelResponse (Maybe Text)
- data ActivitiesResponse
- activitiesResponse :: ActivitiesResponse
- aItem :: Lens' ActivitiesResponse [ActivityResponse]
- data ActivityResponse
- activityResponse :: ActivityResponse
- aState :: Lens' ActivityResponse (Maybe Text)
- aStart :: Lens' ActivityResponse (Maybe Text)
- aCampaignId :: Lens' ActivityResponse (Maybe Text)
- aResult :: Lens' ActivityResponse (Maybe Text)
- aTreatmentId :: Lens' ActivityResponse (Maybe Text)
- aSuccessfulEndpointCount :: Lens' ActivityResponse (Maybe Int)
- aEnd :: Lens' ActivityResponse (Maybe Text)
- aApplicationId :: Lens' ActivityResponse (Maybe Text)
- aTotalEndpointCount :: Lens' ActivityResponse (Maybe Int)
- aId :: Lens' ActivityResponse (Maybe Text)
- aScheduledStart :: Lens' ActivityResponse (Maybe Text)
- data ApplicationSettingsResource
- applicationSettingsResource :: ApplicationSettingsResource
- asrLastModifiedDate :: Lens' ApplicationSettingsResource (Maybe Text)
- asrLimits :: Lens' ApplicationSettingsResource (Maybe CampaignLimits)
- asrQuietTime :: Lens' ApplicationSettingsResource (Maybe QuietTime)
- asrApplicationId :: Lens' ApplicationSettingsResource (Maybe Text)
- data AttributeDimension
- attributeDimension :: AttributeDimension
- adValues :: Lens' AttributeDimension [Text]
- adAttributeType :: Lens' AttributeDimension (Maybe AttributeType)
- data CampaignLimits
- campaignLimits :: CampaignLimits
- clDaily :: Lens' CampaignLimits (Maybe Int)
- clTotal :: Lens' CampaignLimits (Maybe Int)
- data CampaignResponse
- campaignResponse :: CampaignResponse
- cState :: Lens' CampaignResponse (Maybe CampaignState)
- cLastModifiedDate :: Lens' CampaignResponse (Maybe Text)
- cSchedule :: Lens' CampaignResponse (Maybe Schedule)
- cTreatmentName :: Lens' CampaignResponse (Maybe Text)
- cLimits :: Lens' CampaignResponse (Maybe CampaignLimits)
- cIsPaused :: Lens' CampaignResponse (Maybe Bool)
- cDefaultState :: Lens' CampaignResponse (Maybe CampaignState)
- cApplicationId :: Lens' CampaignResponse (Maybe Text)
- cName :: Lens' CampaignResponse (Maybe Text)
- cVersion :: Lens' CampaignResponse (Maybe Int)
- cHoldoutPercent :: Lens' CampaignResponse (Maybe Int)
- cTreatmentDescription :: Lens' CampaignResponse (Maybe Text)
- cId :: Lens' CampaignResponse (Maybe Text)
- cCreationDate :: Lens' CampaignResponse (Maybe Text)
- cMessageConfiguration :: Lens' CampaignResponse (Maybe MessageConfiguration)
- cDescription :: Lens' CampaignResponse (Maybe Text)
- cSegmentId :: Lens' CampaignResponse (Maybe Text)
- cAdditionalTreatments :: Lens' CampaignResponse [TreatmentResource]
- cSegmentVersion :: Lens' CampaignResponse (Maybe Int)
- data CampaignState
- campaignState :: CampaignState
- csCampaignStatus :: Lens' CampaignState (Maybe CampaignStatus)
- data CampaignsResponse
- campaignsResponse :: CampaignsResponse
- cNextToken :: Lens' CampaignsResponse (Maybe Text)
- cItem :: Lens' CampaignsResponse [CampaignResponse]
- data EndpointBatchItem
- endpointBatchItem :: EndpointBatchItem
- ebiRequestId :: Lens' EndpointBatchItem (Maybe Text)
- ebiMetrics :: Lens' EndpointBatchItem (HashMap Text Double)
- ebiLocation :: Lens' EndpointBatchItem (Maybe EndpointLocation)
- ebiDemographic :: Lens' EndpointBatchItem (Maybe EndpointDemographic)
- ebiAddress :: Lens' EndpointBatchItem (Maybe Text)
- ebiEffectiveDate :: Lens' EndpointBatchItem (Maybe Text)
- ebiUser :: Lens' EndpointBatchItem (Maybe EndpointUser)
- ebiAttributes :: Lens' EndpointBatchItem (HashMap Text [Text])
- ebiEndpointStatus :: Lens' EndpointBatchItem (Maybe Text)
- ebiOptOut :: Lens' EndpointBatchItem (Maybe Text)
- ebiId :: Lens' EndpointBatchItem (Maybe Text)
- ebiChannelType :: Lens' EndpointBatchItem (Maybe ChannelType)
- data EndpointBatchRequest
- endpointBatchRequest :: EndpointBatchRequest
- ebrItem :: Lens' EndpointBatchRequest [EndpointBatchItem]
- data EndpointDemographic
- endpointDemographic :: EndpointDemographic
- edPlatform :: Lens' EndpointDemographic (Maybe Text)
- edPlatformVersion :: Lens' EndpointDemographic (Maybe Text)
- edLocale :: Lens' EndpointDemographic (Maybe Text)
- edAppVersion :: Lens' EndpointDemographic (Maybe Text)
- edModel :: Lens' EndpointDemographic (Maybe Text)
- edMake :: Lens' EndpointDemographic (Maybe Text)
- edModelVersion :: Lens' EndpointDemographic (Maybe Text)
- edTimezone :: Lens' EndpointDemographic (Maybe Text)
- data EndpointLocation
- endpointLocation :: EndpointLocation
- elPostalCode :: Lens' EndpointLocation (Maybe Text)
- elLatitude :: Lens' EndpointLocation (Maybe Double)
- elCountry :: Lens' EndpointLocation (Maybe Text)
- elCity :: Lens' EndpointLocation (Maybe Text)
- elRegion :: Lens' EndpointLocation (Maybe Text)
- elLongitude :: Lens' EndpointLocation (Maybe Double)
- data EndpointRequest
- endpointRequest :: EndpointRequest
- erRequestId :: Lens' EndpointRequest (Maybe Text)
- erMetrics :: Lens' EndpointRequest (HashMap Text Double)
- erLocation :: Lens' EndpointRequest (Maybe EndpointLocation)
- erDemographic :: Lens' EndpointRequest (Maybe EndpointDemographic)
- erAddress :: Lens' EndpointRequest (Maybe Text)
- erEffectiveDate :: Lens' EndpointRequest (Maybe Text)
- erUser :: Lens' EndpointRequest (Maybe EndpointUser)
- erAttributes :: Lens' EndpointRequest (HashMap Text [Text])
- erEndpointStatus :: Lens' EndpointRequest (Maybe Text)
- erOptOut :: Lens' EndpointRequest (Maybe Text)
- erChannelType :: Lens' EndpointRequest (Maybe ChannelType)
- data EndpointResponse
- endpointResponse :: EndpointResponse
- eRequestId :: Lens' EndpointResponse (Maybe Text)
- eMetrics :: Lens' EndpointResponse (HashMap Text Double)
- eLocation :: Lens' EndpointResponse (Maybe EndpointLocation)
- eDemographic :: Lens' EndpointResponse (Maybe EndpointDemographic)
- eCohortId :: Lens' EndpointResponse (Maybe Text)
- eAddress :: Lens' EndpointResponse (Maybe Text)
- eEffectiveDate :: Lens' EndpointResponse (Maybe Text)
- eUser :: Lens' EndpointResponse (Maybe EndpointUser)
- eApplicationId :: Lens' EndpointResponse (Maybe Text)
- eAttributes :: Lens' EndpointResponse (HashMap Text [Text])
- eEndpointStatus :: Lens' EndpointResponse (Maybe Text)
- eOptOut :: Lens' EndpointResponse (Maybe Text)
- eId :: Lens' EndpointResponse (Maybe Text)
- eCreationDate :: Lens' EndpointResponse (Maybe Text)
- eChannelType :: Lens' EndpointResponse (Maybe ChannelType)
- eShardId :: Lens' EndpointResponse (Maybe Text)
- data EndpointUser
- endpointUser :: EndpointUser
- euUserAttributes :: Lens' EndpointUser (HashMap Text [Text])
- euUserId :: Lens' EndpointUser (Maybe Text)
- data GCMChannelRequest
- gcmChannelRequest :: GCMChannelRequest
- gcrAPIKey :: Lens' GCMChannelRequest (Maybe Text)
- data GCMChannelResponse
- gcmChannelResponse :: GCMChannelResponse
- gcPlatform :: Lens' GCMChannelResponse (Maybe Text)
- gcLastModifiedDate :: Lens' GCMChannelResponse (Maybe Text)
- gcCredential :: Lens' GCMChannelResponse (Maybe Text)
- gcIsArchived :: Lens' GCMChannelResponse (Maybe Bool)
- gcApplicationId :: Lens' GCMChannelResponse (Maybe Text)
- gcVersion :: Lens' GCMChannelResponse (Maybe Int)
- gcId :: Lens' GCMChannelResponse (Maybe Text)
- gcCreationDate :: Lens' GCMChannelResponse (Maybe Text)
- gcLastModifiedBy :: Lens' GCMChannelResponse (Maybe Text)
- data ImportJobRequest
- importJobRequest :: ImportJobRequest
- iSegmentName :: Lens' ImportJobRequest (Maybe Text)
- iFormat :: Lens' ImportJobRequest (Maybe DefinitionFormat)
- iDefineSegment :: Lens' ImportJobRequest (Maybe Bool)
- iRegisterEndpoints :: Lens' ImportJobRequest (Maybe Bool)
- iExternalId :: Lens' ImportJobRequest (Maybe Text)
- iS3URL :: Lens' ImportJobRequest (Maybe Text)
- iSegmentId :: Lens' ImportJobRequest (Maybe Text)
- iRoleARN :: Lens' ImportJobRequest (Maybe Text)
- data ImportJobResource
- importJobResource :: ImportJobResource
- ijrSegmentName :: Lens' ImportJobResource (Maybe Text)
- ijrFormat :: Lens' ImportJobResource (Maybe DefinitionFormat)
- ijrDefineSegment :: Lens' ImportJobResource (Maybe Bool)
- ijrRegisterEndpoints :: Lens' ImportJobResource (Maybe Bool)
- ijrExternalId :: Lens' ImportJobResource (Maybe Text)
- ijrS3URL :: Lens' ImportJobResource (Maybe Text)
- ijrSegmentId :: Lens' ImportJobResource (Maybe Text)
- ijrRoleARN :: Lens' ImportJobResource (Maybe Text)
- data ImportJobResponse
- importJobResponse :: ImportJobResponse
- ijCompletedPieces :: Lens' ImportJobResponse (Maybe Int)
- ijFailedPieces :: Lens' ImportJobResponse (Maybe Int)
- ijDefinition :: Lens' ImportJobResponse (Maybe ImportJobResource)
- ijTotalProcessed :: Lens' ImportJobResponse (Maybe Int)
- ijFailures :: Lens' ImportJobResponse [Text]
- ijTotalPieces :: Lens' ImportJobResponse (Maybe Int)
- ijApplicationId :: Lens' ImportJobResponse (Maybe Text)
- ijId :: Lens' ImportJobResponse (Maybe Text)
- ijCreationDate :: Lens' ImportJobResponse (Maybe Text)
- ijType :: Lens' ImportJobResponse (Maybe Text)
- ijCompletionDate :: Lens' ImportJobResponse (Maybe Text)
- ijJobStatus :: Lens' ImportJobResponse (Maybe JobStatus)
- ijTotalFailures :: Lens' ImportJobResponse (Maybe Int)
- data ImportJobsResponse
- importJobsResponse :: ImportJobsResponse
- ijNextToken :: Lens' ImportJobsResponse (Maybe Text)
- ijItem :: Lens' ImportJobsResponse [ImportJobResponse]
- data Message
- message :: Message
- mSilentPush :: Lens' Message (Maybe Bool)
- mImageIconURL :: Lens' Message (Maybe Text)
- mBody :: Lens' Message (Maybe Text)
- mJSONBody :: Lens' Message (Maybe Text)
- mURL :: Lens' Message (Maybe Text)
- mAction :: Lens' Message (Maybe Action)
- mImageURL :: Lens' Message (Maybe Text)
- mMediaURL :: Lens' Message (Maybe Text)
- mTitle :: Lens' Message (Maybe Text)
- data MessageBody
- messageBody :: MessageBody
- mbRequestId :: Lens' MessageBody (Maybe Text)
- mbMessage :: Lens' MessageBody (Maybe Text)
- data MessageConfiguration
- messageConfiguration :: MessageConfiguration
- mcAPNSMessage :: Lens' MessageConfiguration (Maybe Message)
- mcGCMMessage :: Lens' MessageConfiguration (Maybe Message)
- mcDefaultMessage :: Lens' MessageConfiguration (Maybe Message)
- data QuietTime
- quietTime :: QuietTime
- qtStart :: Lens' QuietTime (Maybe Text)
- qtEnd :: Lens' QuietTime (Maybe Text)
- data RecencyDimension
- recencyDimension :: RecencyDimension
- rdRecencyType :: Lens' RecencyDimension (Maybe RecencyType)
- rdDuration :: Lens' RecencyDimension (Maybe Duration)
- data Schedule
- schedule :: Schedule
- sFrequency :: Lens' Schedule (Maybe Frequency)
- sStartTime :: Lens' Schedule (Maybe Text)
- sQuietTime :: Lens' Schedule (Maybe QuietTime)
- sIsLocalTime :: Lens' Schedule (Maybe Bool)
- sEndTime :: Lens' Schedule (Maybe Text)
- sTimezone :: Lens' Schedule (Maybe Text)
- data SegmentBehaviors
- segmentBehaviors :: SegmentBehaviors
- sbRecency :: Lens' SegmentBehaviors (Maybe RecencyDimension)
- data SegmentDemographics
- segmentDemographics :: SegmentDemographics
- sdPlatform :: Lens' SegmentDemographics (Maybe SetDimension)
- sdAppVersion :: Lens' SegmentDemographics (Maybe SetDimension)
- sdModel :: Lens' SegmentDemographics (Maybe SetDimension)
- sdMake :: Lens' SegmentDemographics (Maybe SetDimension)
- sdDeviceType :: Lens' SegmentDemographics (Maybe SetDimension)
- data SegmentDimensions
- segmentDimensions :: SegmentDimensions
- sdLocation :: Lens' SegmentDimensions (Maybe SegmentLocation)
- sdDemographic :: Lens' SegmentDimensions (Maybe SegmentDemographics)
- sdBehavior :: Lens' SegmentDimensions (Maybe SegmentBehaviors)
- sdAttributes :: Lens' SegmentDimensions (HashMap Text AttributeDimension)
- data SegmentImportResource
- segmentImportResource :: SegmentImportResource
- sirSize :: Lens' SegmentImportResource (Maybe Int)
- sirFormat :: Lens' SegmentImportResource (Maybe DefinitionFormat)
- sirExternalId :: Lens' SegmentImportResource (Maybe Text)
- sirS3URL :: Lens' SegmentImportResource (Maybe Text)
- sirRoleARN :: Lens' SegmentImportResource (Maybe Text)
- data SegmentLocation
- segmentLocation :: SegmentLocation
- slCountry :: Lens' SegmentLocation (Maybe SetDimension)
- data SegmentResponse
- segmentResponse :: SegmentResponse
- sLastModifiedDate :: Lens' SegmentResponse (Maybe Text)
- sSegmentType :: Lens' SegmentResponse (Maybe SegmentType)
- sApplicationId :: Lens' SegmentResponse (Maybe Text)
- sName :: Lens' SegmentResponse (Maybe Text)
- sVersion :: Lens' SegmentResponse (Maybe Int)
- sId :: Lens' SegmentResponse (Maybe Text)
- sCreationDate :: Lens' SegmentResponse (Maybe Text)
- sImportDefinition :: Lens' SegmentResponse (Maybe SegmentImportResource)
- sDimensions :: Lens' SegmentResponse (Maybe SegmentDimensions)
- data SegmentsResponse
- segmentsResponse :: SegmentsResponse
- sNextToken :: Lens' SegmentsResponse (Maybe Text)
- sItem :: Lens' SegmentsResponse [SegmentResponse]
- data SetDimension
- setDimension :: SetDimension
- sdValues :: Lens' SetDimension [Text]
- sdDimensionType :: Lens' SetDimension (Maybe DimensionType)
- data TreatmentResource
- treatmentResource :: TreatmentResource
- trState :: Lens' TreatmentResource (Maybe CampaignState)
- trSchedule :: Lens' TreatmentResource (Maybe Schedule)
- trTreatmentName :: Lens' TreatmentResource (Maybe Text)
- trSizePercent :: Lens' TreatmentResource (Maybe Int)
- trTreatmentDescription :: Lens' TreatmentResource (Maybe Text)
- trId :: Lens' TreatmentResource (Maybe Text)
- trMessageConfiguration :: Lens' TreatmentResource (Maybe MessageConfiguration)
- data WriteApplicationSettingsRequest
- writeApplicationSettingsRequest :: WriteApplicationSettingsRequest
- wasrLimits :: Lens' WriteApplicationSettingsRequest (Maybe CampaignLimits)
- wasrQuietTime :: Lens' WriteApplicationSettingsRequest (Maybe QuietTime)
- data WriteCampaignRequest
- writeCampaignRequest :: WriteCampaignRequest
- wcrSchedule :: Lens' WriteCampaignRequest (Maybe Schedule)
- wcrTreatmentName :: Lens' WriteCampaignRequest (Maybe Text)
- wcrLimits :: Lens' WriteCampaignRequest (Maybe CampaignLimits)
- wcrIsPaused :: Lens' WriteCampaignRequest (Maybe Bool)
- wcrName :: Lens' WriteCampaignRequest (Maybe Text)
- wcrHoldoutPercent :: Lens' WriteCampaignRequest (Maybe Int)
- wcrTreatmentDescription :: Lens' WriteCampaignRequest (Maybe Text)
- wcrMessageConfiguration :: Lens' WriteCampaignRequest (Maybe MessageConfiguration)
- wcrDescription :: Lens' WriteCampaignRequest (Maybe Text)
- wcrSegmentId :: Lens' WriteCampaignRequest (Maybe Text)
- wcrAdditionalTreatments :: Lens' WriteCampaignRequest [WriteTreatmentResource]
- wcrSegmentVersion :: Lens' WriteCampaignRequest (Maybe Int)
- data WriteSegmentRequest
- writeSegmentRequest :: WriteSegmentRequest
- wsrName :: Lens' WriteSegmentRequest (Maybe Text)
- wsrDimensions :: Lens' WriteSegmentRequest (Maybe SegmentDimensions)
- data WriteTreatmentResource
- writeTreatmentResource :: WriteTreatmentResource
- wtrSchedule :: Lens' WriteTreatmentResource (Maybe Schedule)
- wtrTreatmentName :: Lens' WriteTreatmentResource (Maybe Text)
- wtrSizePercent :: Lens' WriteTreatmentResource (Maybe Int)
- wtrTreatmentDescription :: Lens' WriteTreatmentResource (Maybe Text)
- wtrMessageConfiguration :: Lens' WriteTreatmentResource (Maybe MessageConfiguration)
Service 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
_ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for ForbiddenException' errors.
NotFoundException
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for NotFoundException' errors.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for TooManyRequestsException' errors.
InternalServerErrorException
_InternalServerErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for InternalServerErrorException' errors.
MethodNotAllowedException
_MethodNotAllowedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for MethodNotAllowedException' errors.
BadRequestException
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for BadRequestException' errors.
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
GetImportJob
GetSegmentVersions
DeleteCampaign
UpdateCampaign
GetSegmentVersion
CreateSegment
UpdateEndpoint
CreateCampaign
GetEndpoint
GetSegment
UpdateEndpointsBatch
GetCampaign
UpdateGCMChannel
DeleteGCMChannel
GetCampaignActivities
DeleteAPNSChannel
UpdateAPNSChannel
GetCampaignVersions
GetAPNSChannel
GetImportJobs
GetCampaignVersion
DeleteSegment
UpdateSegment
GetCampaigns
UpdateApplicationSettings
GetSegments
CreateImportJob
GetApplicationSettings
Types
Action
AttributeType
data AttributeType Source #
CampaignStatus
data CampaignStatus Source #
ChannelType
data ChannelType Source #
DefinitionFormat
data DefinitionFormat Source #
DimensionType
data DimensionType Source #
Duration
Frequency
JobStatus
RecencyType
data RecencyType Source #
SegmentType
data SegmentType Source #
APNSChannelRequest
data APNSChannelRequest Source #
See: apnsChannelRequest
smart constructor.
apnsChannelRequest :: APNSChannelRequest Source #
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:
acrPrivateKey
- The certificate private key.acrCertificate
- The distribution certificate from Apple.
acrPrivateKey :: Lens' APNSChannelRequest (Maybe Text) Source #
The certificate private key.
acrCertificate :: Lens' APNSChannelRequest (Maybe Text) Source #
The distribution certificate from Apple.
APNSChannelResponse
data APNSChannelResponse Source #
See: apnsChannelResponse
smart constructor.
apnsChannelResponse :: APNSChannelResponse Source #
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 updatedacIsArchived
- Is this channel archivedacApplicationId
- Undocumented member.acVersion
- Version of channelacId
- Undocumented member.acCreationDate
- When was this segment createdacLastModifiedBy
- Who last updated this entry
acPlatform :: Lens' APNSChannelResponse (Maybe Text) Source #
The platform type. Will be APNS.
acLastModifiedDate :: Lens' APNSChannelResponse (Maybe Text) Source #
Last date this was updated
acIsArchived :: Lens' APNSChannelResponse (Maybe Bool) Source #
Is this channel archived
acApplicationId :: Lens' APNSChannelResponse (Maybe Text) Source #
Undocumented member.
acCreationDate :: Lens' APNSChannelResponse (Maybe Text) Source #
When was this segment created
acLastModifiedBy :: Lens' APNSChannelResponse (Maybe Text) Source #
Who last updated this entry
ActivitiesResponse
data ActivitiesResponse Source #
See: activitiesResponse
smart constructor.
activitiesResponse :: ActivitiesResponse Source #
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] Source #
List of campaign activities
ActivityResponse
data ActivityResponse Source #
See: activityResponse
smart constructor.
activityResponse :: ActivityResponse Source #
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, COMPLETEDaStart
- The actual start time of the activity in ISO 8601 format.aCampaignId
- The ID of the campaign to which the activity applies.aResult
- Indicates whether the activity succeeded. Valid values: SUCCESS, FAILaTreatmentId
- 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) Source #
The state of the activity. Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED
aStart :: Lens' ActivityResponse (Maybe Text) Source #
The actual start time of the activity in ISO 8601 format.
aCampaignId :: Lens' ActivityResponse (Maybe Text) Source #
The ID of the campaign to which the activity applies.
aResult :: Lens' ActivityResponse (Maybe Text) Source #
Indicates whether the activity succeeded. Valid values: SUCCESS, FAIL
aTreatmentId :: Lens' ActivityResponse (Maybe Text) Source #
The ID of a variation of the campaign used for A/B testing.
aSuccessfulEndpointCount :: Lens' ActivityResponse (Maybe Int) Source #
The total number of endpoints to which the campaign successfully delivered messages.
aEnd :: Lens' ActivityResponse (Maybe Text) Source #
The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format.
aApplicationId :: Lens' ActivityResponse (Maybe Text) Source #
The ID of the application to which the campaign applies.
aTotalEndpointCount :: Lens' ActivityResponse (Maybe Int) Source #
The total number of endpoints to which the campaign attempts to deliver messages.
aScheduledStart :: Lens' ActivityResponse (Maybe Text) Source #
The scheduled start time for the activity in ISO 8601 format.
ApplicationSettingsResource
data ApplicationSettingsResource Source #
See: applicationSettingsResource
smart constructor.
applicationSettingsResource :: ApplicationSettingsResource Source #
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.
asrLastModifiedDate :: Lens' ApplicationSettingsResource (Maybe Text) Source #
The date that the settings were last updated in ISO 8601 format.
asrLimits :: Lens' ApplicationSettingsResource (Maybe CampaignLimits) Source #
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) Source #
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) Source #
The unique ID for the application.
AttributeDimension
data AttributeDimension Source #
See: attributeDimension
smart constructor.
attributeDimension :: AttributeDimension Source #
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] Source #
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) Source #
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.
CampaignLimits
data CampaignLimits Source #
See: campaignLimits
smart constructor.
campaignLimits :: CampaignLimits Source #
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:
clDaily :: Lens' CampaignLimits (Maybe Int) Source #
The maximum number of messages that the campaign can send daily.
clTotal :: Lens' CampaignLimits (Maybe Int) Source #
The maximum total number of messages that the campaign can send.
CampaignResponse
data CampaignResponse Source #
See: campaignResponse
smart constructor.
campaignResponse :: CampaignResponse Source #
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.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) Source #
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) Source #
The date the campaign was last updated in ISO 8601 format.
cTreatmentName :: Lens' CampaignResponse (Maybe Text) Source #
The custom name of a variation of the campaign used for A/B testing.
cLimits :: Lens' CampaignResponse (Maybe CampaignLimits) Source #
The campaign limits settings.
cIsPaused :: Lens' CampaignResponse (Maybe Bool) Source #
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) Source #
The status of the campaign's default treatment. Only present for A/B test campaigns.
cApplicationId :: Lens' CampaignResponse (Maybe Text) Source #
The ID of the application to which the campaign applies.
cHoldoutPercent :: Lens' CampaignResponse (Maybe Int) Source #
The allocated percentage of end users who will not receive messages from this campaign.
cTreatmentDescription :: Lens' CampaignResponse (Maybe Text) Source #
A custom description for the treatment.
cCreationDate :: Lens' CampaignResponse (Maybe Text) Source #
The date the campaign was created in ISO 8601 format.
cMessageConfiguration :: Lens' CampaignResponse (Maybe MessageConfiguration) Source #
The message configuration settings.
cDescription :: Lens' CampaignResponse (Maybe Text) Source #
A description of the campaign.
cSegmentId :: Lens' CampaignResponse (Maybe Text) Source #
The ID of the segment to which the campaign sends messages.
cAdditionalTreatments :: Lens' CampaignResponse [TreatmentResource] Source #
Treatments that are defined in addition to the default treatment.
cSegmentVersion :: Lens' CampaignResponse (Maybe Int) Source #
The version of the segment to which the campaign sends messages.
CampaignState
data CampaignState Source #
See: campaignState
smart constructor.
campaignState :: CampaignState Source #
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) Source #
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 Source #
See: campaignsResponse
smart constructor.
campaignsResponse :: CampaignsResponse Source #
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) Source #
The string that you use in a subsequent request to get the next page of results in a paginated response.
cItem :: Lens' CampaignsResponse [CampaignResponse] Source #
A list of campaigns.
EndpointBatchItem
data EndpointBatchItem Source #
See: endpointBatchItem
smart constructor.
endpointBatchItem :: EndpointBatchItem Source #
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.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 your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.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 receives all messages. NONE – User receives no messages.ebiId
- Undocumented member.ebiChannelType
- The channel type. Valid values: APNS, GCM
ebiRequestId :: Lens' EndpointBatchItem (Maybe Text) Source #
The unique ID for the most recent request to update the endpoint.
ebiMetrics :: Lens' EndpointBatchItem (HashMap Text Double) Source #
Custom metrics that your app reports to Amazon Pinpoint.
ebiLocation :: Lens' EndpointBatchItem (Maybe EndpointLocation) Source #
The endpoint location attributes.
ebiDemographic :: Lens' EndpointBatchItem (Maybe EndpointDemographic) Source #
The endpoint demographic attributes.
ebiAddress :: Lens' EndpointBatchItem (Maybe Text) Source #
The address or token of the endpoint.
ebiEffectiveDate :: Lens' EndpointBatchItem (Maybe Text) Source #
The last time the endpoint was updated. Provided in ISO 8601 format.
ebiUser :: Lens' EndpointBatchItem (Maybe EndpointUser) Source #
Custom user-specific attributes that your app reports to Amazon Pinpoint.
ebiAttributes :: Lens' EndpointBatchItem (HashMap Text [Text]) Source #
Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
ebiEndpointStatus :: Lens' EndpointBatchItem (Maybe Text) Source #
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) Source #
Indicates whether a user has opted out of receiving messages with one of the following values: ALL – User receives all messages. NONE – User receives no messages.
ebiChannelType :: Lens' EndpointBatchItem (Maybe ChannelType) Source #
The channel type. Valid values: APNS, GCM
EndpointBatchRequest
data EndpointBatchRequest Source #
See: endpointBatchRequest
smart constructor.
endpointBatchRequest :: EndpointBatchRequest Source #
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] Source #
List of items to update. Maximum 100 items
EndpointDemographic
data EndpointDemographic Source #
See: endpointDemographic
smart constructor.
endpointDemographic :: EndpointDemographic Source #
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) Source #
The endpoint platform, such as ios or android.
edPlatformVersion :: Lens' EndpointDemographic (Maybe Text) Source #
The endpoint platform version.
edLocale :: Lens' EndpointDemographic (Maybe Text) Source #
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) Source #
The version of the application associated with the endpoint.
edMake :: Lens' EndpointDemographic (Maybe Text) Source #
The endpoint make, such as such as Apple or Samsung.
edModelVersion :: Lens' EndpointDemographic (Maybe Text) Source #
The endpoint model version.
edTimezone :: Lens' EndpointDemographic (Maybe Text) Source #
The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
EndpointLocation
data EndpointLocation Source #
See: endpointLocation
smart constructor.
endpointLocation :: EndpointLocation Source #
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) Source #
The postal code or zip code of the endpoint.
elLatitude :: Lens' EndpointLocation (Maybe Double) Source #
The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
elCountry :: Lens' EndpointLocation (Maybe Text) Source #
Country according to ISO 3166-1 Alpha-2 codes. For example, US.
elRegion :: Lens' EndpointLocation (Maybe Text) Source #
The region of the endpoint location. For example, corresponds to a state in US.
elLongitude :: Lens' EndpointLocation (Maybe Double) Source #
The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile).
EndpointRequest
data EndpointRequest Source #
See: endpointRequest
smart constructor.
endpointRequest :: EndpointRequest Source #
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.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 your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.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 receives all messages. NONE – User receives no messages.erChannelType
- The channel type. Valid values: APNS, GCM
erRequestId :: Lens' EndpointRequest (Maybe Text) Source #
The unique ID for the most recent request to update the endpoint.
erMetrics :: Lens' EndpointRequest (HashMap Text Double) Source #
Custom metrics that your app reports to Amazon Pinpoint.
erLocation :: Lens' EndpointRequest (Maybe EndpointLocation) Source #
The endpoint location attributes.
erDemographic :: Lens' EndpointRequest (Maybe EndpointDemographic) Source #
The endpoint demographic attributes.
erEffectiveDate :: Lens' EndpointRequest (Maybe Text) Source #
The last time the endpoint was updated. Provided in ISO 8601 format.
erUser :: Lens' EndpointRequest (Maybe EndpointUser) Source #
Custom user-specific attributes that your app reports to Amazon Pinpoint.
erAttributes :: Lens' EndpointRequest (HashMap Text [Text]) Source #
Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
erEndpointStatus :: Lens' EndpointRequest (Maybe Text) Source #
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) Source #
Indicates whether a user has opted out of receiving messages with one of the following values: ALL – User receives all messages. NONE – User receives no messages.
erChannelType :: Lens' EndpointRequest (Maybe ChannelType) Source #
The channel type. Valid values: APNS, GCM
EndpointResponse
data EndpointResponse Source #
See: endpointResponse
smart constructor.
endpointResponse :: EndpointResponse Source #
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.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 your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.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 receives all messages. NONE – User receives no 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: APNS, GCMeShardId
- The ShardId of endpoint
eRequestId :: Lens' EndpointResponse (Maybe Text) Source #
The unique ID for the most recent request to update the endpoint.
eMetrics :: Lens' EndpointResponse (HashMap Text Double) Source #
Custom metrics that your app reports to Amazon Pinpoint.
eLocation :: Lens' EndpointResponse (Maybe EndpointLocation) Source #
The endpoint location attributes.
eDemographic :: Lens' EndpointResponse (Maybe EndpointDemographic) Source #
The endpoint demographic attributes.
eCohortId :: Lens' EndpointResponse (Maybe Text) Source #
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.
eEffectiveDate :: Lens' EndpointResponse (Maybe Text) Source #
The last time the endpoint was updated. Provided in ISO 8601 format.
eUser :: Lens' EndpointResponse (Maybe EndpointUser) Source #
Custom user-specific attributes that your app reports to Amazon Pinpoint.
eApplicationId :: Lens' EndpointResponse (Maybe Text) Source #
The ID of the application associated with the endpoint.
eAttributes :: Lens' EndpointResponse (HashMap Text [Text]) Source #
Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
eEndpointStatus :: Lens' EndpointResponse (Maybe Text) Source #
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) Source #
Indicates whether a user has opted out of receiving messages with one of the following values: ALL – User receives all messages. NONE – User receives no messages.
eId :: Lens' EndpointResponse (Maybe Text) Source #
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) Source #
The last time the endpoint was created. Provided in ISO 8601 format.
eChannelType :: Lens' EndpointResponse (Maybe ChannelType) Source #
The channel type. Valid values: APNS, GCM
EndpointUser
data EndpointUser Source #
See: endpointUser
smart constructor.
endpointUser :: EndpointUser Source #
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 attributesd specific to the user.euUserId
- The unique ID of the user.
euUserAttributes :: Lens' EndpointUser (HashMap Text [Text]) Source #
Custom attributesd specific to the user.
GCMChannelRequest
data GCMChannelRequest Source #
See: gcmChannelRequest
smart constructor.
gcmChannelRequest :: GCMChannelRequest Source #
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.
GCMChannelResponse
data GCMChannelResponse Source #
See: gcmChannelResponse
smart constructor.
gcmChannelResponse :: GCMChannelResponse Source #
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 GCMgcLastModifiedDate
- Last date this was updatedgcCredential
- The GCM API key from Google.gcIsArchived
- Is this channel archivedgcApplicationId
- Undocumented member.gcVersion
- Version of channelgcId
- Undocumented member.gcCreationDate
- When was this segment createdgcLastModifiedBy
- Who last updated this entry
gcPlatform :: Lens' GCMChannelResponse (Maybe Text) Source #
The platform type. Will be GCM
gcLastModifiedDate :: Lens' GCMChannelResponse (Maybe Text) Source #
Last date this was updated
gcCredential :: Lens' GCMChannelResponse (Maybe Text) Source #
The GCM API key from Google.
gcIsArchived :: Lens' GCMChannelResponse (Maybe Bool) Source #
Is this channel archived
gcApplicationId :: Lens' GCMChannelResponse (Maybe Text) Source #
Undocumented member.
gcCreationDate :: Lens' GCMChannelResponse (Maybe Text) Source #
When was this segment created
gcLastModifiedBy :: Lens' GCMChannelResponse (Maybe Text) Source #
Who last updated this entry
ImportJobRequest
data ImportJobRequest Source #
See: importJobRequest
smart constructor.
importJobRequest :: ImportJobRequest Source #
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, JSONiDefineSegment
- 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
- A unique, custom ID assigned to the IAM role that restricts who can assume the role.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) Source #
A custom name for the segment created by the import job. Use if DefineSegment is true.
iFormat :: Lens' ImportJobRequest (Maybe DefinitionFormat) Source #
The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
iDefineSegment :: Lens' ImportJobRequest (Maybe Bool) Source #
Sets whether the endpoints create a segment when they are imported.
iRegisterEndpoints :: Lens' ImportJobRequest (Maybe Bool) Source #
Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
iExternalId :: Lens' ImportJobRequest (Maybe Text) Source #
A unique, custom ID assigned to the IAM role that restricts who can assume the role.
iS3URL :: Lens' ImportJobRequest (Maybe Text) Source #
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) Source #
The ID of the segment to update if the import job is meant to update an existing segment.
iRoleARN :: Lens' ImportJobRequest (Maybe Text) Source #
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 Source #
See: importJobResource
smart constructor.
importJobResource :: ImportJobResource Source #
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, JSONijrDefineSegment
- 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
- A unique, custom ID assigned to the IAM role that restricts who can assume the role.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) Source #
A custom name for the segment created by the import job. Use if DefineSegment is true.
ijrFormat :: Lens' ImportJobResource (Maybe DefinitionFormat) Source #
The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
ijrDefineSegment :: Lens' ImportJobResource (Maybe Bool) Source #
Sets whether the endpoints create a segment when they are imported.
ijrRegisterEndpoints :: Lens' ImportJobResource (Maybe Bool) Source #
Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
ijrExternalId :: Lens' ImportJobResource (Maybe Text) Source #
A unique, custom ID assigned to the IAM role that restricts who can assume the role.
ijrS3URL :: Lens' ImportJobResource (Maybe Text) Source #
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) Source #
The ID of the segment to update if the import job is meant to update an existing segment.
ijrRoleARN :: Lens' ImportJobResource (Maybe Text) Source #
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 Source #
See: importJobResponse
smart constructor.
importJobResponse :: ImportJobResponse Source #
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) Source #
The number of pieces that have successfully imported as of the time of the request.
ijFailedPieces :: Lens' ImportJobResponse (Maybe Int) Source #
The number of pieces that have failed to import as of the time of the request.
ijDefinition :: Lens' ImportJobResponse (Maybe ImportJobResource) Source #
The import job settings.
ijTotalProcessed :: Lens' ImportJobResponse (Maybe Int) Source #
The number of endpoints that were processed by the import job.
ijFailures :: Lens' ImportJobResponse [Text] Source #
Provides up to 100 of the first failed entries for the job, if any exist.
ijTotalPieces :: Lens' ImportJobResponse (Maybe Int) Source #
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) Source #
The unique ID of the application to which the import job applies.
ijCreationDate :: Lens' ImportJobResponse (Maybe Text) Source #
The date the import job was created in ISO 8601 format.
ijCompletionDate :: Lens' ImportJobResponse (Maybe Text) Source #
The date the import job completed in ISO 8601 format.
ijJobStatus :: Lens' ImportJobResponse (Maybe JobStatus) Source #
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) Source #
The number of endpoints that failed to import; for example, because of syntax errors.
ImportJobsResponse
data ImportJobsResponse Source #
See: importJobsResponse
smart constructor.
importJobsResponse :: ImportJobsResponse Source #
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) Source #
The string that you use in a subsequent request to get the next page of results in a paginated response.
ijItem :: Lens' ImportJobsResponse [ImportJobResponse] Source #
A list of import jobs for the application.
Message
See: message
smart constructor.
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.mBody
- The message body. Can include up to 140 characters.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) Source #
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) Source #
The URL that points to the icon image for the push notification icon, for example, the app icon.
mURL :: Lens' Message (Maybe Text) Source #
The URL to open in the user's mobile browser. Used if the value for Action is URL.
mAction :: Lens' Message (Maybe Action) Source #
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) Source #
The URL that points to an image used in the push notification.
mMediaURL :: Lens' Message (Maybe Text) Source #
The URL that points to the media resource, for example a .mp4 or .gif file.
mTitle :: Lens' Message (Maybe Text) Source #
The message title that displays above the message on the user's device.
MessageBody
data MessageBody Source #
See: messageBody
smart constructor.
messageBody :: MessageBody Source #
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
- Undocumented member.mbMessage
- Undocumented member.
mbRequestId :: Lens' MessageBody (Maybe Text) Source #
Undocumented member.
MessageConfiguration
data MessageConfiguration Source #
See: messageConfiguration
smart constructor.
messageConfiguration :: MessageConfiguration Source #
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.
mcAPNSMessage :: Lens' MessageConfiguration (Maybe Message) Source #
The message that the campaign delivers to APNS channels. Overrides the default message.
mcGCMMessage :: Lens' MessageConfiguration (Maybe Message) Source #
The message that the campaign delivers to GCM channels. Overrides the default message.
mcDefaultMessage :: Lens' MessageConfiguration (Maybe Message) Source #
The default message for all channels.
QuietTime
See: quietTime
smart constructor.
qtStart :: Lens' QuietTime (Maybe Text) Source #
The default start time for quiet time in ISO 8601 format.
qtEnd :: Lens' QuietTime (Maybe Text) Source #
The default end time for quiet time in ISO 8601 format.
RecencyDimension
data RecencyDimension Source #
See: recencyDimension
smart constructor.
recencyDimension :: RecencyDimension Source #
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) Source #
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) Source #
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
Schedule
See: schedule
smart constructor.
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, MONTHLYsStartTime
- 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) Source #
How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
sStartTime :: Lens' Schedule (Maybe Text) Source #
The scheduled time that the campaign begins in ISO 8601 format.
sQuietTime :: Lens' Schedule (Maybe QuietTime) Source #
The time during which the campaign sends no messages.
sIsLocalTime :: Lens' Schedule (Maybe Bool) Source #
Indicates whether the campaign schedule takes effect according to each user's local time.
sEndTime :: Lens' Schedule (Maybe Text) Source #
The scheduled time that the campaign ends in ISO 8601 format.
sTimezone :: Lens' Schedule (Maybe Text) Source #
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 Source #
See: segmentBehaviors
smart constructor.
segmentBehaviors :: SegmentBehaviors Source #
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:
sbRecency
- The recency of use.
sbRecency :: Lens' SegmentBehaviors (Maybe RecencyDimension) Source #
The recency of use.
SegmentDemographics
data SegmentDemographics Source #
See: segmentDemographics
smart constructor.
segmentDemographics :: SegmentDemographics Source #
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.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) Source #
The device platform criteria for the segment.
sdAppVersion :: Lens' SegmentDemographics (Maybe SetDimension) Source #
The app version criteria for the segment.
sdModel :: Lens' SegmentDemographics (Maybe SetDimension) Source #
The device model criteria for the segment.
sdMake :: Lens' SegmentDemographics (Maybe SetDimension) Source #
The device make criteria for the segment.
sdDeviceType :: Lens' SegmentDemographics (Maybe SetDimension) Source #
The device type criteria for the segment.
SegmentDimensions
data SegmentDimensions Source #
See: segmentDimensions
smart constructor.
segmentDimensions :: SegmentDimensions Source #
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
- The segment location attributes.sdDemographic
- The segment demographics attributes.sdBehavior
- The segment behaviors attributes.sdAttributes
- Custom segment attributes.
sdLocation :: Lens' SegmentDimensions (Maybe SegmentLocation) Source #
The segment location attributes.
sdDemographic :: Lens' SegmentDimensions (Maybe SegmentDemographics) Source #
The segment demographics attributes.
sdBehavior :: Lens' SegmentDimensions (Maybe SegmentBehaviors) Source #
The segment behaviors attributes.
sdAttributes :: Lens' SegmentDimensions (HashMap Text AttributeDimension) Source #
Custom segment attributes.
SegmentImportResource
data SegmentImportResource Source #
See: segmentImportResource
smart constructor.
segmentImportResource :: SegmentImportResource Source #
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, JSONsirExternalId
- A unique, custom ID assigned to the IAM role that restricts who can assume the role.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) Source #
The number of endpoints that were successfully imported to create this segment.
sirFormat :: Lens' SegmentImportResource (Maybe DefinitionFormat) Source #
The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
sirExternalId :: Lens' SegmentImportResource (Maybe Text) Source #
A unique, custom ID assigned to the IAM role that restricts who can assume the role.
sirS3URL :: Lens' SegmentImportResource (Maybe Text) Source #
A URL that points to the Amazon S3 location from which the endpoints for this segment were imported.
sirRoleARN :: Lens' SegmentImportResource (Maybe Text) Source #
The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
SegmentLocation
data SegmentLocation Source #
See: segmentLocation
smart constructor.
segmentLocation :: SegmentLocation Source #
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) Source #
The country filter according to ISO 3166-1 Alpha-2 codes.
SegmentResponse
data SegmentResponse Source #
See: segmentResponse
smart constructor.
segmentResponse :: SegmentResponse Source #
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 segmentsVersion
- 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) Source #
The date the segment was last updated in ISO 8601 format.
sSegmentType :: Lens' SegmentResponse (Maybe SegmentType) Source #
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) Source #
The ID of the application to which the segment applies.
sCreationDate :: Lens' SegmentResponse (Maybe Text) Source #
The date the segment was created in ISO 8601 format.
sImportDefinition :: Lens' SegmentResponse (Maybe SegmentImportResource) Source #
The import job settings.
sDimensions :: Lens' SegmentResponse (Maybe SegmentDimensions) Source #
The segment dimensions attributes.
SegmentsResponse
data SegmentsResponse Source #
See: segmentsResponse
smart constructor.
segmentsResponse :: SegmentsResponse Source #
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) Source #
An identifier used to retrieve the next page of results. The token is null if no additional pages exist.
sItem :: Lens' SegmentsResponse [SegmentResponse] Source #
The list of segments.
SetDimension
data SetDimension Source #
See: setDimension
smart constructor.
setDimension :: SetDimension Source #
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] Source #
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) Source #
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 Source #
See: treatmentResource
smart constructor.
treatmentResource :: TreatmentResource Source #
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:
trState
- The treatment status.trSchedule
- The campaign schedule.trTreatmentName
- The custom name of a variation of the campaign used for A/B testing.trSizePercent
- The allocated percentage of users for this treatment.trTreatmentDescription
- A custom description for the treatment.trId
- The unique treatment ID.trMessageConfiguration
- The message configuration settings.
trState :: Lens' TreatmentResource (Maybe CampaignState) Source #
The treatment status.
trSchedule :: Lens' TreatmentResource (Maybe Schedule) Source #
The campaign schedule.
trTreatmentName :: Lens' TreatmentResource (Maybe Text) Source #
The custom name of a variation of the campaign used for A/B testing.
trSizePercent :: Lens' TreatmentResource (Maybe Int) Source #
The allocated percentage of users for this treatment.
trTreatmentDescription :: Lens' TreatmentResource (Maybe Text) Source #
A custom description for the treatment.
trMessageConfiguration :: Lens' TreatmentResource (Maybe MessageConfiguration) Source #
The message configuration settings.
WriteApplicationSettingsRequest
data WriteApplicationSettingsRequest Source #
See: writeApplicationSettingsRequest
smart constructor.
writeApplicationSettingsRequest :: WriteApplicationSettingsRequest Source #
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.
wasrLimits :: Lens' WriteApplicationSettingsRequest (Maybe CampaignLimits) Source #
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) Source #
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 Source #
See: writeCampaignRequest
smart constructor.
writeCampaignRequest :: WriteCampaignRequest Source #
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:
wcrSchedule
- The campaign schedule.wcrTreatmentName
- The custom name of a variation of the campaign used for A/B testing.wcrLimits
- The campaign limits settings.wcrIsPaused
- Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.wcrName
- The custom name of the campaign.wcrHoldoutPercent
- The allocated percentage of end users who will not receive messages from this campaign.wcrTreatmentDescription
- A custom description for the treatment.wcrMessageConfiguration
- The message configuration settings.wcrDescription
- A description of the campaign.wcrSegmentId
- The ID of the segment to which the campaign sends messages.wcrAdditionalTreatments
- Treatments that are defined in addition to the default treatment.wcrSegmentVersion
- The version of the segment to which the campaign sends messages.
wcrSchedule :: Lens' WriteCampaignRequest (Maybe Schedule) Source #
The campaign schedule.
wcrTreatmentName :: Lens' WriteCampaignRequest (Maybe Text) Source #
The custom name of a variation of the campaign used for A/B testing.
wcrLimits :: Lens' WriteCampaignRequest (Maybe CampaignLimits) Source #
The campaign limits settings.
wcrIsPaused :: Lens' WriteCampaignRequest (Maybe Bool) Source #
Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
wcrHoldoutPercent :: Lens' WriteCampaignRequest (Maybe Int) Source #
The allocated percentage of end users who will not receive messages from this campaign.
wcrTreatmentDescription :: Lens' WriteCampaignRequest (Maybe Text) Source #
A custom description for the treatment.
wcrMessageConfiguration :: Lens' WriteCampaignRequest (Maybe MessageConfiguration) Source #
The message configuration settings.
wcrDescription :: Lens' WriteCampaignRequest (Maybe Text) Source #
A description of the campaign.
wcrSegmentId :: Lens' WriteCampaignRequest (Maybe Text) Source #
The ID of the segment to which the campaign sends messages.
wcrAdditionalTreatments :: Lens' WriteCampaignRequest [WriteTreatmentResource] Source #
Treatments that are defined in addition to the default treatment.
wcrSegmentVersion :: Lens' WriteCampaignRequest (Maybe Int) Source #
The version of the segment to which the campaign sends messages.
WriteSegmentRequest
data WriteSegmentRequest Source #
See: writeSegmentRequest
smart constructor.
writeSegmentRequest :: WriteSegmentRequest Source #
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
- The name of segmentwsrDimensions
- The segment dimensions attributes.
wsrDimensions :: Lens' WriteSegmentRequest (Maybe SegmentDimensions) Source #
The segment dimensions attributes.
WriteTreatmentResource
data WriteTreatmentResource Source #
See: writeTreatmentResource
smart constructor.
writeTreatmentResource :: WriteTreatmentResource Source #
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:
wtrSchedule
- The campaign schedule.wtrTreatmentName
- The custom name of a variation of the campaign used for A/B testing.wtrSizePercent
- The allocated percentage of users for this treatment.wtrTreatmentDescription
- A custom description for the treatment.wtrMessageConfiguration
- The message configuration settings.
wtrSchedule :: Lens' WriteTreatmentResource (Maybe Schedule) Source #
The campaign schedule.
wtrTreatmentName :: Lens' WriteTreatmentResource (Maybe Text) Source #
The custom name of a variation of the campaign used for A/B testing.
wtrSizePercent :: Lens' WriteTreatmentResource (Maybe Int) Source #
The allocated percentage of users for this treatment.
wtrTreatmentDescription :: Lens' WriteTreatmentResource (Maybe Text) Source #
A custom description for the treatment.
wtrMessageConfiguration :: Lens' WriteTreatmentResource (Maybe MessageConfiguration) Source #
The message configuration settings.