| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.Pinpoint.Types
Contents
- Service Configuration
- Errors
- Action
- AttributeType
- CampaignStatus
- ChannelType
- DefinitionFormat
- DeliveryStatus
- DimensionType
- Duration
- Frequency
- JobStatus
- MessageType
- Mode
- RecencyType
- SegmentType
- ADMChannelRequest
- ADMChannelResponse
- ADMMessage
- APNSChannelRequest
- APNSChannelResponse
- APNSMessage
- APNSSandboxChannelRequest
- APNSSandboxChannelResponse
- APNSVoipChannelRequest
- APNSVoipChannelResponse
- APNSVoipSandboxChannelRequest
- APNSVoipSandboxChannelResponse
- ActivitiesResponse
- ActivityResponse
- AddressConfiguration
- ApplicationResponse
- ApplicationSettingsResource
- ApplicationsResponse
- AttributeDimension
- BaiduChannelRequest
- BaiduChannelResponse
- BaiduMessage
- CampaignEmailMessage
- CampaignHook
- CampaignLimits
- CampaignResponse
- CampaignSmsMessage
- CampaignState
- CampaignsResponse
- CreateApplicationRequest
- DefaultMessage
- DefaultPushNotificationMessage
- DirectMessageConfiguration
- EmailChannelRequest
- EmailChannelResponse
- EndpointBatchItem
- EndpointBatchRequest
- EndpointDemographic
- EndpointLocation
- EndpointMessageResult
- EndpointRequest
- EndpointResponse
- EndpointSendConfiguration
- EndpointUser
- EventStream
- ExportJobRequest
- ExportJobResource
- ExportJobResponse
- ExportJobsResponse
- GCMChannelRequest
- GCMChannelResponse
- GCMMessage
- ImportJobRequest
- ImportJobResource
- ImportJobResponse
- ImportJobsResponse
- Message
- MessageBody
- MessageConfiguration
- MessageRequest
- MessageResponse
- MessageResult
- QuietTime
- RecencyDimension
- SMSChannelRequest
- SMSChannelResponse
- SMSMessage
- Schedule
- SegmentBehaviors
- SegmentDemographics
- SegmentDimensions
- SegmentImportResource
- SegmentLocation
- SegmentResponse
- SegmentsResponse
- SendUsersMessageRequest
- SendUsersMessageResponse
- SetDimension
- TreatmentResource
- WriteApplicationSettingsRequest
- WriteCampaignRequest
- WriteEventStream
- WriteSegmentRequest
- WriteTreatmentResource
Description
Synopsis
- 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
- data Action
- data AttributeType
- data CampaignStatus
- data ChannelType
- = ADM
- | APNS
- | APNSSandbox
- | APNSVoip
- | APNSVoipSandbox
- | Baidu
- | Custom
- | GCM
- | Sms
- data DefinitionFormat
- data DeliveryStatus
- data DimensionType
- data Duration
- data Frequency
- data JobStatus
- data MessageType
- data Mode
- data RecencyType
- data SegmentType
- data ADMChannelRequest
- aDMChannelRequest :: ADMChannelRequest
- admcrClientId :: Lens' ADMChannelRequest (Maybe Text)
- admcrClientSecret :: Lens' ADMChannelRequest (Maybe Text)
- admcrEnabled :: Lens' ADMChannelRequest (Maybe Bool)
- data ADMChannelResponse
- aDMChannelResponse :: ADMChannelResponse
- admcPlatform :: Lens' ADMChannelResponse (Maybe Text)
- admcLastModifiedDate :: Lens' ADMChannelResponse (Maybe Text)
- admcEnabled :: Lens' ADMChannelResponse (Maybe Bool)
- admcIsArchived :: Lens' ADMChannelResponse (Maybe Bool)
- admcApplicationId :: Lens' ADMChannelResponse (Maybe Text)
- admcVersion :: Lens' ADMChannelResponse (Maybe Int)
- admcId :: Lens' ADMChannelResponse (Maybe Text)
- admcCreationDate :: Lens' ADMChannelResponse (Maybe Text)
- admcLastModifiedBy :: Lens' ADMChannelResponse (Maybe Text)
- admcHasCredential :: Lens' ADMChannelResponse (Maybe Bool)
- data ADMMessage
- aDMMessage :: ADMMessage
- admmSubstitutions :: Lens' ADMMessage (HashMap Text [Text])
- admmExpiresAfter :: Lens' ADMMessage (Maybe Text)
- admmMD5 :: Lens' ADMMessage (Maybe Text)
- admmSilentPush :: Lens' ADMMessage (Maybe Bool)
- admmImageIconURL :: Lens' ADMMessage (Maybe Text)
- admmRawContent :: Lens' ADMMessage (Maybe Text)
- admmData :: Lens' ADMMessage (HashMap Text Text)
- admmSmallImageIconURL :: Lens' ADMMessage (Maybe Text)
- admmBody :: Lens' ADMMessage (Maybe Text)
- admmURL :: Lens' ADMMessage (Maybe Text)
- admmSound :: Lens' ADMMessage (Maybe Text)
- admmAction :: Lens' ADMMessage (Maybe Action)
- admmImageURL :: Lens' ADMMessage (Maybe Text)
- admmConsolidationKey :: Lens' ADMMessage (Maybe Text)
- admmTitle :: Lens' ADMMessage (Maybe Text)
- admmIconReference :: Lens' ADMMessage (Maybe Text)
- data APNSChannelRequest
- apnsChannelRequest :: APNSChannelRequest
- acrTokenKey :: Lens' APNSChannelRequest (Maybe Text)
- acrPrivateKey :: Lens' APNSChannelRequest (Maybe Text)
- acrEnabled :: Lens' APNSChannelRequest (Maybe Bool)
- acrTeamId :: Lens' APNSChannelRequest (Maybe Text)
- acrBundleId :: Lens' APNSChannelRequest (Maybe Text)
- acrDefaultAuthenticationMethod :: Lens' APNSChannelRequest (Maybe Text)
- acrCertificate :: Lens' APNSChannelRequest (Maybe Text)
- acrTokenKeyId :: Lens' APNSChannelRequest (Maybe Text)
- data APNSChannelResponse
- apnsChannelResponse :: APNSChannelResponse
- acPlatform :: Lens' APNSChannelResponse (Maybe Text)
- acLastModifiedDate :: Lens' APNSChannelResponse (Maybe Text)
- acEnabled :: Lens' APNSChannelResponse (Maybe Bool)
- acHasTokenKey :: Lens' APNSChannelResponse (Maybe Bool)
- acDefaultAuthenticationMethod :: 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)
- acHasCredential :: Lens' APNSChannelResponse (Maybe Bool)
- data APNSMessage
- apnsMessage :: APNSMessage
- amSubstitutions :: Lens' APNSMessage (HashMap Text [Text])
- amSilentPush :: Lens' APNSMessage (Maybe Bool)
- amPriority :: Lens' APNSMessage (Maybe Text)
- amRawContent :: Lens' APNSMessage (Maybe Text)
- amData :: Lens' APNSMessage (HashMap Text Text)
- amBody :: Lens' APNSMessage (Maybe Text)
- amCategory :: Lens' APNSMessage (Maybe Text)
- amTimeToLive :: Lens' APNSMessage (Maybe Int)
- amURL :: Lens' APNSMessage (Maybe Text)
- amSound :: Lens' APNSMessage (Maybe Text)
- amAction :: Lens' APNSMessage (Maybe Action)
- amMediaURL :: Lens' APNSMessage (Maybe Text)
- amPreferredAuthenticationMethod :: Lens' APNSMessage (Maybe Text)
- amBadge :: Lens' APNSMessage (Maybe Int)
- amTitle :: Lens' APNSMessage (Maybe Text)
- amThreadId :: Lens' APNSMessage (Maybe Text)
- amCollapseId :: Lens' APNSMessage (Maybe Text)
- data APNSSandboxChannelRequest
- apnsSandboxChannelRequest :: APNSSandboxChannelRequest
- ascrTokenKey :: Lens' APNSSandboxChannelRequest (Maybe Text)
- ascrPrivateKey :: Lens' APNSSandboxChannelRequest (Maybe Text)
- ascrEnabled :: Lens' APNSSandboxChannelRequest (Maybe Bool)
- ascrTeamId :: Lens' APNSSandboxChannelRequest (Maybe Text)
- ascrBundleId :: Lens' APNSSandboxChannelRequest (Maybe Text)
- ascrDefaultAuthenticationMethod :: Lens' APNSSandboxChannelRequest (Maybe Text)
- ascrCertificate :: Lens' APNSSandboxChannelRequest (Maybe Text)
- ascrTokenKeyId :: Lens' APNSSandboxChannelRequest (Maybe Text)
- data APNSSandboxChannelResponse
- apnsSandboxChannelResponse :: APNSSandboxChannelResponse
- ascPlatform :: Lens' APNSSandboxChannelResponse (Maybe Text)
- ascLastModifiedDate :: Lens' APNSSandboxChannelResponse (Maybe Text)
- ascEnabled :: Lens' APNSSandboxChannelResponse (Maybe Bool)
- ascHasTokenKey :: Lens' APNSSandboxChannelResponse (Maybe Bool)
- ascDefaultAuthenticationMethod :: Lens' APNSSandboxChannelResponse (Maybe Text)
- ascIsArchived :: Lens' APNSSandboxChannelResponse (Maybe Bool)
- ascApplicationId :: Lens' APNSSandboxChannelResponse (Maybe Text)
- ascVersion :: Lens' APNSSandboxChannelResponse (Maybe Int)
- ascId :: Lens' APNSSandboxChannelResponse (Maybe Text)
- ascCreationDate :: Lens' APNSSandboxChannelResponse (Maybe Text)
- ascLastModifiedBy :: Lens' APNSSandboxChannelResponse (Maybe Text)
- ascHasCredential :: Lens' APNSSandboxChannelResponse (Maybe Bool)
- data APNSVoipChannelRequest
- apnsVoipChannelRequest :: APNSVoipChannelRequest
- avcrTokenKey :: Lens' APNSVoipChannelRequest (Maybe Text)
- avcrPrivateKey :: Lens' APNSVoipChannelRequest (Maybe Text)
- avcrEnabled :: Lens' APNSVoipChannelRequest (Maybe Bool)
- avcrTeamId :: Lens' APNSVoipChannelRequest (Maybe Text)
- avcrBundleId :: Lens' APNSVoipChannelRequest (Maybe Text)
- avcrDefaultAuthenticationMethod :: Lens' APNSVoipChannelRequest (Maybe Text)
- avcrCertificate :: Lens' APNSVoipChannelRequest (Maybe Text)
- avcrTokenKeyId :: Lens' APNSVoipChannelRequest (Maybe Text)
- data APNSVoipChannelResponse
- apnsVoipChannelResponse :: APNSVoipChannelResponse
- avcPlatform :: Lens' APNSVoipChannelResponse (Maybe Text)
- avcLastModifiedDate :: Lens' APNSVoipChannelResponse (Maybe Text)
- avcEnabled :: Lens' APNSVoipChannelResponse (Maybe Bool)
- avcHasTokenKey :: Lens' APNSVoipChannelResponse (Maybe Bool)
- avcDefaultAuthenticationMethod :: Lens' APNSVoipChannelResponse (Maybe Text)
- avcIsArchived :: Lens' APNSVoipChannelResponse (Maybe Bool)
- avcApplicationId :: Lens' APNSVoipChannelResponse (Maybe Text)
- avcVersion :: Lens' APNSVoipChannelResponse (Maybe Int)
- avcId :: Lens' APNSVoipChannelResponse (Maybe Text)
- avcCreationDate :: Lens' APNSVoipChannelResponse (Maybe Text)
- avcLastModifiedBy :: Lens' APNSVoipChannelResponse (Maybe Text)
- avcHasCredential :: Lens' APNSVoipChannelResponse (Maybe Bool)
- data APNSVoipSandboxChannelRequest
- apnsVoipSandboxChannelRequest :: APNSVoipSandboxChannelRequest
- avscrTokenKey :: Lens' APNSVoipSandboxChannelRequest (Maybe Text)
- avscrPrivateKey :: Lens' APNSVoipSandboxChannelRequest (Maybe Text)
- avscrEnabled :: Lens' APNSVoipSandboxChannelRequest (Maybe Bool)
- avscrTeamId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text)
- avscrBundleId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text)
- avscrDefaultAuthenticationMethod :: Lens' APNSVoipSandboxChannelRequest (Maybe Text)
- avscrCertificate :: Lens' APNSVoipSandboxChannelRequest (Maybe Text)
- avscrTokenKeyId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text)
- data APNSVoipSandboxChannelResponse
- apnsVoipSandboxChannelResponse :: APNSVoipSandboxChannelResponse
- avscPlatform :: Lens' APNSVoipSandboxChannelResponse (Maybe Text)
- avscLastModifiedDate :: Lens' APNSVoipSandboxChannelResponse (Maybe Text)
- avscEnabled :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool)
- avscHasTokenKey :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool)
- avscDefaultAuthenticationMethod :: Lens' APNSVoipSandboxChannelResponse (Maybe Text)
- avscIsArchived :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool)
- avscApplicationId :: Lens' APNSVoipSandboxChannelResponse (Maybe Text)
- avscVersion :: Lens' APNSVoipSandboxChannelResponse (Maybe Int)
- avscId :: Lens' APNSVoipSandboxChannelResponse (Maybe Text)
- avscCreationDate :: Lens' APNSVoipSandboxChannelResponse (Maybe Text)
- avscLastModifiedBy :: Lens' APNSVoipSandboxChannelResponse (Maybe Text)
- avscHasCredential :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool)
- 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)
- aTimezonesCompletedCount :: Lens' ActivityResponse (Maybe Int)
- aTimezonesTotalCount :: Lens' ActivityResponse (Maybe Int)
- 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 AddressConfiguration
- addressConfiguration :: AddressConfiguration
- acSubstitutions :: Lens' AddressConfiguration (HashMap Text [Text])
- acTitleOverride :: Lens' AddressConfiguration (Maybe Text)
- acContext :: Lens' AddressConfiguration (HashMap Text Text)
- acRawContent :: Lens' AddressConfiguration (Maybe Text)
- acBodyOverride :: Lens' AddressConfiguration (Maybe Text)
- acChannelType :: Lens' AddressConfiguration (Maybe ChannelType)
- data ApplicationResponse
- applicationResponse :: ApplicationResponse
- appName :: Lens' ApplicationResponse (Maybe Text)
- appId :: Lens' ApplicationResponse (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)
- asrCampaignHook :: Lens' ApplicationSettingsResource (Maybe CampaignHook)
- data ApplicationsResponse
- applicationsResponse :: ApplicationsResponse
- appNextToken :: Lens' ApplicationsResponse (Maybe Text)
- appItem :: Lens' ApplicationsResponse [ApplicationResponse]
- data AttributeDimension
- attributeDimension :: AttributeDimension
- adValues :: Lens' AttributeDimension [Text]
- adAttributeType :: Lens' AttributeDimension (Maybe AttributeType)
- data BaiduChannelRequest
- baiduChannelRequest :: BaiduChannelRequest
- bcrAPIKey :: Lens' BaiduChannelRequest (Maybe Text)
- bcrEnabled :: Lens' BaiduChannelRequest (Maybe Bool)
- bcrSecretKey :: Lens' BaiduChannelRequest (Maybe Text)
- data BaiduChannelResponse
- baiduChannelResponse :: BaiduChannelResponse
- bcPlatform :: Lens' BaiduChannelResponse (Maybe Text)
- bcLastModifiedDate :: Lens' BaiduChannelResponse (Maybe Text)
- bcEnabled :: Lens' BaiduChannelResponse (Maybe Bool)
- bcCredential :: Lens' BaiduChannelResponse (Maybe Text)
- bcIsArchived :: Lens' BaiduChannelResponse (Maybe Bool)
- bcApplicationId :: Lens' BaiduChannelResponse (Maybe Text)
- bcVersion :: Lens' BaiduChannelResponse (Maybe Int)
- bcId :: Lens' BaiduChannelResponse (Maybe Text)
- bcCreationDate :: Lens' BaiduChannelResponse (Maybe Text)
- bcLastModifiedBy :: Lens' BaiduChannelResponse (Maybe Text)
- bcHasCredential :: Lens' BaiduChannelResponse (Maybe Bool)
- data BaiduMessage
- baiduMessage :: BaiduMessage
- bmSubstitutions :: Lens' BaiduMessage (HashMap Text [Text])
- bmSilentPush :: Lens' BaiduMessage (Maybe Bool)
- bmImageIconURL :: Lens' BaiduMessage (Maybe Text)
- bmRawContent :: Lens' BaiduMessage (Maybe Text)
- bmData :: Lens' BaiduMessage (HashMap Text Text)
- bmSmallImageIconURL :: Lens' BaiduMessage (Maybe Text)
- bmBody :: Lens' BaiduMessage (Maybe Text)
- bmURL :: Lens' BaiduMessage (Maybe Text)
- bmSound :: Lens' BaiduMessage (Maybe Text)
- bmAction :: Lens' BaiduMessage (Maybe Action)
- bmImageURL :: Lens' BaiduMessage (Maybe Text)
- bmTitle :: Lens' BaiduMessage (Maybe Text)
- bmIconReference :: Lens' BaiduMessage (Maybe Text)
- data CampaignEmailMessage
- campaignEmailMessage :: CampaignEmailMessage
- cemBody :: Lens' CampaignEmailMessage (Maybe Text)
- cemFromAddress :: Lens' CampaignEmailMessage (Maybe Text)
- cemHTMLBody :: Lens' CampaignEmailMessage (Maybe Text)
- cemTitle :: Lens' CampaignEmailMessage (Maybe Text)
- data CampaignHook
- campaignHook :: CampaignHook
- chLambdaFunctionName :: Lens' CampaignHook (Maybe Text)
- chMode :: Lens' CampaignHook (Maybe Mode)
- chWebURL :: Lens' CampaignHook (Maybe Text)
- data CampaignLimits
- campaignLimits :: CampaignLimits
- clMessagesPerSecond :: Lens' CampaignLimits (Maybe Int)
- clDaily :: Lens' CampaignLimits (Maybe Int)
- clTotal :: Lens' CampaignLimits (Maybe Int)
- clMaximumDuration :: Lens' CampaignLimits (Maybe Int)
- data CampaignResponse
- campaignResponse :: CampaignResponse
- cState :: Lens' CampaignResponse (Maybe CampaignState)
- cLastModifiedDate :: Lens' CampaignResponse (Maybe Text)
- cSchedule :: Lens' CampaignResponse (Maybe Schedule)
- cHook :: Lens' CampaignResponse (Maybe CampaignHook)
- 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 CampaignSmsMessage
- campaignSmsMessage :: CampaignSmsMessage
- csmBody :: Lens' CampaignSmsMessage (Maybe Text)
- csmMessageType :: Lens' CampaignSmsMessage (Maybe MessageType)
- csmSenderId :: Lens' CampaignSmsMessage (Maybe Text)
- data CampaignState
- campaignState :: CampaignState
- csCampaignStatus :: Lens' CampaignState (Maybe CampaignStatus)
- data CampaignsResponse
- campaignsResponse :: CampaignsResponse
- cNextToken :: Lens' CampaignsResponse (Maybe Text)
- cItem :: Lens' CampaignsResponse [CampaignResponse]
- data CreateApplicationRequest
- createApplicationRequest :: CreateApplicationRequest
- carName :: Lens' CreateApplicationRequest (Maybe Text)
- data DefaultMessage
- defaultMessage :: DefaultMessage
- dmSubstitutions :: Lens' DefaultMessage (HashMap Text [Text])
- dmBody :: Lens' DefaultMessage (Maybe Text)
- data DefaultPushNotificationMessage
- defaultPushNotificationMessage :: DefaultPushNotificationMessage
- dpnmSubstitutions :: Lens' DefaultPushNotificationMessage (HashMap Text [Text])
- dpnmSilentPush :: Lens' DefaultPushNotificationMessage (Maybe Bool)
- dpnmData :: Lens' DefaultPushNotificationMessage (HashMap Text Text)
- dpnmBody :: Lens' DefaultPushNotificationMessage (Maybe Text)
- dpnmURL :: Lens' DefaultPushNotificationMessage (Maybe Text)
- dpnmAction :: Lens' DefaultPushNotificationMessage (Maybe Action)
- dpnmTitle :: Lens' DefaultPushNotificationMessage (Maybe Text)
- data DirectMessageConfiguration
- directMessageConfiguration :: DirectMessageConfiguration
- dmcAPNSMessage :: Lens' DirectMessageConfiguration (Maybe APNSMessage)
- dmcGCMMessage :: Lens' DirectMessageConfiguration (Maybe GCMMessage)
- dmcDefaultMessage :: Lens' DirectMessageConfiguration (Maybe DefaultMessage)
- dmcADMMessage :: Lens' DirectMessageConfiguration (Maybe ADMMessage)
- dmcSMSMessage :: Lens' DirectMessageConfiguration (Maybe SMSMessage)
- dmcBaiduMessage :: Lens' DirectMessageConfiguration (Maybe BaiduMessage)
- dmcDefaultPushNotificationMessage :: Lens' DirectMessageConfiguration (Maybe DefaultPushNotificationMessage)
- data EmailChannelRequest
- emailChannelRequest :: EmailChannelRequest
- ecrEnabled :: Lens' EmailChannelRequest (Maybe Bool)
- ecrFromAddress :: Lens' EmailChannelRequest (Maybe Text)
- ecrIdentity :: Lens' EmailChannelRequest (Maybe Text)
- ecrRoleARN :: Lens' EmailChannelRequest (Maybe Text)
- data EmailChannelResponse
- emailChannelResponse :: EmailChannelResponse
- ecPlatform :: Lens' EmailChannelResponse (Maybe Text)
- ecLastModifiedDate :: Lens' EmailChannelResponse (Maybe Text)
- ecEnabled :: Lens' EmailChannelResponse (Maybe Bool)
- ecFromAddress :: Lens' EmailChannelResponse (Maybe Text)
- ecIsArchived :: Lens' EmailChannelResponse (Maybe Bool)
- ecApplicationId :: Lens' EmailChannelResponse (Maybe Text)
- ecVersion :: Lens' EmailChannelResponse (Maybe Int)
- ecId :: Lens' EmailChannelResponse (Maybe Text)
- ecCreationDate :: Lens' EmailChannelResponse (Maybe Text)
- ecLastModifiedBy :: Lens' EmailChannelResponse (Maybe Text)
- ecIdentity :: Lens' EmailChannelResponse (Maybe Text)
- ecHasCredential :: Lens' EmailChannelResponse (Maybe Bool)
- ecRoleARN :: Lens' EmailChannelResponse (Maybe Text)
- 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 EndpointMessageResult
- endpointMessageResult :: EndpointMessageResult
- emrDeliveryStatus :: Lens' EndpointMessageResult (Maybe DeliveryStatus)
- emrAddress :: Lens' EndpointMessageResult (Maybe Text)
- emrStatusMessage :: Lens' EndpointMessageResult (Maybe Text)
- emrUpdatedToken :: Lens' EndpointMessageResult (Maybe Text)
- emrStatusCode :: Lens' EndpointMessageResult (Maybe Int)
- 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)
- data EndpointSendConfiguration
- endpointSendConfiguration :: EndpointSendConfiguration
- escSubstitutions :: Lens' EndpointSendConfiguration (HashMap Text [Text])
- escTitleOverride :: Lens' EndpointSendConfiguration (Maybe Text)
- escContext :: Lens' EndpointSendConfiguration (HashMap Text Text)
- escRawContent :: Lens' EndpointSendConfiguration (Maybe Text)
- escBodyOverride :: Lens' EndpointSendConfiguration (Maybe Text)
- data EndpointUser
- endpointUser :: EndpointUser
- euUserAttributes :: Lens' EndpointUser (HashMap Text [Text])
- euUserId :: Lens' EndpointUser (Maybe Text)
- data EventStream
- eventStream :: EventStream
- esLastUpdatedBy :: Lens' EventStream (Maybe Text)
- esLastModifiedDate :: Lens' EventStream (Maybe Text)
- esDestinationStreamARN :: Lens' EventStream (Maybe Text)
- esApplicationId :: Lens' EventStream (Maybe Text)
- esExternalId :: Lens' EventStream (Maybe Text)
- esRoleARN :: Lens' EventStream (Maybe Text)
- data ExportJobRequest
- exportJobRequest :: ExportJobRequest
- eS3URLPrefix :: Lens' ExportJobRequest (Maybe Text)
- eSegmentId :: Lens' ExportJobRequest (Maybe Text)
- eRoleARN :: Lens' ExportJobRequest (Maybe Text)
- data ExportJobResource
- exportJobResource :: ExportJobResource
- ejrS3URLPrefix :: Lens' ExportJobResource (Maybe Text)
- ejrSegmentId :: Lens' ExportJobResource (Maybe Text)
- ejrRoleARN :: Lens' ExportJobResource (Maybe Text)
- data ExportJobResponse
- exportJobResponse :: ExportJobResponse
- ejCompletedPieces :: Lens' ExportJobResponse (Maybe Int)
- ejFailedPieces :: Lens' ExportJobResponse (Maybe Int)
- ejDefinition :: Lens' ExportJobResponse (Maybe ExportJobResource)
- ejTotalProcessed :: Lens' ExportJobResponse (Maybe Int)
- ejFailures :: Lens' ExportJobResponse [Text]
- ejTotalPieces :: Lens' ExportJobResponse (Maybe Int)
- ejApplicationId :: Lens' ExportJobResponse (Maybe Text)
- ejId :: Lens' ExportJobResponse (Maybe Text)
- ejCreationDate :: Lens' ExportJobResponse (Maybe Text)
- ejType :: Lens' ExportJobResponse (Maybe Text)
- ejCompletionDate :: Lens' ExportJobResponse (Maybe Text)
- ejJobStatus :: Lens' ExportJobResponse (Maybe JobStatus)
- ejTotalFailures :: Lens' ExportJobResponse (Maybe Int)
- data ExportJobsResponse
- exportJobsResponse :: ExportJobsResponse
- ejNextToken :: Lens' ExportJobsResponse (Maybe Text)
- ejItem :: Lens' ExportJobsResponse [ExportJobResponse]
- data GCMChannelRequest
- gcmChannelRequest :: GCMChannelRequest
- gcrAPIKey :: Lens' GCMChannelRequest (Maybe Text)
- gcrEnabled :: Lens' GCMChannelRequest (Maybe Bool)
- data GCMChannelResponse
- gcmChannelResponse :: GCMChannelResponse
- gcPlatform :: Lens' GCMChannelResponse (Maybe Text)
- gcLastModifiedDate :: Lens' GCMChannelResponse (Maybe Text)
- gcEnabled :: Lens' GCMChannelResponse (Maybe Bool)
- 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)
- gcHasCredential :: Lens' GCMChannelResponse (Maybe Bool)
- data GCMMessage
- gcmMessage :: GCMMessage
- gmSubstitutions :: Lens' GCMMessage (HashMap Text [Text])
- gmSilentPush :: Lens' GCMMessage (Maybe Bool)
- gmImageIconURL :: Lens' GCMMessage (Maybe Text)
- gmPriority :: Lens' GCMMessage (Maybe Text)
- gmRawContent :: Lens' GCMMessage (Maybe Text)
- gmData :: Lens' GCMMessage (HashMap Text Text)
- gmRestrictedPackageName :: Lens' GCMMessage (Maybe Text)
- gmSmallImageIconURL :: Lens' GCMMessage (Maybe Text)
- gmBody :: Lens' GCMMessage (Maybe Text)
- gmTimeToLive :: Lens' GCMMessage (Maybe Int)
- gmURL :: Lens' GCMMessage (Maybe Text)
- gmSound :: Lens' GCMMessage (Maybe Text)
- gmAction :: Lens' GCMMessage (Maybe Action)
- gmCollapseKey :: Lens' GCMMessage (Maybe Text)
- gmImageURL :: Lens' GCMMessage (Maybe Text)
- gmTitle :: Lens' GCMMessage (Maybe Text)
- gmIconReference :: Lens' GCMMessage (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)
- mRawContent :: Lens' Message (Maybe Text)
- mBody :: Lens' Message (Maybe Text)
- mImageSmallIconURL :: 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)
- mcADMMessage :: Lens' MessageConfiguration (Maybe Message)
- mcSMSMessage :: Lens' MessageConfiguration (Maybe CampaignSmsMessage)
- mcEmailMessage :: Lens' MessageConfiguration (Maybe CampaignEmailMessage)
- mcBaiduMessage :: Lens' MessageConfiguration (Maybe Message)
- data MessageRequest
- messageRequest :: MessageRequest
- mrContext :: Lens' MessageRequest (HashMap Text Text)
- mrAddresses :: Lens' MessageRequest (HashMap Text AddressConfiguration)
- mrEndpoints :: Lens' MessageRequest (HashMap Text EndpointSendConfiguration)
- mrMessageConfiguration :: Lens' MessageRequest (Maybe DirectMessageConfiguration)
- data MessageResponse
- messageResponse :: MessageResponse
- mRequestId :: Lens' MessageResponse (Maybe Text)
- mResult :: Lens' MessageResponse (HashMap Text MessageResult)
- mApplicationId :: Lens' MessageResponse (Maybe Text)
- mEndpointResult :: Lens' MessageResponse (HashMap Text EndpointMessageResult)
- data MessageResult
- messageResult :: MessageResult
- mrDeliveryStatus :: Lens' MessageResult (Maybe DeliveryStatus)
- mrStatusMessage :: Lens' MessageResult (Maybe Text)
- mrUpdatedToken :: Lens' MessageResult (Maybe Text)
- mrStatusCode :: Lens' MessageResult (Maybe Int)
- 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 SMSChannelRequest
- sMSChannelRequest :: SMSChannelRequest
- smscrShortCode :: Lens' SMSChannelRequest (Maybe Text)
- smscrEnabled :: Lens' SMSChannelRequest (Maybe Bool)
- smscrSenderId :: Lens' SMSChannelRequest (Maybe Text)
- data SMSChannelResponse
- sMSChannelResponse :: SMSChannelResponse
- smscPlatform :: Lens' SMSChannelResponse (Maybe Text)
- smscShortCode :: Lens' SMSChannelResponse (Maybe Text)
- smscLastModifiedDate :: Lens' SMSChannelResponse (Maybe Text)
- smscEnabled :: Lens' SMSChannelResponse (Maybe Bool)
- smscSenderId :: Lens' SMSChannelResponse (Maybe Text)
- smscIsArchived :: Lens' SMSChannelResponse (Maybe Bool)
- smscApplicationId :: Lens' SMSChannelResponse (Maybe Text)
- smscVersion :: Lens' SMSChannelResponse (Maybe Int)
- smscId :: Lens' SMSChannelResponse (Maybe Text)
- smscCreationDate :: Lens' SMSChannelResponse (Maybe Text)
- smscLastModifiedBy :: Lens' SMSChannelResponse (Maybe Text)
- smscHasCredential :: Lens' SMSChannelResponse (Maybe Bool)
- data SMSMessage
- sMSMessage :: SMSMessage
- smsmSubstitutions :: Lens' SMSMessage (HashMap Text [Text])
- smsmOriginationNumber :: Lens' SMSMessage (Maybe Text)
- smsmBody :: Lens' SMSMessage (Maybe Text)
- smsmMessageType :: Lens' SMSMessage (Maybe MessageType)
- smsmSenderId :: Lens' SMSMessage (Maybe Text)
- 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)
- sdChannel :: 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)
- sdUserAttributes :: Lens' SegmentDimensions (HashMap Text AttributeDimension)
- 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)
- sirChannelCounts :: Lens' SegmentImportResource (HashMap Text Int)
- 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 SendUsersMessageRequest
- sendUsersMessageRequest :: SendUsersMessageRequest
- sumrContext :: Lens' SendUsersMessageRequest (HashMap Text Text)
- sumrUsers :: Lens' SendUsersMessageRequest (HashMap Text EndpointSendConfiguration)
- sumrMessageConfiguration :: Lens' SendUsersMessageRequest (Maybe DirectMessageConfiguration)
- data SendUsersMessageResponse
- sendUsersMessageResponse :: SendUsersMessageResponse
- sumRequestId :: Lens' SendUsersMessageResponse (Maybe Text)
- sumResult :: Lens' SendUsersMessageResponse (HashMap Text (HashMap Text EndpointMessageResult))
- sumApplicationId :: Lens' SendUsersMessageResponse (Maybe Text)
- 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)
- wasrCampaignHook :: Lens' WriteApplicationSettingsRequest (Maybe CampaignHook)
- data WriteCampaignRequest
- writeCampaignRequest :: WriteCampaignRequest
- wcrSchedule :: Lens' WriteCampaignRequest (Maybe Schedule)
- wcrHook :: Lens' WriteCampaignRequest (Maybe CampaignHook)
- 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 WriteEventStream
- writeEventStream :: WriteEventStream
- wesDestinationStreamARN :: Lens' WriteEventStream (Maybe Text)
- wesRoleARN :: Lens' WriteEventStream (Maybe Text)
- 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
_ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Simple message object.
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Simple message object.
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Simple message object.
_InternalServerErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Simple message object.
_MethodNotAllowedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Simple message object.
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Simple message object.
Action
Instances
AttributeType
data AttributeType Source #
Instances
CampaignStatus
data CampaignStatus Source #
Constructors
| Completed | |
| Executing | |
| Paused | |
| PendingNextRun | |
| Scheduled |
Instances
ChannelType
data ChannelType Source #
Constructors
| ADM | |
| APNS | |
| APNSSandbox | |
| APNSVoip | |
| APNSVoipSandbox | |
| Baidu | |
| Custom | |
| GCM | |
| Sms |
Instances
DefinitionFormat
data DefinitionFormat Source #
Instances
DeliveryStatus
data DeliveryStatus Source #
Instances
DimensionType
data DimensionType Source #
Constructors
| DTExclusive | |
| DTInclusive |
Instances
Duration
Instances
Frequency
Instances
JobStatus
Instances
MessageType
data MessageType Source #
Constructors
| Promotional | |
| Transactional |
Instances
Mode
Instances
RecencyType
data RecencyType Source #
Instances
SegmentType
data SegmentType Source #
Constructors
| Dimensional | |
| Import |
Instances
ADMChannelRequest
data ADMChannelRequest Source #
Amazon Device Messaging channel definition.
See: aDMChannelRequest smart constructor.
Instances
aDMChannelRequest :: ADMChannelRequest Source #
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- Client ID as gotten from AmazonadmcrClientSecret- Client secret as gotten from AmazonadmcrEnabled- If the channel is enabled for sending messages.
admcrClientId :: Lens' ADMChannelRequest (Maybe Text) Source #
Client ID as gotten from Amazon
admcrClientSecret :: Lens' ADMChannelRequest (Maybe Text) Source #
Client secret as gotten from Amazon
admcrEnabled :: Lens' ADMChannelRequest (Maybe Bool) Source #
If the channel is enabled for sending messages.
ADMChannelResponse
data ADMChannelResponse Source #
Amazon Device Messaging channel definition.
See: aDMChannelResponse smart constructor.
Instances
aDMChannelResponse :: ADMChannelResponse Source #
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- Platform type. Will be ADMadmcLastModifiedDate- Last date this was updatedadmcEnabled- If the channel is enabled for sending messages.admcIsArchived- Is this channel archivedadmcApplicationId- The ID of the application to which the channel applies.admcVersion- Version of channeladmcId- Channel ID. Not used, only for backwards compatibility.admcCreationDate- When was this segment createdadmcLastModifiedBy- Who last updated this entryadmcHasCredential- 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.
admcPlatform :: Lens' ADMChannelResponse (Maybe Text) Source #
Platform type. Will be ADM
admcLastModifiedDate :: Lens' ADMChannelResponse (Maybe Text) Source #
Last date this was updated
admcEnabled :: Lens' ADMChannelResponse (Maybe Bool) Source #
If the channel is enabled for sending messages.
admcIsArchived :: Lens' ADMChannelResponse (Maybe Bool) Source #
Is this channel archived
admcApplicationId :: Lens' ADMChannelResponse (Maybe Text) Source #
The ID of the application to which the channel applies.
admcVersion :: Lens' ADMChannelResponse (Maybe Int) Source #
Version of channel
admcId :: Lens' ADMChannelResponse (Maybe Text) Source #
Channel ID. Not used, only for backwards compatibility.
admcCreationDate :: Lens' ADMChannelResponse (Maybe Text) Source #
When was this segment created
admcLastModifiedBy :: Lens' ADMChannelResponse (Maybe Text) Source #
Who last updated this entry
admcHasCredential :: Lens' ADMChannelResponse (Maybe Bool) Source #
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 Source #
ADM Message.
See: aDMMessage smart constructor.
Instances
aDMMessage :: ADMMessage Source #
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 offlineadmmMD5- Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrityadmmSilentPush- 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' objectadmmSmallImageIconURL- 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 viewadmmBody- 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 | URLadmmImageURL- 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]) Source #
Default message substitutions. Can be overridden by individual address substitutions.
admmExpiresAfter :: Lens' ADMMessage (Maybe Text) Source #
Optional. Number of seconds ADM should retain the message if the device is offline
admmMD5 :: Lens' ADMMessage (Maybe Text) Source #
Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity
admmSilentPush :: Lens' ADMMessage (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.
admmImageIconURL :: Lens' ADMMessage (Maybe Text) Source #
The URL that points to an image used as the large icon to the notification content view.
admmRawContent :: Lens' ADMMessage (Maybe Text) Source #
The Raw JSON formatted string to be used as the payload. This value overrides the message.
admmData :: Lens' ADMMessage (HashMap Text Text) Source #
The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
admmSmallImageIconURL :: Lens' ADMMessage (Maybe Text) Source #
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) Source #
The message body of the notification, the email body or the text message.
admmURL :: Lens' ADMMessage (Maybe Text) Source #
The URL to open in the user's mobile browser. Used if the value for Action is URL.
admmSound :: Lens' ADMMessage (Maybe Text) Source #
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) 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. Possible values include: OPEN_APP | DEEP_LINK | URL
admmImageURL :: Lens' ADMMessage (Maybe Text) Source #
The URL that points to an image used in the push notification.
admmConsolidationKey :: Lens' ADMMessage (Maybe Text) Source #
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) Source #
The message title that displays above the message on the user's device.
admmIconReference :: Lens' ADMMessage (Maybe Text) Source #
The icon image name of the asset saved in your application.
APNSChannelRequest
data APNSChannelRequest Source #
Apple Push Notification Service channel definition.
See: apnsChannelRequest smart constructor.
Instances
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:
acrTokenKey- The token key used for APNs Tokens.acrPrivateKey- The certificate private key.acrEnabled- If the channel is enabled for sending messages.acrTeamId- The team id used for APNs Tokens.acrBundleId- The bundle id used for APNs Tokens.acrDefaultAuthenticationMethod- The default authentication method used for APNs.acrCertificate- The distribution certificate from Apple.acrTokenKeyId- The token key used for APNs Tokens.
acrTokenKey :: Lens' APNSChannelRequest (Maybe Text) Source #
The token key used for APNs Tokens.
acrPrivateKey :: Lens' APNSChannelRequest (Maybe Text) Source #
The certificate private key.
acrEnabled :: Lens' APNSChannelRequest (Maybe Bool) Source #
If the channel is enabled for sending messages.
acrBundleId :: Lens' APNSChannelRequest (Maybe Text) Source #
The bundle id used for APNs Tokens.
acrDefaultAuthenticationMethod :: Lens' APNSChannelRequest (Maybe Text) Source #
The default authentication method used for APNs.
acrCertificate :: Lens' APNSChannelRequest (Maybe Text) Source #
The distribution certificate from Apple.
acrTokenKeyId :: Lens' APNSChannelRequest (Maybe Text) Source #
The token key used for APNs Tokens.
APNSChannelResponse
data APNSChannelResponse Source #
Apple Distribution Push Notification Service channel definition.
See: apnsChannelResponse smart constructor.
Instances
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 updatedacEnabled- 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 archivedacApplicationId- The ID of the application to which the channel applies.acVersion- Version of channelacId- Channel ID. Not used. Present only for backwards compatibility.acCreationDate- When was this segment createdacLastModifiedBy- Who last updated this entryacHasCredential- 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) Source #
The platform type. Will be APNS.
acLastModifiedDate :: Lens' APNSChannelResponse (Maybe Text) Source #
Last date this was updated
acEnabled :: Lens' APNSChannelResponse (Maybe Bool) Source #
If the channel is enabled for sending messages.
acHasTokenKey :: Lens' APNSChannelResponse (Maybe Bool) Source #
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) Source #
The default authentication method used for APNs.
acIsArchived :: Lens' APNSChannelResponse (Maybe Bool) Source #
Is this channel archived
acApplicationId :: Lens' APNSChannelResponse (Maybe Text) Source #
The ID of the application to which the channel applies.
acId :: Lens' APNSChannelResponse (Maybe Text) Source #
Channel ID. Not used. Present only for backwards compatibility.
acCreationDate :: Lens' APNSChannelResponse (Maybe Text) Source #
When was this segment created
acLastModifiedBy :: Lens' APNSChannelResponse (Maybe Text) Source #
Who last updated this entry
acHasCredential :: Lens' APNSChannelResponse (Maybe Bool) Source #
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 Source #
APNS Message.
See: apnsMessage smart constructor.
Instances
apnsMessage :: APNSMessage Source #
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' objectamBody- 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 | URLamMediaURL- The URL that points to a video used in the push notification.amPreferredAuthenticationMethod- The preferred authentication method, either CERTIFICATE or TOKENamBadge- 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]) Source #
Default message substitutions. Can be overridden by individual address substitutions.
amSilentPush :: Lens' APNSMessage (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.
amPriority :: Lens' APNSMessage (Maybe Text) Source #
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) Source #
The Raw JSON formatted string to be used as the payload. This value overrides the message.
amData :: Lens' APNSMessage (HashMap Text Text) Source #
The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
amBody :: Lens' APNSMessage (Maybe Text) Source #
The message body of the notification, the email body or the text message.
amCategory :: Lens' APNSMessage (Maybe Text) Source #
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) Source #
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) Source #
The URL to open in the user's mobile browser. Used if the value for Action is URL.
amSound :: Lens' APNSMessage (Maybe Text) Source #
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) 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. Possible values include: OPEN_APP | DEEP_LINK | URL
amMediaURL :: Lens' APNSMessage (Maybe Text) Source #
The URL that points to a video used in the push notification.
amPreferredAuthenticationMethod :: Lens' APNSMessage (Maybe Text) Source #
The preferred authentication method, either CERTIFICATE or TOKEN
amBadge :: Lens' APNSMessage (Maybe Int) Source #
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) Source #
The message title that displays above the message on the user's device.
amThreadId :: Lens' APNSMessage (Maybe Text) Source #
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) Source #
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 Source #
Apple Development Push Notification Service channel definition.
See: apnsSandboxChannelRequest smart constructor.
Instances
apnsSandboxChannelRequest :: APNSSandboxChannelRequest Source #
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- The token key used for APNs Tokens.ascrPrivateKey- The certificate private key.ascrEnabled- If the channel is enabled for sending messages.ascrTeamId- The team id used for APNs Tokens.ascrBundleId- The bundle id used for APNs Tokens.ascrDefaultAuthenticationMethod- The default authentication method used for APNs.ascrCertificate- The distribution certificate from Apple.ascrTokenKeyId- The token key used for APNs Tokens.
ascrTokenKey :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #
The token key used for APNs Tokens.
ascrPrivateKey :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #
The certificate private key.
ascrEnabled :: Lens' APNSSandboxChannelRequest (Maybe Bool) Source #
If the channel is enabled for sending messages.
ascrTeamId :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #
The team id used for APNs Tokens.
ascrBundleId :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #
The bundle id used for APNs Tokens.
ascrDefaultAuthenticationMethod :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #
The default authentication method used for APNs.
ascrCertificate :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #
The distribution certificate from Apple.
ascrTokenKeyId :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #
The token key used for APNs Tokens.
APNSSandboxChannelResponse
data APNSSandboxChannelResponse Source #
Apple Development Push Notification Service channel definition.
See: apnsSandboxChannelResponse smart constructor.
Instances
apnsSandboxChannelResponse :: APNSSandboxChannelResponse Source #
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 updatedascEnabled- 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 archivedascApplicationId- The ID of the application to which the channel applies.ascVersion- Version of channelascId- Channel ID. Not used, only for backwards compatibility.ascCreationDate- When was this segment createdascLastModifiedBy- Who last updated this entryascHasCredential- 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) Source #
The platform type. Will be APNS_SANDBOX.
ascLastModifiedDate :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #
Last date this was updated
ascEnabled :: Lens' APNSSandboxChannelResponse (Maybe Bool) Source #
If the channel is enabled for sending messages.
ascHasTokenKey :: Lens' APNSSandboxChannelResponse (Maybe Bool) Source #
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) Source #
The default authentication method used for APNs.
ascIsArchived :: Lens' APNSSandboxChannelResponse (Maybe Bool) Source #
Is this channel archived
ascApplicationId :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #
The ID of the application to which the channel applies.
ascVersion :: Lens' APNSSandboxChannelResponse (Maybe Int) Source #
Version of channel
ascId :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #
Channel ID. Not used, only for backwards compatibility.
ascCreationDate :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #
When was this segment created
ascLastModifiedBy :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #
Who last updated this entry
ascHasCredential :: Lens' APNSSandboxChannelResponse (Maybe Bool) Source #
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 Source #
Apple VoIP Push Notification Service channel definition.
See: apnsVoipChannelRequest smart constructor.
Instances
apnsVoipChannelRequest :: APNSVoipChannelRequest Source #
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- The token key used for APNs Tokens.avcrPrivateKey- The certificate private key.avcrEnabled- If the channel is enabled for sending messages.avcrTeamId- The team id used for APNs Tokens.avcrBundleId- The bundle id used for APNs Tokens.avcrDefaultAuthenticationMethod- The default authentication method used for APNs.avcrCertificate- The distribution certificate from Apple.avcrTokenKeyId- The token key used for APNs Tokens.
avcrTokenKey :: Lens' APNSVoipChannelRequest (Maybe Text) Source #
The token key used for APNs Tokens.
avcrPrivateKey :: Lens' APNSVoipChannelRequest (Maybe Text) Source #
The certificate private key.
avcrEnabled :: Lens' APNSVoipChannelRequest (Maybe Bool) Source #
If the channel is enabled for sending messages.
avcrTeamId :: Lens' APNSVoipChannelRequest (Maybe Text) Source #
The team id used for APNs Tokens.
avcrBundleId :: Lens' APNSVoipChannelRequest (Maybe Text) Source #
The bundle id used for APNs Tokens.
avcrDefaultAuthenticationMethod :: Lens' APNSVoipChannelRequest (Maybe Text) Source #
The default authentication method used for APNs.
avcrCertificate :: Lens' APNSVoipChannelRequest (Maybe Text) Source #
The distribution certificate from Apple.
avcrTokenKeyId :: Lens' APNSVoipChannelRequest (Maybe Text) Source #
The token key used for APNs Tokens.
APNSVoipChannelResponse
data APNSVoipChannelResponse Source #
Apple VoIP Push Notification Service channel definition.
See: apnsVoipChannelResponse smart constructor.
Instances
apnsVoipChannelResponse :: APNSVoipChannelResponse Source #
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- The platform type. Will be APNS.avcLastModifiedDate- Last date this was updatedavcEnabled- If the channel is enabled for sending messages.avcHasTokenKey- If the channel is registered with a token key for authentication.avcDefaultAuthenticationMethod- The default authentication method used for APNs.avcIsArchived- Is this channel archivedavcApplicationId- Application idavcVersion- Version of channelavcId- Channel ID. Not used, only for backwards compatibility.avcCreationDate- When was this segment createdavcLastModifiedBy- Who made the last changeavcHasCredential- If the channel is registered with a credential for authentication.
avcPlatform :: Lens' APNSVoipChannelResponse (Maybe Text) Source #
The platform type. Will be APNS.
avcLastModifiedDate :: Lens' APNSVoipChannelResponse (Maybe Text) Source #
Last date this was updated
avcEnabled :: Lens' APNSVoipChannelResponse (Maybe Bool) Source #
If the channel is enabled for sending messages.
avcHasTokenKey :: Lens' APNSVoipChannelResponse (Maybe Bool) Source #
If the channel is registered with a token key for authentication.
avcDefaultAuthenticationMethod :: Lens' APNSVoipChannelResponse (Maybe Text) Source #
The default authentication method used for APNs.
avcIsArchived :: Lens' APNSVoipChannelResponse (Maybe Bool) Source #
Is this channel archived
avcApplicationId :: Lens' APNSVoipChannelResponse (Maybe Text) Source #
Application id
avcVersion :: Lens' APNSVoipChannelResponse (Maybe Int) Source #
Version of channel
avcId :: Lens' APNSVoipChannelResponse (Maybe Text) Source #
Channel ID. Not used, only for backwards compatibility.
avcCreationDate :: Lens' APNSVoipChannelResponse (Maybe Text) Source #
When was this segment created
avcLastModifiedBy :: Lens' APNSVoipChannelResponse (Maybe Text) Source #
Who made the last change
avcHasCredential :: Lens' APNSVoipChannelResponse (Maybe Bool) Source #
If the channel is registered with a credential for authentication.
APNSVoipSandboxChannelRequest
data APNSVoipSandboxChannelRequest Source #
Apple VoIP Developer Push Notification Service channel definition.
See: apnsVoipSandboxChannelRequest smart constructor.
Instances
apnsVoipSandboxChannelRequest :: APNSVoipSandboxChannelRequest Source #
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- The token key used for APNs Tokens.avscrPrivateKey- The certificate private key.avscrEnabled- If the channel is enabled for sending messages.avscrTeamId- The team id used for APNs Tokens.avscrBundleId- The bundle id used for APNs Tokens.avscrDefaultAuthenticationMethod- The default authentication method used for APNs.avscrCertificate- The distribution certificate from Apple.avscrTokenKeyId- The token key used for APNs Tokens.
avscrTokenKey :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #
The token key used for APNs Tokens.
avscrPrivateKey :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #
The certificate private key.
avscrEnabled :: Lens' APNSVoipSandboxChannelRequest (Maybe Bool) Source #
If the channel is enabled for sending messages.
avscrTeamId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #
The team id used for APNs Tokens.
avscrBundleId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #
The bundle id used for APNs Tokens.
avscrDefaultAuthenticationMethod :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #
The default authentication method used for APNs.
avscrCertificate :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #
The distribution certificate from Apple.
avscrTokenKeyId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #
The token key used for APNs Tokens.
APNSVoipSandboxChannelResponse
data APNSVoipSandboxChannelResponse Source #
Apple VoIP Developer Push Notification Service channel definition.
See: apnsVoipSandboxChannelResponse smart constructor.
Instances
apnsVoipSandboxChannelResponse :: APNSVoipSandboxChannelResponse Source #
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- The platform type. Will be APNS.avscLastModifiedDate- Last date this was updatedavscEnabled- If the channel is enabled for sending messages.avscHasTokenKey- If the channel is registered with a token key for authentication.avscDefaultAuthenticationMethod- The default authentication method used for APNs.avscIsArchived- Is this channel archivedavscApplicationId- Application idavscVersion- Version of channelavscId- Channel ID. Not used, only for backwards compatibility.avscCreationDate- When was this segment createdavscLastModifiedBy- Who made the last changeavscHasCredential- If the channel is registered with a credential for authentication.
avscPlatform :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #
The platform type. Will be APNS.
avscLastModifiedDate :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #
Last date this was updated
avscEnabled :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) Source #
If the channel is enabled for sending messages.
avscHasTokenKey :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) Source #
If the channel is registered with a token key for authentication.
avscDefaultAuthenticationMethod :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #
The default authentication method used for APNs.
avscIsArchived :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) Source #
Is this channel archived
avscApplicationId :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #
Application id
avscVersion :: Lens' APNSVoipSandboxChannelResponse (Maybe Int) Source #
Version of channel
avscId :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #
Channel ID. Not used, only for backwards compatibility.
avscCreationDate :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #
When was this segment created
avscLastModifiedBy :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #
Who made the last change
avscHasCredential :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) Source #
If the channel is registered with a credential for authentication.
ActivitiesResponse
data ActivitiesResponse Source #
Activities for campaign.
See: activitiesResponse smart constructor.
Instances
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 #
Activity definition
See: activityResponse smart constructor.
Instances
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.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, 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.
aTimezonesCompletedCount :: Lens' ActivityResponse (Maybe Int) Source #
The total number of timezones completed.
aTimezonesTotalCount :: Lens' ActivityResponse (Maybe Int) Source #
The total number of unique timezones present in the segment.
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.
AddressConfiguration
data AddressConfiguration Source #
Address configuration.
See: addressConfiguration smart constructor.
Instances
addressConfiguration :: AddressConfiguration Source #
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]) Source #
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) Source #
Title override. If specified will override default title if applicable.
acContext :: Lens' AddressConfiguration (HashMap Text Text) Source #
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) Source #
The Raw JSON formatted string to be used as the payload. This value overrides the message.
acBodyOverride :: Lens' AddressConfiguration (Maybe Text) Source #
Body override. If specified will override default body.
acChannelType :: Lens' AddressConfiguration (Maybe ChannelType) Source #
The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
ApplicationResponse
data ApplicationResponse Source #
Application Response.
See: applicationResponse smart constructor.
Instances
applicationResponse :: ApplicationResponse Source #
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:
ApplicationSettingsResource
data ApplicationSettingsResource Source #
Application settings.
See: applicationSettingsResource smart constructor.
Instances
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.asrCampaignHook- Default campaign hook.
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.
asrCampaignHook :: Lens' ApplicationSettingsResource (Maybe CampaignHook) Source #
Default campaign hook.
ApplicationsResponse
data ApplicationsResponse Source #
Get Applications Result.
See: applicationsResponse smart constructor.
Instances
applicationsResponse :: ApplicationsResponse Source #
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) Source #
The string that you use in a subsequent request to get the next page of results in a paginated response.
appItem :: Lens' ApplicationsResponse [ApplicationResponse] Source #
List of applications returned in this page.
AttributeDimension
data AttributeDimension Source #
Custom attibute dimension
See: attributeDimension smart constructor.
Instances
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.
BaiduChannelRequest
data BaiduChannelRequest Source #
Baidu Cloud Push credentials
See: baiduChannelRequest smart constructor.
Instances
baiduChannelRequest :: BaiduChannelRequest Source #
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.
bcrEnabled :: Lens' BaiduChannelRequest (Maybe Bool) Source #
If the channel is enabled for sending messages.
bcrSecretKey :: Lens' BaiduChannelRequest (Maybe Text) Source #
Platform credential Secret key from Baidu.
BaiduChannelResponse
data BaiduChannelResponse Source #
Baidu Cloud Messaging channel definition
See: baiduChannelResponse smart constructor.
Instances
baiduChannelResponse :: BaiduChannelResponse Source #
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 BAIDUbcLastModifiedDate- Last date this was updatedbcEnabled- If the channel is enabled for sending messages.bcCredential- The Baidu API key from Baidu.bcIsArchived- Is this channel archivedbcApplicationId- Application idbcVersion- Version of channelbcId- Channel ID. Not used, only for backwards compatibility.bcCreationDate- When was this segment createdbcLastModifiedBy- Who made the last changebcHasCredential- 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) Source #
The platform type. Will be BAIDU
bcLastModifiedDate :: Lens' BaiduChannelResponse (Maybe Text) Source #
Last date this was updated
bcEnabled :: Lens' BaiduChannelResponse (Maybe Bool) Source #
If the channel is enabled for sending messages.
bcCredential :: Lens' BaiduChannelResponse (Maybe Text) Source #
The Baidu API key from Baidu.
bcIsArchived :: Lens' BaiduChannelResponse (Maybe Bool) Source #
Is this channel archived
bcApplicationId :: Lens' BaiduChannelResponse (Maybe Text) Source #
Application id
bcId :: Lens' BaiduChannelResponse (Maybe Text) Source #
Channel ID. Not used, only for backwards compatibility.
bcCreationDate :: Lens' BaiduChannelResponse (Maybe Text) Source #
When was this segment created
bcLastModifiedBy :: Lens' BaiduChannelResponse (Maybe Text) Source #
Who made the last change
bcHasCredential :: Lens' BaiduChannelResponse (Maybe Bool) Source #
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 Source #
Baidu Message.
See: baiduMessage smart constructor.
Instances
baiduMessage :: BaiduMessage Source #
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' objectbmSmallImageIconURL- 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 viewbmBody- 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 | URLbmImageURL- 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]) Source #
Default message substitutions. Can be overridden by individual address substitutions.
bmSilentPush :: Lens' BaiduMessage (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.
bmImageIconURL :: Lens' BaiduMessage (Maybe Text) Source #
The URL that points to an image used as the large icon to the notification content view.
bmRawContent :: Lens' BaiduMessage (Maybe Text) Source #
The Raw JSON formatted string to be used as the payload. This value overrides the message.
bmData :: Lens' BaiduMessage (HashMap Text Text) Source #
The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
bmSmallImageIconURL :: Lens' BaiduMessage (Maybe Text) Source #
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) Source #
The message body of the notification, the email body or the text message.
bmURL :: Lens' BaiduMessage (Maybe Text) Source #
The URL to open in the user's mobile browser. Used if the value for Action is URL.
bmSound :: Lens' BaiduMessage (Maybe Text) Source #
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) 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. Possible values include: OPEN_APP | DEEP_LINK | URL
bmImageURL :: Lens' BaiduMessage (Maybe Text) Source #
The URL that points to an image used in the push notification.
bmTitle :: Lens' BaiduMessage (Maybe Text) Source #
The message title that displays above the message on the user's device.
bmIconReference :: Lens' BaiduMessage (Maybe Text) Source #
The icon image name of the asset saved in your application.
CampaignEmailMessage
data CampaignEmailMessage Source #
The email message configuration.
See: campaignEmailMessage smart constructor.
Instances
campaignEmailMessage :: CampaignEmailMessage Source #
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).
cemFromAddress :: Lens' CampaignEmailMessage (Maybe Text) Source #
The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
cemHTMLBody :: Lens' CampaignEmailMessage (Maybe Text) Source #
The email html body.
CampaignHook
data CampaignHook Source #
See: campaignHook smart constructor.
Instances
campaignHook :: CampaignHook Source #
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 deliverychMode- 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) Source #
Lambda function name or arn to be called for delivery
chWebURL :: Lens' CampaignHook (Maybe Text) Source #
Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
CampaignLimits
data CampaignLimits Source #
Campaign Limits are used to limit the number of messages that can be sent to a user.
See: campaignLimits smart constructor.
Instances
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:
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) Source #
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) 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.
clMaximumDuration :: Lens' CampaignLimits (Maybe Int) Source #
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 Source #
Campaign definition
See: campaignResponse smart constructor.
Instances
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.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) 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.
cHook :: Lens' CampaignResponse (Maybe CampaignHook) Source #
Campaign hook information.
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.
CampaignSmsMessage
data CampaignSmsMessage Source #
SMS message configuration.
See: campaignSmsMessage smart constructor.
Instances
campaignSmsMessage :: CampaignSmsMessage Source #
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- The SMS text body.csmMessageType- Is this is a transactional SMS message, otherwise a promotional message.csmSenderId- Sender ID of sent message.
csmMessageType :: Lens' CampaignSmsMessage (Maybe MessageType) Source #
Is this is a transactional SMS message, otherwise a promotional message.
csmSenderId :: Lens' CampaignSmsMessage (Maybe Text) Source #
Sender ID of sent message.
CampaignState
data CampaignState Source #
State of the Campaign
See: campaignState smart constructor.
Instances
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 #
List of available campaigns.
See: campaignsResponse smart constructor.
Instances
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.
CreateApplicationRequest
data CreateApplicationRequest Source #
Application Request.
See: createApplicationRequest smart constructor.
Instances
createApplicationRequest :: CreateApplicationRequest Source #
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) Source #
The display name of the application. Used in the Amazon Pinpoint console.
DefaultMessage
data DefaultMessage Source #
Default Message across push notification, email, and sms.
See: defaultMessage smart constructor.
Instances
defaultMessage :: DefaultMessage Source #
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]) Source #
Default message substitutions. Can be overridden by individual address substitutions.
dmBody :: Lens' DefaultMessage (Maybe Text) Source #
The message body of the notification, the email body or the text message.
DefaultPushNotificationMessage
data DefaultPushNotificationMessage Source #
Default Push Notification Message.
See: defaultPushNotificationMessage smart constructor.
Instances
defaultPushNotificationMessage :: DefaultPushNotificationMessage Source #
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' objectdpnmBody- 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 | URLdpnmTitle- The message title that displays above the message on the user's device.
dpnmSubstitutions :: Lens' DefaultPushNotificationMessage (HashMap Text [Text]) Source #
Default message substitutions. Can be overridden by individual address substitutions.
dpnmSilentPush :: Lens' DefaultPushNotificationMessage (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.
dpnmData :: Lens' DefaultPushNotificationMessage (HashMap Text Text) Source #
The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
dpnmBody :: Lens' DefaultPushNotificationMessage (Maybe Text) Source #
The message body of the notification, the email body or the text message.
dpnmURL :: Lens' DefaultPushNotificationMessage (Maybe Text) Source #
The URL to open in the user's mobile browser. Used if the value for Action is URL.
dpnmAction :: Lens' DefaultPushNotificationMessage (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. Possible values include: OPEN_APP | DEEP_LINK | URL
dpnmTitle :: Lens' DefaultPushNotificationMessage (Maybe Text) Source #
The message title that displays above the message on the user's device.
DirectMessageConfiguration
data DirectMessageConfiguration Source #
The message configuration.
See: directMessageConfiguration smart constructor.
Instances
directMessageConfiguration :: DirectMessageConfiguration Source #
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) Source #
The message to APNS channels. Overrides the default push notification message.
dmcGCMMessage :: Lens' DirectMessageConfiguration (Maybe GCMMessage) Source #
The message to GCM channels. Overrides the default push notification message.
dmcDefaultMessage :: Lens' DirectMessageConfiguration (Maybe DefaultMessage) Source #
The default message for all channels.
dmcADMMessage :: Lens' DirectMessageConfiguration (Maybe ADMMessage) Source #
The message to ADM channels. Overrides the default push notification message.
dmcSMSMessage :: Lens' DirectMessageConfiguration (Maybe SMSMessage) Source #
The message to SMS channels. Overrides the default message.
dmcBaiduMessage :: Lens' DirectMessageConfiguration (Maybe BaiduMessage) Source #
The message to Baidu GCM channels. Overrides the default push notification message.
dmcDefaultPushNotificationMessage :: Lens' DirectMessageConfiguration (Maybe DefaultPushNotificationMessage) Source #
The default push notification message for all push channels.
EmailChannelRequest
data EmailChannelRequest Source #
Email Channel Request
See: emailChannelRequest smart constructor.
Instances
emailChannelRequest :: EmailChannelRequest Source #
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) Source #
If the channel is enabled for sending messages.
ecrFromAddress :: Lens' EmailChannelRequest (Maybe Text) Source #
The email address used to send emails from.
ecrIdentity :: Lens' EmailChannelRequest (Maybe Text) Source #
The ARN of an identity verified with SES.
ecrRoleARN :: Lens' EmailChannelRequest (Maybe Text) Source #
The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
EmailChannelResponse
data EmailChannelResponse Source #
Email Channel Response.
See: emailChannelResponse smart constructor.
Instances
emailChannelResponse :: EmailChannelResponse Source #
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:
ecPlatform- Platform type. Will be EMAILecLastModifiedDate- Last date this was updatedecEnabled- If the channel is enabled for sending messages.ecFromAddress- The email address used to send emails from.ecIsArchived- Is this channel archivedecApplicationId- The unique ID of the application to which the email channel belongs.ecVersion- Version of channelecId- Channel ID. Not used, only for backwards compatibility.ecCreationDate- The date that the settings were last updated in ISO 8601 format.ecLastModifiedBy- Who last updated this entryecIdentity- The ARN of an identity verified with SES.ecHasCredential- If the channel is registered with a credential for authentication.ecRoleARN- The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
ecPlatform :: Lens' EmailChannelResponse (Maybe Text) Source #
Platform type. Will be EMAIL
ecLastModifiedDate :: Lens' EmailChannelResponse (Maybe Text) Source #
Last date this was updated
ecEnabled :: Lens' EmailChannelResponse (Maybe Bool) Source #
If the channel is enabled for sending messages.
ecFromAddress :: Lens' EmailChannelResponse (Maybe Text) Source #
The email address used to send emails from.
ecIsArchived :: Lens' EmailChannelResponse (Maybe Bool) Source #
Is this channel archived
ecApplicationId :: Lens' EmailChannelResponse (Maybe Text) Source #
The unique ID of the application to which the email channel belongs.
ecId :: Lens' EmailChannelResponse (Maybe Text) Source #
Channel ID. Not used, only for backwards compatibility.
ecCreationDate :: Lens' EmailChannelResponse (Maybe Text) Source #
The date that the settings were last updated in ISO 8601 format.
ecLastModifiedBy :: Lens' EmailChannelResponse (Maybe Text) Source #
Who last updated this entry
ecIdentity :: Lens' EmailChannelResponse (Maybe Text) Source #
The ARN of an identity verified with SES.
ecHasCredential :: Lens' EmailChannelResponse (Maybe Bool) Source #
If the channel is registered with a credential for authentication.
ecRoleARN :: Lens' EmailChannelResponse (Maybe Text) Source #
The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
EndpointBatchItem
data EndpointBatchItem Source #
Endpoint update request
See: endpointBatchItem smart constructor.
Instances
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 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) 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 as provided by your push provider (e.g. DeviceToken or RegistrationId).
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 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) 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 has opted out of all messages. NONE - Users has not opted out and receives all messages.
ebiChannelType :: Lens' EndpointBatchItem (Maybe ChannelType) Source #
The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
EndpointBatchRequest
data EndpointBatchRequest Source #
Endpoint batch update request.
See: endpointBatchRequest smart constructor.
Instances
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 #
Endpoint demographic data
See: endpointDemographic smart constructor.
Instances
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 #
Endpoint location data
See: endpointLocation smart constructor.
Instances
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).
EndpointMessageResult
data EndpointMessageResult Source #
The result from sending a message to an endpoint.
See: endpointMessageResult smart constructor.
Instances
endpointMessageResult :: EndpointMessageResult Source #
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:
emrDeliveryStatus- Delivery status of message.emrAddress- Address that endpoint message was delivered to.emrStatusMessage- Status message for message delivery.emrUpdatedToken- If token was updated as part of delivery. (This is GCM Specific)emrStatusCode- Downstream service status code.
emrDeliveryStatus :: Lens' EndpointMessageResult (Maybe DeliveryStatus) Source #
Delivery status of message.
emrAddress :: Lens' EndpointMessageResult (Maybe Text) Source #
Address that endpoint message was delivered to.
emrStatusMessage :: Lens' EndpointMessageResult (Maybe Text) Source #
Status message for message delivery.
emrUpdatedToken :: Lens' EndpointMessageResult (Maybe Text) Source #
If token was updated as part of delivery. (This is GCM Specific)
emrStatusCode :: Lens' EndpointMessageResult (Maybe Int) Source #
Downstream service status code.
EndpointRequest
data EndpointRequest Source #
Endpoint update request
See: endpointRequest smart constructor.
Instances
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 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) 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.
erAddress :: Lens' EndpointRequest (Maybe Text) Source #
The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
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 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) 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 has opted out of all messages. NONE - Users has not opted out and receives all messages.
erChannelType :: Lens' EndpointRequest (Maybe ChannelType) Source #
The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
EndpointResponse
data EndpointResponse Source #
Endpoint response
See: endpointResponse smart constructor.
Instances
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 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) 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.
eAddress :: Lens' EndpointResponse (Maybe Text) Source #
The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
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 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) 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 has opted out of all messages. NONE - Users has not opted out and receives all 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: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
EndpointSendConfiguration
data EndpointSendConfiguration Source #
Endpoint send configuration.
See: endpointSendConfiguration smart constructor.
Instances
endpointSendConfiguration :: EndpointSendConfiguration Source #
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]) Source #
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) Source #
Title override. If specified will override default title if applicable.
escContext :: Lens' EndpointSendConfiguration (HashMap Text Text) Source #
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) Source #
The Raw JSON formatted string to be used as the payload. This value overrides the message.
escBodyOverride :: Lens' EndpointSendConfiguration (Maybe Text) Source #
Body override. If specified will override default body.
EndpointUser
data EndpointUser Source #
Endpoint user specific custom userAttributes
See: endpointUser smart constructor.
Instances
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 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]) Source #
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.
EventStream
data EventStream Source #
Model for an event publishing subscription export.
See: eventStream smart constructor.
Instances
eventStream :: EventStream Source #
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_NAMEesApplicationId- 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) Source #
The IAM user who last modified the event stream.
esLastModifiedDate :: Lens' EventStream (Maybe Text) Source #
The date the event stream was last updated in ISO 8601 format.
esDestinationStreamARN :: Lens' EventStream (Maybe Text) Source #
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) Source #
The ID of the application from which events should be published.
esExternalId :: Lens' EventStream (Maybe Text) Source #
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) Source #
The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.
ExportJobRequest
data ExportJobRequest Source #
See: exportJobRequest smart constructor.
Instances
exportJobRequest :: ExportJobRequest Source #
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) Source #
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) Source #
The ID of the segment to export endpoints from. If not present all endpoints will be exported.
eRoleARN :: Lens' ExportJobRequest (Maybe Text) Source #
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 Source #
See: exportJobResource smart constructor.
Instances
exportJobResource :: ExportJobResource Source #
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) Source #
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) Source #
The ID of the segment to export endpoints from. If not present, all endpoints are exported.
ejrRoleARN :: Lens' ExportJobResource (Maybe Text) Source #
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 Source #
See: exportJobResponse smart constructor.
Instances
exportJobResponse :: ExportJobResponse Source #
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 beEXPORT.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) Source #
The number of pieces that have successfully completed as of the time of the request.
ejFailedPieces :: Lens' ExportJobResponse (Maybe Int) Source #
The number of pieces that failed to be processed as of the time of the request.
ejDefinition :: Lens' ExportJobResponse (Maybe ExportJobResource) Source #
The export job settings.
ejTotalProcessed :: Lens' ExportJobResponse (Maybe Int) Source #
The number of endpoints that were processed by the job.
ejFailures :: Lens' ExportJobResponse [Text] Source #
Provides up to 100 of the first failed entries for the job, if any exist.
ejTotalPieces :: Lens' ExportJobResponse (Maybe Int) Source #
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) Source #
The unique ID of the application to which the job applies.
ejCreationDate :: Lens' ExportJobResponse (Maybe Text) Source #
The date the job was created in ISO 8601 format.
ejCompletionDate :: Lens' ExportJobResponse (Maybe Text) Source #
The date the job completed in ISO 8601 format.
ejJobStatus :: Lens' ExportJobResponse (Maybe JobStatus) Source #
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) Source #
The number of endpoints that were not processed; for example, because of syntax errors.
ExportJobsResponse
data ExportJobsResponse Source #
Export job list.
See: exportJobsResponse smart constructor.
Instances
exportJobsResponse :: ExportJobsResponse Source #
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) Source #
The string that you use in a subsequent request to get the next page of results in a paginated response.
ejItem :: Lens' ExportJobsResponse [ExportJobResponse] Source #
A list of export jobs for the application.
GCMChannelRequest
data GCMChannelRequest Source #
Google Cloud Messaging credentials
See: gcmChannelRequest smart constructor.
Instances
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.gcrEnabled- If the channel is enabled for sending messages.
gcrEnabled :: Lens' GCMChannelRequest (Maybe Bool) Source #
If the channel is enabled for sending messages.
GCMChannelResponse
data GCMChannelResponse Source #
Google Cloud Messaging channel definition
See: gcmChannelResponse smart constructor.
Instances
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 updatedgcEnabled- If the channel is enabled for sending messages.gcCredential- The GCM API key from Google.gcIsArchived- Is this channel archivedgcApplicationId- The ID of the application to which the channel applies.gcVersion- Version of channelgcId- Channel ID. Not used. Present only for backwards compatibility.gcCreationDate- When was this segment createdgcLastModifiedBy- Who last updated this entrygcHasCredential- 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) Source #
The platform type. Will be GCM
gcLastModifiedDate :: Lens' GCMChannelResponse (Maybe Text) Source #
Last date this was updated
gcEnabled :: Lens' GCMChannelResponse (Maybe Bool) Source #
If the channel is enabled for sending messages.
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 #
The ID of the application to which the channel applies.
gcId :: Lens' GCMChannelResponse (Maybe Text) Source #
Channel ID. Not used. Present only for backwards compatibility.
gcCreationDate :: Lens' GCMChannelResponse (Maybe Text) Source #
When was this segment created
gcLastModifiedBy :: Lens' GCMChannelResponse (Maybe Text) Source #
Who last updated this entry
gcHasCredential :: Lens' GCMChannelResponse (Maybe Bool) Source #
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 Source #
GCM Message.
See: gcmMessage smart constructor.
Instances
gcmMessage :: GCMMessage Source #
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' objectgmRestrictedPackageName- 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 viewgmBody- 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 | URLgmCollapseKey- 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]) Source #
Default message substitutions. Can be overridden by individual address substitutions.
gmSilentPush :: Lens' GCMMessage (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.
gmImageIconURL :: Lens' GCMMessage (Maybe Text) Source #
The URL that points to an image used as the large icon to the notification content view.
gmPriority :: Lens' GCMMessage (Maybe Text) Source #
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) Source #
The Raw JSON formatted string to be used as the payload. This value overrides the message.
gmData :: Lens' GCMMessage (HashMap Text Text) Source #
The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
gmRestrictedPackageName :: Lens' GCMMessage (Maybe Text) Source #
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) Source #
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) Source #
The message body of the notification, the email body or the text message.
gmTimeToLive :: Lens' GCMMessage (Maybe Int) Source #
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) Source #
The URL to open in the user's mobile browser. Used if the value for Action is URL.
gmSound :: Lens' GCMMessage (Maybe Text) Source #
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) 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. Possible values include: OPEN_APP | DEEP_LINK | URL
gmCollapseKey :: Lens' GCMMessage (Maybe Text) Source #
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) Source #
The URL that points to an image used in the push notification.
gmTitle :: Lens' GCMMessage (Maybe Text) Source #
The message title that displays above the message on the user's device.
gmIconReference :: Lens' GCMMessage (Maybe Text) Source #
The icon image name of the asset saved in your application.
ImportJobRequest
data ImportJobRequest Source #
See: importJobRequest smart constructor.
Instances
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- 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) 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 #
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) 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.
Instances
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- 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) 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 #
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) 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.
Instances
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 #
Import job list.
See: importJobsResponse smart constructor.
Instances
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.
Instances
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) 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.
mRawContent :: Lens' Message (Maybe Text) Source #
The Raw JSON formatted string to be used as the payload. This value overrides the message.
mImageSmallIconURL :: Lens' Message (Maybe Text) Source #
The URL that points to the small 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 #
Simple message object.
See: messageBody smart constructor.
Instances
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- The unique message body ID.mbMessage- The error message returned from the API.
mbRequestId :: Lens' MessageBody (Maybe Text) Source #
The unique message body ID.
MessageConfiguration
data MessageConfiguration Source #
Message configuration for a campaign.
See: messageConfiguration smart constructor.
Instances
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.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) 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.
mcADMMessage :: Lens' MessageConfiguration (Maybe Message) Source #
The message that the campaign delivers to ADM channels. Overrides the default message.
mcSMSMessage :: Lens' MessageConfiguration (Maybe CampaignSmsMessage) Source #
The SMS message configuration.
mcEmailMessage :: Lens' MessageConfiguration (Maybe CampaignEmailMessage) Source #
The email message configuration.
mcBaiduMessage :: Lens' MessageConfiguration (Maybe Message) Source #
The message that the campaign delivers to Baidu channels. Overrides the default message.
MessageRequest
data MessageRequest Source #
Send message request.
See: messageRequest smart constructor.
Instances
messageRequest :: MessageRequest Source #
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) Source #
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) Source #
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) Source #
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 :: Lens' MessageRequest (Maybe DirectMessageConfiguration) Source #
Message configuration.
MessageResponse
data MessageResponse Source #
Send message response.
See: messageResponse smart constructor.
Instances
messageResponse :: MessageResponse Source #
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) Source #
Original request Id for which this message was delivered.
mResult :: Lens' MessageResponse (HashMap Text MessageResult) Source #
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) Source #
Application id of the message.
mEndpointResult :: Lens' MessageResponse (HashMap Text EndpointMessageResult) Source #
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 Source #
The result from sending a message to an address.
See: messageResult smart constructor.
Instances
messageResult :: MessageResult Source #
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- Delivery status of message.mrStatusMessage- Status message for message delivery.mrUpdatedToken- If token was updated as part of delivery. (This is GCM Specific)mrStatusCode- Downstream service status code.
mrDeliveryStatus :: Lens' MessageResult (Maybe DeliveryStatus) Source #
Delivery status of message.
mrStatusMessage :: Lens' MessageResult (Maybe Text) Source #
Status message for message delivery.
mrUpdatedToken :: Lens' MessageResult (Maybe Text) Source #
If token was updated as part of delivery. (This is GCM Specific)
mrStatusCode :: Lens' MessageResult (Maybe Int) Source #
Downstream service status code.
QuietTime
Quiet Time
See: quietTime smart constructor.
Instances
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 #
Define how a segment based on recency of use.
See: recencyDimension smart constructor.
Instances
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
SMSChannelRequest
data SMSChannelRequest Source #
SMS Channel Request
See: sMSChannelRequest smart constructor.
Instances
sMSChannelRequest :: SMSChannelRequest Source #
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- ShortCode registered with phone provider.smscrEnabled- If the channel is enabled for sending messages.smscrSenderId- Sender identifier of your messages.
smscrShortCode :: Lens' SMSChannelRequest (Maybe Text) Source #
ShortCode registered with phone provider.
smscrEnabled :: Lens' SMSChannelRequest (Maybe Bool) Source #
If the channel is enabled for sending messages.
smscrSenderId :: Lens' SMSChannelRequest (Maybe Text) Source #
Sender identifier of your messages.
SMSChannelResponse
data SMSChannelResponse Source #
SMS Channel Response.
See: sMSChannelResponse smart constructor.
Instances
sMSChannelResponse :: SMSChannelResponse Source #
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- Platform type. Will be SMSsmscShortCode- The short code registered with the phone provider.smscLastModifiedDate- Last date this was updatedsmscEnabled- If the channel is enabled for sending messages.smscSenderId- Sender identifier of your messages.smscIsArchived- Is this channel archivedsmscApplicationId- The unique ID of the application to which the SMS channel belongs.smscVersion- Version of channelsmscId- Channel ID. Not used, only for backwards compatibility.smscCreationDate- The date that the settings were last updated in ISO 8601 format.smscLastModifiedBy- Who last updated this entrysmscHasCredential- If the channel is registered with a credential for authentication.
smscPlatform :: Lens' SMSChannelResponse (Maybe Text) Source #
Platform type. Will be SMS
smscShortCode :: Lens' SMSChannelResponse (Maybe Text) Source #
The short code registered with the phone provider.
smscLastModifiedDate :: Lens' SMSChannelResponse (Maybe Text) Source #
Last date this was updated
smscEnabled :: Lens' SMSChannelResponse (Maybe Bool) Source #
If the channel is enabled for sending messages.
smscSenderId :: Lens' SMSChannelResponse (Maybe Text) Source #
Sender identifier of your messages.
smscIsArchived :: Lens' SMSChannelResponse (Maybe Bool) Source #
Is this channel archived
smscApplicationId :: Lens' SMSChannelResponse (Maybe Text) Source #
The unique ID of the application to which the SMS channel belongs.
smscVersion :: Lens' SMSChannelResponse (Maybe Int) Source #
Version of channel
smscId :: Lens' SMSChannelResponse (Maybe Text) Source #
Channel ID. Not used, only for backwards compatibility.
smscCreationDate :: Lens' SMSChannelResponse (Maybe Text) Source #
The date that the settings were last updated in ISO 8601 format.
smscLastModifiedBy :: Lens' SMSChannelResponse (Maybe Text) Source #
Who last updated this entry
smscHasCredential :: Lens' SMSChannelResponse (Maybe Bool) Source #
If the channel is registered with a credential for authentication.
SMSMessage
data SMSMessage Source #
SMS Message.
See: sMSMessage smart constructor.
Instances
sMSMessage :: SMSMessage Source #
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]) Source #
Default message substitutions. Can be overridden by individual address substitutions.
smsmOriginationNumber :: Lens' SMSMessage (Maybe Text) Source #
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) Source #
The message body of the notification, the email body or the text message.
smsmMessageType :: Lens' SMSMessage (Maybe MessageType) Source #
Is this a transaction priority message or lower priority.
smsmSenderId :: Lens' SMSMessage (Maybe Text) Source #
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
Shcedule that defines when a campaign is run.
See: schedule smart constructor.
Instances
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 #
Segment behavior dimensions
See: segmentBehaviors smart constructor.
Instances
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 #
Segment demographic dimensions
See: segmentDemographics smart constructor.
Instances
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.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) Source #
The device platform criteria for the segment.
sdAppVersion :: Lens' SegmentDemographics (Maybe SetDimension) Source #
The app version criteria for the segment.
sdChannel :: Lens' SegmentDemographics (Maybe SetDimension) Source #
The channel 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 #
Segment dimensions
See: segmentDimensions smart constructor.
Instances
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.sdUserAttributes- Custom segment user 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.
sdUserAttributes :: Lens' SegmentDimensions (HashMap Text AttributeDimension) Source #
Custom segment user 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 #
Segment import definition.
See: segmentImportResource smart constructor.
Instances
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, JSONsirChannelCounts- Channel type countssirExternalId- 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) 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
sirChannelCounts :: Lens' SegmentImportResource (HashMap Text Int) Source #
Channel type counts
sirExternalId :: Lens' SegmentImportResource (Maybe Text) Source #
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) 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 #
Segment location dimensions
See: segmentLocation smart constructor.
Instances
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 #
Segment definition.
See: segmentResponse smart constructor.
Instances
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 #
Segments in your account.
See: segmentsResponse smart constructor.
Instances
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.
SendUsersMessageRequest
data SendUsersMessageRequest Source #
Send message request.
See: sendUsersMessageRequest smart constructor.
Instances
sendUsersMessageRequest :: SendUsersMessageRequest Source #
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) Source #
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) Source #
A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value.
sumrMessageConfiguration :: Lens' SendUsersMessageRequest (Maybe DirectMessageConfiguration) Source #
Message configuration.
SendUsersMessageResponse
data SendUsersMessageResponse Source #
User send message response.
See: sendUsersMessageResponse smart constructor.
Instances
sendUsersMessageResponse :: SendUsersMessageResponse Source #
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) Source #
Original request Id for which this message was delivered.
sumResult :: Lens' SendUsersMessageResponse (HashMap Text (HashMap Text EndpointMessageResult)) Source #
A map containing of UserId to Map of EndpointId to Endpoint Message Result.
sumApplicationId :: Lens' SendUsersMessageResponse (Maybe Text) Source #
Application id of the message.
SetDimension
data SetDimension Source #
Dimension specification of a segment.
See: setDimension smart constructor.
Instances
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 #
Treatment resource
See: treatmentResource smart constructor.
Instances
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 #
Creating application setting request
See: writeApplicationSettingsRequest smart constructor.
Instances
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.wasrCampaignHook- Default campaign hook information.
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.
wasrCampaignHook :: Lens' WriteApplicationSettingsRequest (Maybe CampaignHook) Source #
Default campaign hook information.
WriteCampaignRequest
data WriteCampaignRequest Source #
Used to create a campaign.
See: writeCampaignRequest smart constructor.
Instances
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.wcrHook- Campaign hook information.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.
wcrHook :: Lens' WriteCampaignRequest (Maybe CampaignHook) Source #
Campaign hook information.
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.
WriteEventStream
data WriteEventStream Source #
Request to save an EventStream.
See: writeEventStream smart constructor.
Instances
writeEventStream :: WriteEventStream Source #
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_NAMEwesRoleARN- The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.
wesDestinationStreamARN :: Lens' WriteEventStream (Maybe Text) Source #
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) Source #
The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.
WriteSegmentRequest
data WriteSegmentRequest Source #
Segment definition.
See: writeSegmentRequest smart constructor.
Instances
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 #
Used to create a campaign treatment.
See: writeTreatmentResource smart constructor.
Instances
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.