| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Pinpoint.Types
Contents
- Service Configuration
- Errors
- Action
- Alignment
- AttributeType
- ButtonAction
- CampaignStatus
- ChannelType
- DayOfWeek
- DefinitionFormat
- DeliveryStatus
- DimensionType
- Duration
- EndpointTypesElement
- FilterType
- Frequency
- Include
- JobStatus
- Layout
- MessageType
- Mode
- Operator
- RecencyType
- SegmentType
- SourceType
- State
- TemplateType
- Type
- ADMChannelRequest
- ADMChannelResponse
- ADMMessage
- APNSChannelRequest
- APNSChannelResponse
- APNSMessage
- APNSPushNotificationTemplate
- APNSSandboxChannelRequest
- APNSSandboxChannelResponse
- APNSVoipChannelRequest
- APNSVoipChannelResponse
- APNSVoipSandboxChannelRequest
- APNSVoipSandboxChannelResponse
- ActivitiesResponse
- Activity
- ActivityResponse
- AddressConfiguration
- AndroidPushNotificationTemplate
- ApplicationDateRangeKpiResponse
- ApplicationResponse
- ApplicationSettingsResource
- ApplicationsResponse
- AttributeDimension
- AttributesResource
- BaiduChannelRequest
- BaiduChannelResponse
- BaiduMessage
- BaseKpiResult
- CampaignCustomMessage
- CampaignDateRangeKpiResponse
- CampaignEmailMessage
- CampaignEventFilter
- CampaignHook
- CampaignInAppMessage
- CampaignLimits
- CampaignResponse
- CampaignSmsMessage
- CampaignState
- CampaignsResponse
- ChannelResponse
- ChannelsResponse
- ClosedDays
- ClosedDaysRule
- Condition
- ConditionalSplitActivity
- ContactCenterActivity
- CreateApplicationRequest
- CreateRecommenderConfiguration
- CreateTemplateMessageBody
- CustomDeliveryConfiguration
- CustomMessageActivity
- DefaultButtonConfiguration
- DefaultMessage
- DefaultPushNotificationMessage
- DefaultPushNotificationTemplate
- DirectMessageConfiguration
- EmailChannelRequest
- EmailChannelResponse
- EmailMessage
- EmailMessageActivity
- EmailTemplateRequest
- EmailTemplateResponse
- EndpointBatchItem
- EndpointBatchRequest
- EndpointDemographic
- EndpointItemResponse
- EndpointLocation
- EndpointMessageResult
- EndpointRequest
- EndpointResponse
- EndpointSendConfiguration
- EndpointUser
- EndpointsResponse
- Event
- EventCondition
- EventDimensions
- EventFilter
- EventItemResponse
- EventStartCondition
- EventStream
- EventsBatch
- EventsRequest
- EventsResponse
- ExportJobRequest
- ExportJobResource
- ExportJobResponse
- ExportJobsResponse
- GCMChannelRequest
- GCMChannelResponse
- GCMMessage
- GPSCoordinates
- GPSPointDimension
- HoldoutActivity
- ImportJobRequest
- ImportJobResource
- ImportJobResponse
- ImportJobsResponse
- InAppCampaignSchedule
- InAppMessage
- InAppMessageBodyConfig
- InAppMessageButton
- InAppMessageCampaign
- InAppMessageContent
- InAppMessageHeaderConfig
- InAppMessagesResponse
- InAppTemplateRequest
- InAppTemplateResponse
- ItemResponse
- JourneyChannelSettings
- JourneyCustomMessage
- JourneyDateRangeKpiResponse
- JourneyEmailMessage
- JourneyExecutionActivityMetricsResponse
- JourneyExecutionMetricsResponse
- JourneyLimits
- JourneyPushMessage
- JourneyResponse
- JourneySMSMessage
- JourneySchedule
- JourneyStateRequest
- JourneysResponse
- ListRecommenderConfigurationsResponse
- Message
- MessageBody
- MessageConfiguration
- MessageRequest
- MessageResponse
- MessageResult
- MetricDimension
- MultiConditionalBranch
- MultiConditionalSplitActivity
- NumberValidateRequest
- NumberValidateResponse
- OpenHours
- OpenHoursRule
- OverrideButtonConfiguration
- PublicEndpoint
- PushMessageActivity
- PushNotificationTemplateRequest
- PushNotificationTemplateResponse
- QuietTime
- RandomSplitActivity
- RandomSplitEntry
- RawEmail
- RecencyDimension
- RecommenderConfigurationResponse
- ResultRow
- ResultRowValue
- SMSChannelRequest
- SMSChannelResponse
- SMSMessage
- SMSMessageActivity
- SMSTemplateRequest
- SMSTemplateResponse
- Schedule
- SegmentBehaviors
- SegmentCondition
- SegmentDemographics
- SegmentDimensions
- SegmentGroup
- SegmentGroupList
- SegmentImportResource
- SegmentLocation
- SegmentReference
- SegmentResponse
- SegmentsResponse
- SendOTPMessageRequestParameters
- SendUsersMessageRequest
- SendUsersMessageResponse
- Session
- SetDimension
- SimpleCondition
- SimpleEmail
- SimpleEmailPart
- StartCondition
- TagsModel
- Template
- TemplateActiveVersionRequest
- TemplateConfiguration
- TemplateCreateMessageBody
- TemplateResponse
- TemplateVersionResponse
- TemplateVersionsResponse
- TemplatesResponse
- TreatmentResource
- UpdateAttributesRequest
- UpdateRecommenderConfiguration
- VerificationResponse
- VerifyOTPMessageRequestParameters
- VoiceChannelRequest
- VoiceChannelResponse
- VoiceMessage
- VoiceTemplateRequest
- VoiceTemplateResponse
- WaitActivity
- WaitTime
- WriteApplicationSettingsRequest
- WriteCampaignRequest
- WriteEventStream
- WriteJourneyRequest
- WriteSegmentRequest
- WriteTreatmentResource
Description
Synopsis
- defaultService :: Service
- _BadRequestException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _ForbiddenException :: AsError a => Fold a ServiceError
- _InternalServerErrorException :: AsError a => Fold a ServiceError
- _MethodNotAllowedException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _PayloadTooLargeException :: AsError a => Fold a ServiceError
- _TooManyRequestsException :: AsError a => Fold a ServiceError
- newtype Action where
- Action' {
- fromAction :: Text
- pattern Action_DEEP_LINK :: Action
- pattern Action_OPEN_APP :: Action
- pattern Action_URL :: Action
- Action' {
- newtype Alignment where
- Alignment' { }
- pattern Alignment_CENTER :: Alignment
- pattern Alignment_LEFT :: Alignment
- pattern Alignment_RIGHT :: Alignment
- newtype AttributeType where
- AttributeType' { }
- pattern AttributeType_AFTER :: AttributeType
- pattern AttributeType_BEFORE :: AttributeType
- pattern AttributeType_BETWEEN :: AttributeType
- pattern AttributeType_CONTAINS :: AttributeType
- pattern AttributeType_EXCLUSIVE :: AttributeType
- pattern AttributeType_INCLUSIVE :: AttributeType
- pattern AttributeType_ON :: AttributeType
- newtype ButtonAction where
- ButtonAction' { }
- pattern ButtonAction_CLOSE :: ButtonAction
- pattern ButtonAction_DEEP_LINK :: ButtonAction
- pattern ButtonAction_LINK :: ButtonAction
- newtype CampaignStatus where
- CampaignStatus' { }
- pattern CampaignStatus_COMPLETED :: CampaignStatus
- pattern CampaignStatus_DELETED :: CampaignStatus
- pattern CampaignStatus_EXECUTING :: CampaignStatus
- pattern CampaignStatus_INVALID :: CampaignStatus
- pattern CampaignStatus_PAUSED :: CampaignStatus
- pattern CampaignStatus_PENDING_NEXT_RUN :: CampaignStatus
- pattern CampaignStatus_SCHEDULED :: CampaignStatus
- newtype ChannelType where
- ChannelType' { }
- pattern ChannelType_ADM :: ChannelType
- pattern ChannelType_APNS :: ChannelType
- pattern ChannelType_APNS_SANDBOX :: ChannelType
- pattern ChannelType_APNS_VOIP :: ChannelType
- pattern ChannelType_APNS_VOIP_SANDBOX :: ChannelType
- pattern ChannelType_BAIDU :: ChannelType
- pattern ChannelType_CUSTOM :: ChannelType
- pattern ChannelType_EMAIL :: ChannelType
- pattern ChannelType_GCM :: ChannelType
- pattern ChannelType_IN_APP :: ChannelType
- pattern ChannelType_PUSH :: ChannelType
- pattern ChannelType_SMS :: ChannelType
- pattern ChannelType_VOICE :: ChannelType
- newtype DayOfWeek where
- DayOfWeek' { }
- pattern DayOfWeek_FRIDAY :: DayOfWeek
- pattern DayOfWeek_MONDAY :: DayOfWeek
- pattern DayOfWeek_SATURDAY :: DayOfWeek
- pattern DayOfWeek_SUNDAY :: DayOfWeek
- pattern DayOfWeek_THURSDAY :: DayOfWeek
- pattern DayOfWeek_TUESDAY :: DayOfWeek
- pattern DayOfWeek_WEDNESDAY :: DayOfWeek
- newtype DefinitionFormat where
- DefinitionFormat' { }
- pattern DefinitionFormat_CSV :: DefinitionFormat
- pattern DefinitionFormat_JSON :: DefinitionFormat
- newtype DeliveryStatus where
- DeliveryStatus' { }
- pattern DeliveryStatus_DUPLICATE :: DeliveryStatus
- pattern DeliveryStatus_OPT_OUT :: DeliveryStatus
- pattern DeliveryStatus_PERMANENT_FAILURE :: DeliveryStatus
- pattern DeliveryStatus_SUCCESSFUL :: DeliveryStatus
- pattern DeliveryStatus_TEMPORARY_FAILURE :: DeliveryStatus
- pattern DeliveryStatus_THROTTLED :: DeliveryStatus
- pattern DeliveryStatus_UNKNOWN_FAILURE :: DeliveryStatus
- newtype DimensionType where
- DimensionType' { }
- pattern DimensionType_EXCLUSIVE :: DimensionType
- pattern DimensionType_INCLUSIVE :: DimensionType
- newtype Duration where
- Duration' {
- fromDuration :: Text
- pattern Duration_DAY_14 :: Duration
- pattern Duration_DAY_30 :: Duration
- pattern Duration_DAY_7 :: Duration
- pattern Duration_HR_24 :: Duration
- Duration' {
- newtype EndpointTypesElement where
- EndpointTypesElement' { }
- pattern EndpointTypesElement_ADM :: EndpointTypesElement
- pattern EndpointTypesElement_APNS :: EndpointTypesElement
- pattern EndpointTypesElement_APNS_SANDBOX :: EndpointTypesElement
- pattern EndpointTypesElement_APNS_VOIP :: EndpointTypesElement
- pattern EndpointTypesElement_APNS_VOIP_SANDBOX :: EndpointTypesElement
- pattern EndpointTypesElement_BAIDU :: EndpointTypesElement
- pattern EndpointTypesElement_CUSTOM :: EndpointTypesElement
- pattern EndpointTypesElement_EMAIL :: EndpointTypesElement
- pattern EndpointTypesElement_GCM :: EndpointTypesElement
- pattern EndpointTypesElement_IN_APP :: EndpointTypesElement
- pattern EndpointTypesElement_PUSH :: EndpointTypesElement
- pattern EndpointTypesElement_SMS :: EndpointTypesElement
- pattern EndpointTypesElement_VOICE :: EndpointTypesElement
- newtype FilterType where
- FilterType' { }
- pattern FilterType_ENDPOINT :: FilterType
- pattern FilterType_SYSTEM :: FilterType
- newtype Frequency where
- Frequency' { }
- pattern Frequency_DAILY :: Frequency
- pattern Frequency_EVENT :: Frequency
- pattern Frequency_HOURLY :: Frequency
- pattern Frequency_IN_APP_EVENT :: Frequency
- pattern Frequency_MONTHLY :: Frequency
- pattern Frequency_ONCE :: Frequency
- pattern Frequency_WEEKLY :: Frequency
- newtype Include where
- Include' {
- fromInclude :: Text
- pattern Include_ALL :: Include
- pattern Include_ANY :: Include
- pattern Include_NONE :: Include
- Include' {
- newtype JobStatus where
- JobStatus' { }
- pattern JobStatus_COMPLETED :: JobStatus
- pattern JobStatus_COMPLETING :: JobStatus
- pattern JobStatus_CREATED :: JobStatus
- pattern JobStatus_FAILED :: JobStatus
- pattern JobStatus_FAILING :: JobStatus
- pattern JobStatus_INITIALIZING :: JobStatus
- pattern JobStatus_PENDING_JOB :: JobStatus
- pattern JobStatus_PREPARING_FOR_INITIALIZATION :: JobStatus
- pattern JobStatus_PROCESSING :: JobStatus
- newtype Layout where
- Layout' {
- fromLayout :: Text
- pattern Layout_BOTTOM_BANNER :: Layout
- pattern Layout_CAROUSEL :: Layout
- pattern Layout_MIDDLE_BANNER :: Layout
- pattern Layout_MOBILE_FEED :: Layout
- pattern Layout_OVERLAYS :: Layout
- pattern Layout_TOP_BANNER :: Layout
- Layout' {
- newtype MessageType where
- MessageType' { }
- pattern MessageType_PROMOTIONAL :: MessageType
- pattern MessageType_TRANSACTIONAL :: MessageType
- newtype Mode where
- Mode' { }
- pattern Mode_DELIVERY :: Mode
- pattern Mode_FILTER :: Mode
- newtype Operator where
- Operator' {
- fromOperator :: Text
- pattern Operator_ALL :: Operator
- pattern Operator_ANY :: Operator
- Operator' {
- newtype RecencyType where
- RecencyType' { }
- pattern RecencyType_ACTIVE :: RecencyType
- pattern RecencyType_INACTIVE :: RecencyType
- newtype SegmentType where
- SegmentType' { }
- pattern SegmentType_DIMENSIONAL :: SegmentType
- pattern SegmentType_IMPORT :: SegmentType
- newtype SourceType where
- SourceType' { }
- pattern SourceType_ALL :: SourceType
- pattern SourceType_ANY :: SourceType
- pattern SourceType_NONE :: SourceType
- newtype State where
- State' { }
- pattern State_ACTIVE :: State
- pattern State_CANCELLED :: State
- pattern State_CLOSED :: State
- pattern State_COMPLETED :: State
- pattern State_DRAFT :: State
- pattern State_PAUSED :: State
- newtype TemplateType where
- TemplateType' { }
- pattern TemplateType_EMAIL :: TemplateType
- pattern TemplateType_INAPP :: TemplateType
- pattern TemplateType_PUSH :: TemplateType
- pattern TemplateType_SMS :: TemplateType
- pattern TemplateType_VOICE :: TemplateType
- newtype Type where
- data ADMChannelRequest = ADMChannelRequest' {}
- newADMChannelRequest :: Text -> Text -> ADMChannelRequest
- aDMChannelRequest_enabled :: Lens' ADMChannelRequest (Maybe Bool)
- aDMChannelRequest_clientSecret :: Lens' ADMChannelRequest Text
- aDMChannelRequest_clientId :: Lens' ADMChannelRequest Text
- data ADMChannelResponse = ADMChannelResponse' {
- applicationId :: Maybe Text
- creationDate :: Maybe Text
- enabled :: Maybe Bool
- hasCredential :: Maybe Bool
- id :: Maybe Text
- isArchived :: Maybe Bool
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe Text
- version :: Maybe Int
- platform :: Text
- newADMChannelResponse :: Text -> ADMChannelResponse
- aDMChannelResponse_applicationId :: Lens' ADMChannelResponse (Maybe Text)
- aDMChannelResponse_creationDate :: Lens' ADMChannelResponse (Maybe Text)
- aDMChannelResponse_enabled :: Lens' ADMChannelResponse (Maybe Bool)
- aDMChannelResponse_hasCredential :: Lens' ADMChannelResponse (Maybe Bool)
- aDMChannelResponse_id :: Lens' ADMChannelResponse (Maybe Text)
- aDMChannelResponse_isArchived :: Lens' ADMChannelResponse (Maybe Bool)
- aDMChannelResponse_lastModifiedBy :: Lens' ADMChannelResponse (Maybe Text)
- aDMChannelResponse_lastModifiedDate :: Lens' ADMChannelResponse (Maybe Text)
- aDMChannelResponse_version :: Lens' ADMChannelResponse (Maybe Int)
- aDMChannelResponse_platform :: Lens' ADMChannelResponse Text
- data ADMMessage = ADMMessage' {
- action :: Maybe Action
- body :: Maybe Text
- consolidationKey :: Maybe Text
- data' :: Maybe (HashMap Text Text)
- expiresAfter :: Maybe Text
- iconReference :: Maybe Text
- imageIconUrl :: Maybe Text
- imageUrl :: Maybe Text
- md5 :: Maybe Text
- rawContent :: Maybe Text
- silentPush :: Maybe Bool
- smallImageIconUrl :: Maybe Text
- sound :: Maybe Text
- substitutions :: Maybe (HashMap Text [Text])
- title :: Maybe Text
- url :: Maybe Text
- newADMMessage :: ADMMessage
- aDMMessage_action :: Lens' ADMMessage (Maybe Action)
- aDMMessage_body :: Lens' ADMMessage (Maybe Text)
- aDMMessage_consolidationKey :: Lens' ADMMessage (Maybe Text)
- aDMMessage_data :: Lens' ADMMessage (Maybe (HashMap Text Text))
- aDMMessage_expiresAfter :: Lens' ADMMessage (Maybe Text)
- aDMMessage_iconReference :: Lens' ADMMessage (Maybe Text)
- aDMMessage_imageIconUrl :: Lens' ADMMessage (Maybe Text)
- aDMMessage_imageUrl :: Lens' ADMMessage (Maybe Text)
- aDMMessage_md5 :: Lens' ADMMessage (Maybe Text)
- aDMMessage_rawContent :: Lens' ADMMessage (Maybe Text)
- aDMMessage_silentPush :: Lens' ADMMessage (Maybe Bool)
- aDMMessage_smallImageIconUrl :: Lens' ADMMessage (Maybe Text)
- aDMMessage_sound :: Lens' ADMMessage (Maybe Text)
- aDMMessage_substitutions :: Lens' ADMMessage (Maybe (HashMap Text [Text]))
- aDMMessage_title :: Lens' ADMMessage (Maybe Text)
- aDMMessage_url :: Lens' ADMMessage (Maybe Text)
- data APNSChannelRequest = APNSChannelRequest' {}
- newAPNSChannelRequest :: APNSChannelRequest
- aPNSChannelRequest_bundleId :: Lens' APNSChannelRequest (Maybe Text)
- aPNSChannelRequest_certificate :: Lens' APNSChannelRequest (Maybe Text)
- aPNSChannelRequest_defaultAuthenticationMethod :: Lens' APNSChannelRequest (Maybe Text)
- aPNSChannelRequest_enabled :: Lens' APNSChannelRequest (Maybe Bool)
- aPNSChannelRequest_privateKey :: Lens' APNSChannelRequest (Maybe Text)
- aPNSChannelRequest_teamId :: Lens' APNSChannelRequest (Maybe Text)
- aPNSChannelRequest_tokenKey :: Lens' APNSChannelRequest (Maybe Text)
- aPNSChannelRequest_tokenKeyId :: Lens' APNSChannelRequest (Maybe Text)
- data APNSChannelResponse = APNSChannelResponse' {
- applicationId :: Maybe Text
- creationDate :: Maybe Text
- defaultAuthenticationMethod :: Maybe Text
- enabled :: Maybe Bool
- hasCredential :: Maybe Bool
- hasTokenKey :: Maybe Bool
- id :: Maybe Text
- isArchived :: Maybe Bool
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe Text
- version :: Maybe Int
- platform :: Text
- newAPNSChannelResponse :: Text -> APNSChannelResponse
- aPNSChannelResponse_applicationId :: Lens' APNSChannelResponse (Maybe Text)
- aPNSChannelResponse_creationDate :: Lens' APNSChannelResponse (Maybe Text)
- aPNSChannelResponse_defaultAuthenticationMethod :: Lens' APNSChannelResponse (Maybe Text)
- aPNSChannelResponse_enabled :: Lens' APNSChannelResponse (Maybe Bool)
- aPNSChannelResponse_hasCredential :: Lens' APNSChannelResponse (Maybe Bool)
- aPNSChannelResponse_hasTokenKey :: Lens' APNSChannelResponse (Maybe Bool)
- aPNSChannelResponse_id :: Lens' APNSChannelResponse (Maybe Text)
- aPNSChannelResponse_isArchived :: Lens' APNSChannelResponse (Maybe Bool)
- aPNSChannelResponse_lastModifiedBy :: Lens' APNSChannelResponse (Maybe Text)
- aPNSChannelResponse_lastModifiedDate :: Lens' APNSChannelResponse (Maybe Text)
- aPNSChannelResponse_version :: Lens' APNSChannelResponse (Maybe Int)
- aPNSChannelResponse_platform :: Lens' APNSChannelResponse Text
- data APNSMessage = APNSMessage' {
- aPNSPushType :: Maybe Text
- action :: Maybe Action
- badge :: Maybe Int
- body :: Maybe Text
- category :: Maybe Text
- collapseId :: Maybe Text
- data' :: Maybe (HashMap Text Text)
- mediaUrl :: Maybe Text
- preferredAuthenticationMethod :: Maybe Text
- priority :: Maybe Text
- rawContent :: Maybe Text
- silentPush :: Maybe Bool
- sound :: Maybe Text
- substitutions :: Maybe (HashMap Text [Text])
- threadId :: Maybe Text
- timeToLive :: Maybe Int
- title :: Maybe Text
- url :: Maybe Text
- newAPNSMessage :: APNSMessage
- aPNSMessage_aPNSPushType :: Lens' APNSMessage (Maybe Text)
- aPNSMessage_action :: Lens' APNSMessage (Maybe Action)
- aPNSMessage_badge :: Lens' APNSMessage (Maybe Int)
- aPNSMessage_body :: Lens' APNSMessage (Maybe Text)
- aPNSMessage_category :: Lens' APNSMessage (Maybe Text)
- aPNSMessage_collapseId :: Lens' APNSMessage (Maybe Text)
- aPNSMessage_data :: Lens' APNSMessage (Maybe (HashMap Text Text))
- aPNSMessage_mediaUrl :: Lens' APNSMessage (Maybe Text)
- aPNSMessage_preferredAuthenticationMethod :: Lens' APNSMessage (Maybe Text)
- aPNSMessage_priority :: Lens' APNSMessage (Maybe Text)
- aPNSMessage_rawContent :: Lens' APNSMessage (Maybe Text)
- aPNSMessage_silentPush :: Lens' APNSMessage (Maybe Bool)
- aPNSMessage_sound :: Lens' APNSMessage (Maybe Text)
- aPNSMessage_substitutions :: Lens' APNSMessage (Maybe (HashMap Text [Text]))
- aPNSMessage_threadId :: Lens' APNSMessage (Maybe Text)
- aPNSMessage_timeToLive :: Lens' APNSMessage (Maybe Int)
- aPNSMessage_title :: Lens' APNSMessage (Maybe Text)
- aPNSMessage_url :: Lens' APNSMessage (Maybe Text)
- data APNSPushNotificationTemplate = APNSPushNotificationTemplate' {}
- newAPNSPushNotificationTemplate :: APNSPushNotificationTemplate
- aPNSPushNotificationTemplate_action :: Lens' APNSPushNotificationTemplate (Maybe Action)
- aPNSPushNotificationTemplate_body :: Lens' APNSPushNotificationTemplate (Maybe Text)
- aPNSPushNotificationTemplate_mediaUrl :: Lens' APNSPushNotificationTemplate (Maybe Text)
- aPNSPushNotificationTemplate_rawContent :: Lens' APNSPushNotificationTemplate (Maybe Text)
- aPNSPushNotificationTemplate_sound :: Lens' APNSPushNotificationTemplate (Maybe Text)
- aPNSPushNotificationTemplate_title :: Lens' APNSPushNotificationTemplate (Maybe Text)
- aPNSPushNotificationTemplate_url :: Lens' APNSPushNotificationTemplate (Maybe Text)
- data APNSSandboxChannelRequest = APNSSandboxChannelRequest' {}
- newAPNSSandboxChannelRequest :: APNSSandboxChannelRequest
- aPNSSandboxChannelRequest_bundleId :: Lens' APNSSandboxChannelRequest (Maybe Text)
- aPNSSandboxChannelRequest_certificate :: Lens' APNSSandboxChannelRequest (Maybe Text)
- aPNSSandboxChannelRequest_defaultAuthenticationMethod :: Lens' APNSSandboxChannelRequest (Maybe Text)
- aPNSSandboxChannelRequest_enabled :: Lens' APNSSandboxChannelRequest (Maybe Bool)
- aPNSSandboxChannelRequest_privateKey :: Lens' APNSSandboxChannelRequest (Maybe Text)
- aPNSSandboxChannelRequest_teamId :: Lens' APNSSandboxChannelRequest (Maybe Text)
- aPNSSandboxChannelRequest_tokenKey :: Lens' APNSSandboxChannelRequest (Maybe Text)
- aPNSSandboxChannelRequest_tokenKeyId :: Lens' APNSSandboxChannelRequest (Maybe Text)
- data APNSSandboxChannelResponse = APNSSandboxChannelResponse' {
- applicationId :: Maybe Text
- creationDate :: Maybe Text
- defaultAuthenticationMethod :: Maybe Text
- enabled :: Maybe Bool
- hasCredential :: Maybe Bool
- hasTokenKey :: Maybe Bool
- id :: Maybe Text
- isArchived :: Maybe Bool
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe Text
- version :: Maybe Int
- platform :: Text
- newAPNSSandboxChannelResponse :: Text -> APNSSandboxChannelResponse
- aPNSSandboxChannelResponse_applicationId :: Lens' APNSSandboxChannelResponse (Maybe Text)
- aPNSSandboxChannelResponse_creationDate :: Lens' APNSSandboxChannelResponse (Maybe Text)
- aPNSSandboxChannelResponse_defaultAuthenticationMethod :: Lens' APNSSandboxChannelResponse (Maybe Text)
- aPNSSandboxChannelResponse_enabled :: Lens' APNSSandboxChannelResponse (Maybe Bool)
- aPNSSandboxChannelResponse_hasCredential :: Lens' APNSSandboxChannelResponse (Maybe Bool)
- aPNSSandboxChannelResponse_hasTokenKey :: Lens' APNSSandboxChannelResponse (Maybe Bool)
- aPNSSandboxChannelResponse_id :: Lens' APNSSandboxChannelResponse (Maybe Text)
- aPNSSandboxChannelResponse_isArchived :: Lens' APNSSandboxChannelResponse (Maybe Bool)
- aPNSSandboxChannelResponse_lastModifiedBy :: Lens' APNSSandboxChannelResponse (Maybe Text)
- aPNSSandboxChannelResponse_lastModifiedDate :: Lens' APNSSandboxChannelResponse (Maybe Text)
- aPNSSandboxChannelResponse_version :: Lens' APNSSandboxChannelResponse (Maybe Int)
- aPNSSandboxChannelResponse_platform :: Lens' APNSSandboxChannelResponse Text
- data APNSVoipChannelRequest = APNSVoipChannelRequest' {}
- newAPNSVoipChannelRequest :: APNSVoipChannelRequest
- aPNSVoipChannelRequest_bundleId :: Lens' APNSVoipChannelRequest (Maybe Text)
- aPNSVoipChannelRequest_certificate :: Lens' APNSVoipChannelRequest (Maybe Text)
- aPNSVoipChannelRequest_defaultAuthenticationMethod :: Lens' APNSVoipChannelRequest (Maybe Text)
- aPNSVoipChannelRequest_enabled :: Lens' APNSVoipChannelRequest (Maybe Bool)
- aPNSVoipChannelRequest_privateKey :: Lens' APNSVoipChannelRequest (Maybe Text)
- aPNSVoipChannelRequest_teamId :: Lens' APNSVoipChannelRequest (Maybe Text)
- aPNSVoipChannelRequest_tokenKey :: Lens' APNSVoipChannelRequest (Maybe Text)
- aPNSVoipChannelRequest_tokenKeyId :: Lens' APNSVoipChannelRequest (Maybe Text)
- data APNSVoipChannelResponse = APNSVoipChannelResponse' {
- applicationId :: Maybe Text
- creationDate :: Maybe Text
- defaultAuthenticationMethod :: Maybe Text
- enabled :: Maybe Bool
- hasCredential :: Maybe Bool
- hasTokenKey :: Maybe Bool
- id :: Maybe Text
- isArchived :: Maybe Bool
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe Text
- version :: Maybe Int
- platform :: Text
- newAPNSVoipChannelResponse :: Text -> APNSVoipChannelResponse
- aPNSVoipChannelResponse_applicationId :: Lens' APNSVoipChannelResponse (Maybe Text)
- aPNSVoipChannelResponse_creationDate :: Lens' APNSVoipChannelResponse (Maybe Text)
- aPNSVoipChannelResponse_defaultAuthenticationMethod :: Lens' APNSVoipChannelResponse (Maybe Text)
- aPNSVoipChannelResponse_enabled :: Lens' APNSVoipChannelResponse (Maybe Bool)
- aPNSVoipChannelResponse_hasCredential :: Lens' APNSVoipChannelResponse (Maybe Bool)
- aPNSVoipChannelResponse_hasTokenKey :: Lens' APNSVoipChannelResponse (Maybe Bool)
- aPNSVoipChannelResponse_id :: Lens' APNSVoipChannelResponse (Maybe Text)
- aPNSVoipChannelResponse_isArchived :: Lens' APNSVoipChannelResponse (Maybe Bool)
- aPNSVoipChannelResponse_lastModifiedBy :: Lens' APNSVoipChannelResponse (Maybe Text)
- aPNSVoipChannelResponse_lastModifiedDate :: Lens' APNSVoipChannelResponse (Maybe Text)
- aPNSVoipChannelResponse_version :: Lens' APNSVoipChannelResponse (Maybe Int)
- aPNSVoipChannelResponse_platform :: Lens' APNSVoipChannelResponse Text
- data APNSVoipSandboxChannelRequest = APNSVoipSandboxChannelRequest' {}
- newAPNSVoipSandboxChannelRequest :: APNSVoipSandboxChannelRequest
- aPNSVoipSandboxChannelRequest_bundleId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text)
- aPNSVoipSandboxChannelRequest_certificate :: Lens' APNSVoipSandboxChannelRequest (Maybe Text)
- aPNSVoipSandboxChannelRequest_defaultAuthenticationMethod :: Lens' APNSVoipSandboxChannelRequest (Maybe Text)
- aPNSVoipSandboxChannelRequest_enabled :: Lens' APNSVoipSandboxChannelRequest (Maybe Bool)
- aPNSVoipSandboxChannelRequest_privateKey :: Lens' APNSVoipSandboxChannelRequest (Maybe Text)
- aPNSVoipSandboxChannelRequest_teamId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text)
- aPNSVoipSandboxChannelRequest_tokenKey :: Lens' APNSVoipSandboxChannelRequest (Maybe Text)
- aPNSVoipSandboxChannelRequest_tokenKeyId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text)
- data APNSVoipSandboxChannelResponse = APNSVoipSandboxChannelResponse' {
- applicationId :: Maybe Text
- creationDate :: Maybe Text
- defaultAuthenticationMethod :: Maybe Text
- enabled :: Maybe Bool
- hasCredential :: Maybe Bool
- hasTokenKey :: Maybe Bool
- id :: Maybe Text
- isArchived :: Maybe Bool
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe Text
- version :: Maybe Int
- platform :: Text
- newAPNSVoipSandboxChannelResponse :: Text -> APNSVoipSandboxChannelResponse
- aPNSVoipSandboxChannelResponse_applicationId :: Lens' APNSVoipSandboxChannelResponse (Maybe Text)
- aPNSVoipSandboxChannelResponse_creationDate :: Lens' APNSVoipSandboxChannelResponse (Maybe Text)
- aPNSVoipSandboxChannelResponse_defaultAuthenticationMethod :: Lens' APNSVoipSandboxChannelResponse (Maybe Text)
- aPNSVoipSandboxChannelResponse_enabled :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool)
- aPNSVoipSandboxChannelResponse_hasCredential :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool)
- aPNSVoipSandboxChannelResponse_hasTokenKey :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool)
- aPNSVoipSandboxChannelResponse_id :: Lens' APNSVoipSandboxChannelResponse (Maybe Text)
- aPNSVoipSandboxChannelResponse_isArchived :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool)
- aPNSVoipSandboxChannelResponse_lastModifiedBy :: Lens' APNSVoipSandboxChannelResponse (Maybe Text)
- aPNSVoipSandboxChannelResponse_lastModifiedDate :: Lens' APNSVoipSandboxChannelResponse (Maybe Text)
- aPNSVoipSandboxChannelResponse_version :: Lens' APNSVoipSandboxChannelResponse (Maybe Int)
- aPNSVoipSandboxChannelResponse_platform :: Lens' APNSVoipSandboxChannelResponse Text
- data ActivitiesResponse = ActivitiesResponse' {
- nextToken :: Maybe Text
- item :: [ActivityResponse]
- newActivitiesResponse :: ActivitiesResponse
- activitiesResponse_nextToken :: Lens' ActivitiesResponse (Maybe Text)
- activitiesResponse_item :: Lens' ActivitiesResponse [ActivityResponse]
- data Activity = Activity' {
- custom :: Maybe CustomMessageActivity
- conditionalSplit :: Maybe ConditionalSplitActivity
- contactCenter :: Maybe ContactCenterActivity
- description :: Maybe Text
- email :: Maybe EmailMessageActivity
- holdout :: Maybe HoldoutActivity
- multiCondition :: Maybe MultiConditionalSplitActivity
- push :: Maybe PushMessageActivity
- randomSplit :: Maybe RandomSplitActivity
- sms :: Maybe SMSMessageActivity
- wait :: Maybe WaitActivity
- newActivity :: Activity
- activity_custom :: Lens' Activity (Maybe CustomMessageActivity)
- activity_conditionalSplit :: Lens' Activity (Maybe ConditionalSplitActivity)
- activity_contactCenter :: Lens' Activity (Maybe ContactCenterActivity)
- activity_description :: Lens' Activity (Maybe Text)
- activity_email :: Lens' Activity (Maybe EmailMessageActivity)
- activity_holdout :: Lens' Activity (Maybe HoldoutActivity)
- activity_multiCondition :: Lens' Activity (Maybe MultiConditionalSplitActivity)
- activity_push :: Lens' Activity (Maybe PushMessageActivity)
- activity_randomSplit :: Lens' Activity (Maybe RandomSplitActivity)
- activity_sms :: Lens' Activity (Maybe SMSMessageActivity)
- activity_wait :: Lens' Activity (Maybe WaitActivity)
- data ActivityResponse = ActivityResponse' {
- end :: Maybe Text
- result :: Maybe Text
- scheduledStart :: Maybe Text
- start :: Maybe Text
- state :: Maybe Text
- successfulEndpointCount :: Maybe Int
- timezonesCompletedCount :: Maybe Int
- timezonesTotalCount :: Maybe Int
- totalEndpointCount :: Maybe Int
- treatmentId :: Maybe Text
- campaignId :: Text
- id :: Text
- applicationId :: Text
- newActivityResponse :: Text -> Text -> Text -> ActivityResponse
- activityResponse_end :: Lens' ActivityResponse (Maybe Text)
- activityResponse_result :: Lens' ActivityResponse (Maybe Text)
- activityResponse_scheduledStart :: Lens' ActivityResponse (Maybe Text)
- activityResponse_start :: Lens' ActivityResponse (Maybe Text)
- activityResponse_state :: Lens' ActivityResponse (Maybe Text)
- activityResponse_successfulEndpointCount :: Lens' ActivityResponse (Maybe Int)
- activityResponse_timezonesCompletedCount :: Lens' ActivityResponse (Maybe Int)
- activityResponse_timezonesTotalCount :: Lens' ActivityResponse (Maybe Int)
- activityResponse_totalEndpointCount :: Lens' ActivityResponse (Maybe Int)
- activityResponse_treatmentId :: Lens' ActivityResponse (Maybe Text)
- activityResponse_campaignId :: Lens' ActivityResponse Text
- activityResponse_id :: Lens' ActivityResponse Text
- activityResponse_applicationId :: Lens' ActivityResponse Text
- data AddressConfiguration = AddressConfiguration' {
- bodyOverride :: Maybe Text
- channelType :: Maybe ChannelType
- context :: Maybe (HashMap Text Text)
- rawContent :: Maybe Text
- substitutions :: Maybe (HashMap Text [Text])
- titleOverride :: Maybe Text
- newAddressConfiguration :: AddressConfiguration
- addressConfiguration_bodyOverride :: Lens' AddressConfiguration (Maybe Text)
- addressConfiguration_channelType :: Lens' AddressConfiguration (Maybe ChannelType)
- addressConfiguration_context :: Lens' AddressConfiguration (Maybe (HashMap Text Text))
- addressConfiguration_rawContent :: Lens' AddressConfiguration (Maybe Text)
- addressConfiguration_substitutions :: Lens' AddressConfiguration (Maybe (HashMap Text [Text]))
- addressConfiguration_titleOverride :: Lens' AddressConfiguration (Maybe Text)
- data AndroidPushNotificationTemplate = AndroidPushNotificationTemplate' {}
- newAndroidPushNotificationTemplate :: AndroidPushNotificationTemplate
- androidPushNotificationTemplate_action :: Lens' AndroidPushNotificationTemplate (Maybe Action)
- androidPushNotificationTemplate_body :: Lens' AndroidPushNotificationTemplate (Maybe Text)
- androidPushNotificationTemplate_imageIconUrl :: Lens' AndroidPushNotificationTemplate (Maybe Text)
- androidPushNotificationTemplate_imageUrl :: Lens' AndroidPushNotificationTemplate (Maybe Text)
- androidPushNotificationTemplate_rawContent :: Lens' AndroidPushNotificationTemplate (Maybe Text)
- androidPushNotificationTemplate_smallImageIconUrl :: Lens' AndroidPushNotificationTemplate (Maybe Text)
- androidPushNotificationTemplate_sound :: Lens' AndroidPushNotificationTemplate (Maybe Text)
- androidPushNotificationTemplate_title :: Lens' AndroidPushNotificationTemplate (Maybe Text)
- androidPushNotificationTemplate_url :: Lens' AndroidPushNotificationTemplate (Maybe Text)
- data ApplicationDateRangeKpiResponse = ApplicationDateRangeKpiResponse' {}
- newApplicationDateRangeKpiResponse :: BaseKpiResult -> Text -> UTCTime -> UTCTime -> Text -> ApplicationDateRangeKpiResponse
- applicationDateRangeKpiResponse_nextToken :: Lens' ApplicationDateRangeKpiResponse (Maybe Text)
- applicationDateRangeKpiResponse_kpiResult :: Lens' ApplicationDateRangeKpiResponse BaseKpiResult
- applicationDateRangeKpiResponse_kpiName :: Lens' ApplicationDateRangeKpiResponse Text
- applicationDateRangeKpiResponse_endTime :: Lens' ApplicationDateRangeKpiResponse UTCTime
- applicationDateRangeKpiResponse_startTime :: Lens' ApplicationDateRangeKpiResponse UTCTime
- applicationDateRangeKpiResponse_applicationId :: Lens' ApplicationDateRangeKpiResponse Text
- data ApplicationResponse = ApplicationResponse' {}
- newApplicationResponse :: Text -> Text -> Text -> ApplicationResponse
- applicationResponse_creationDate :: Lens' ApplicationResponse (Maybe Text)
- applicationResponse_tags :: Lens' ApplicationResponse (Maybe (HashMap Text Text))
- applicationResponse_id :: Lens' ApplicationResponse Text
- applicationResponse_arn :: Lens' ApplicationResponse Text
- applicationResponse_name :: Lens' ApplicationResponse Text
- data ApplicationSettingsResource = ApplicationSettingsResource' {}
- newApplicationSettingsResource :: Text -> ApplicationSettingsResource
- applicationSettingsResource_campaignHook :: Lens' ApplicationSettingsResource (Maybe CampaignHook)
- applicationSettingsResource_lastModifiedDate :: Lens' ApplicationSettingsResource (Maybe Text)
- applicationSettingsResource_limits :: Lens' ApplicationSettingsResource (Maybe CampaignLimits)
- applicationSettingsResource_quietTime :: Lens' ApplicationSettingsResource (Maybe QuietTime)
- applicationSettingsResource_applicationId :: Lens' ApplicationSettingsResource Text
- data ApplicationsResponse = ApplicationsResponse' {}
- newApplicationsResponse :: ApplicationsResponse
- applicationsResponse_item :: Lens' ApplicationsResponse (Maybe [ApplicationResponse])
- applicationsResponse_nextToken :: Lens' ApplicationsResponse (Maybe Text)
- data AttributeDimension = AttributeDimension' {
- attributeType :: Maybe AttributeType
- values :: [Text]
- newAttributeDimension :: AttributeDimension
- attributeDimension_attributeType :: Lens' AttributeDimension (Maybe AttributeType)
- attributeDimension_values :: Lens' AttributeDimension [Text]
- data AttributesResource = AttributesResource' {
- attributes :: Maybe [Text]
- attributeType :: Text
- applicationId :: Text
- newAttributesResource :: Text -> Text -> AttributesResource
- attributesResource_attributes :: Lens' AttributesResource (Maybe [Text])
- attributesResource_attributeType :: Lens' AttributesResource Text
- attributesResource_applicationId :: Lens' AttributesResource Text
- data BaiduChannelRequest = BaiduChannelRequest' {}
- newBaiduChannelRequest :: Text -> Text -> BaiduChannelRequest
- baiduChannelRequest_enabled :: Lens' BaiduChannelRequest (Maybe Bool)
- baiduChannelRequest_secretKey :: Lens' BaiduChannelRequest Text
- baiduChannelRequest_apiKey :: Lens' BaiduChannelRequest Text
- data BaiduChannelResponse = BaiduChannelResponse' {
- applicationId :: Maybe Text
- creationDate :: Maybe Text
- enabled :: Maybe Bool
- hasCredential :: Maybe Bool
- id :: Maybe Text
- isArchived :: Maybe Bool
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe Text
- version :: Maybe Int
- credential :: Text
- platform :: Text
- newBaiduChannelResponse :: Text -> Text -> BaiduChannelResponse
- baiduChannelResponse_applicationId :: Lens' BaiduChannelResponse (Maybe Text)
- baiduChannelResponse_creationDate :: Lens' BaiduChannelResponse (Maybe Text)
- baiduChannelResponse_enabled :: Lens' BaiduChannelResponse (Maybe Bool)
- baiduChannelResponse_hasCredential :: Lens' BaiduChannelResponse (Maybe Bool)
- baiduChannelResponse_id :: Lens' BaiduChannelResponse (Maybe Text)
- baiduChannelResponse_isArchived :: Lens' BaiduChannelResponse (Maybe Bool)
- baiduChannelResponse_lastModifiedBy :: Lens' BaiduChannelResponse (Maybe Text)
- baiduChannelResponse_lastModifiedDate :: Lens' BaiduChannelResponse (Maybe Text)
- baiduChannelResponse_version :: Lens' BaiduChannelResponse (Maybe Int)
- baiduChannelResponse_credential :: Lens' BaiduChannelResponse Text
- baiduChannelResponse_platform :: Lens' BaiduChannelResponse Text
- data BaiduMessage = BaiduMessage' {
- action :: Maybe Action
- body :: Maybe Text
- data' :: Maybe (HashMap Text Text)
- iconReference :: Maybe Text
- imageIconUrl :: Maybe Text
- imageUrl :: Maybe Text
- rawContent :: Maybe Text
- silentPush :: Maybe Bool
- smallImageIconUrl :: Maybe Text
- sound :: Maybe Text
- substitutions :: Maybe (HashMap Text [Text])
- timeToLive :: Maybe Int
- title :: Maybe Text
- url :: Maybe Text
- newBaiduMessage :: BaiduMessage
- baiduMessage_action :: Lens' BaiduMessage (Maybe Action)
- baiduMessage_body :: Lens' BaiduMessage (Maybe Text)
- baiduMessage_data :: Lens' BaiduMessage (Maybe (HashMap Text Text))
- baiduMessage_iconReference :: Lens' BaiduMessage (Maybe Text)
- baiduMessage_imageIconUrl :: Lens' BaiduMessage (Maybe Text)
- baiduMessage_imageUrl :: Lens' BaiduMessage (Maybe Text)
- baiduMessage_rawContent :: Lens' BaiduMessage (Maybe Text)
- baiduMessage_silentPush :: Lens' BaiduMessage (Maybe Bool)
- baiduMessage_smallImageIconUrl :: Lens' BaiduMessage (Maybe Text)
- baiduMessage_sound :: Lens' BaiduMessage (Maybe Text)
- baiduMessage_substitutions :: Lens' BaiduMessage (Maybe (HashMap Text [Text]))
- baiduMessage_timeToLive :: Lens' BaiduMessage (Maybe Int)
- baiduMessage_title :: Lens' BaiduMessage (Maybe Text)
- baiduMessage_url :: Lens' BaiduMessage (Maybe Text)
- data BaseKpiResult = BaseKpiResult' {}
- newBaseKpiResult :: BaseKpiResult
- baseKpiResult_rows :: Lens' BaseKpiResult [ResultRow]
- data CampaignCustomMessage = CampaignCustomMessage' {}
- newCampaignCustomMessage :: CampaignCustomMessage
- campaignCustomMessage_data :: Lens' CampaignCustomMessage (Maybe Text)
- data CampaignDateRangeKpiResponse = CampaignDateRangeKpiResponse' {
- nextToken :: Maybe Text
- kpiResult :: BaseKpiResult
- kpiName :: Text
- endTime :: ISO8601
- campaignId :: Text
- startTime :: ISO8601
- applicationId :: Text
- newCampaignDateRangeKpiResponse :: BaseKpiResult -> Text -> UTCTime -> Text -> UTCTime -> Text -> CampaignDateRangeKpiResponse
- campaignDateRangeKpiResponse_nextToken :: Lens' CampaignDateRangeKpiResponse (Maybe Text)
- campaignDateRangeKpiResponse_kpiResult :: Lens' CampaignDateRangeKpiResponse BaseKpiResult
- campaignDateRangeKpiResponse_kpiName :: Lens' CampaignDateRangeKpiResponse Text
- campaignDateRangeKpiResponse_endTime :: Lens' CampaignDateRangeKpiResponse UTCTime
- campaignDateRangeKpiResponse_campaignId :: Lens' CampaignDateRangeKpiResponse Text
- campaignDateRangeKpiResponse_startTime :: Lens' CampaignDateRangeKpiResponse UTCTime
- campaignDateRangeKpiResponse_applicationId :: Lens' CampaignDateRangeKpiResponse Text
- data CampaignEmailMessage = CampaignEmailMessage' {}
- newCampaignEmailMessage :: CampaignEmailMessage
- campaignEmailMessage_body :: Lens' CampaignEmailMessage (Maybe Text)
- campaignEmailMessage_fromAddress :: Lens' CampaignEmailMessage (Maybe Text)
- campaignEmailMessage_htmlBody :: Lens' CampaignEmailMessage (Maybe Text)
- campaignEmailMessage_title :: Lens' CampaignEmailMessage (Maybe Text)
- data CampaignEventFilter = CampaignEventFilter' {}
- newCampaignEventFilter :: FilterType -> EventDimensions -> CampaignEventFilter
- campaignEventFilter_filterType :: Lens' CampaignEventFilter FilterType
- campaignEventFilter_dimensions :: Lens' CampaignEventFilter EventDimensions
- data CampaignHook = CampaignHook' {}
- newCampaignHook :: CampaignHook
- campaignHook_lambdaFunctionName :: Lens' CampaignHook (Maybe Text)
- campaignHook_mode :: Lens' CampaignHook (Maybe Mode)
- campaignHook_webUrl :: Lens' CampaignHook (Maybe Text)
- data CampaignInAppMessage = CampaignInAppMessage' {}
- newCampaignInAppMessage :: CampaignInAppMessage
- campaignInAppMessage_body :: Lens' CampaignInAppMessage (Maybe Text)
- campaignInAppMessage_content :: Lens' CampaignInAppMessage (Maybe [InAppMessageContent])
- campaignInAppMessage_customConfig :: Lens' CampaignInAppMessage (Maybe (HashMap Text Text))
- campaignInAppMessage_layout :: Lens' CampaignInAppMessage (Maybe Layout)
- data CampaignLimits = CampaignLimits' {}
- newCampaignLimits :: CampaignLimits
- campaignLimits_daily :: Lens' CampaignLimits (Maybe Int)
- campaignLimits_maximumDuration :: Lens' CampaignLimits (Maybe Int)
- campaignLimits_messagesPerSecond :: Lens' CampaignLimits (Maybe Int)
- campaignLimits_session :: Lens' CampaignLimits (Maybe Int)
- campaignLimits_total :: Lens' CampaignLimits (Maybe Int)
- data CampaignResponse = CampaignResponse' {
- additionalTreatments :: Maybe [TreatmentResource]
- customDeliveryConfiguration :: Maybe CustomDeliveryConfiguration
- defaultState :: Maybe CampaignState
- description :: Maybe Text
- holdoutPercent :: Maybe Int
- hook :: Maybe CampaignHook
- isPaused :: Maybe Bool
- limits :: Maybe CampaignLimits
- messageConfiguration :: Maybe MessageConfiguration
- name :: Maybe Text
- priority :: Maybe Int
- schedule :: Maybe Schedule
- state :: Maybe CampaignState
- templateConfiguration :: Maybe TemplateConfiguration
- treatmentDescription :: Maybe Text
- treatmentName :: Maybe Text
- version :: Maybe Int
- tags :: Maybe (HashMap Text Text)
- lastModifiedDate :: Text
- creationDate :: Text
- segmentId :: Text
- segmentVersion :: Int
- id :: Text
- arn :: Text
- applicationId :: Text
- newCampaignResponse :: Text -> Text -> Text -> Int -> Text -> Text -> Text -> CampaignResponse
- campaignResponse_additionalTreatments :: Lens' CampaignResponse (Maybe [TreatmentResource])
- campaignResponse_customDeliveryConfiguration :: Lens' CampaignResponse (Maybe CustomDeliveryConfiguration)
- campaignResponse_defaultState :: Lens' CampaignResponse (Maybe CampaignState)
- campaignResponse_description :: Lens' CampaignResponse (Maybe Text)
- campaignResponse_holdoutPercent :: Lens' CampaignResponse (Maybe Int)
- campaignResponse_hook :: Lens' CampaignResponse (Maybe CampaignHook)
- campaignResponse_isPaused :: Lens' CampaignResponse (Maybe Bool)
- campaignResponse_limits :: Lens' CampaignResponse (Maybe CampaignLimits)
- campaignResponse_messageConfiguration :: Lens' CampaignResponse (Maybe MessageConfiguration)
- campaignResponse_name :: Lens' CampaignResponse (Maybe Text)
- campaignResponse_priority :: Lens' CampaignResponse (Maybe Int)
- campaignResponse_schedule :: Lens' CampaignResponse (Maybe Schedule)
- campaignResponse_state :: Lens' CampaignResponse (Maybe CampaignState)
- campaignResponse_templateConfiguration :: Lens' CampaignResponse (Maybe TemplateConfiguration)
- campaignResponse_treatmentDescription :: Lens' CampaignResponse (Maybe Text)
- campaignResponse_treatmentName :: Lens' CampaignResponse (Maybe Text)
- campaignResponse_version :: Lens' CampaignResponse (Maybe Int)
- campaignResponse_tags :: Lens' CampaignResponse (Maybe (HashMap Text Text))
- campaignResponse_lastModifiedDate :: Lens' CampaignResponse Text
- campaignResponse_creationDate :: Lens' CampaignResponse Text
- campaignResponse_segmentId :: Lens' CampaignResponse Text
- campaignResponse_segmentVersion :: Lens' CampaignResponse Int
- campaignResponse_id :: Lens' CampaignResponse Text
- campaignResponse_arn :: Lens' CampaignResponse Text
- campaignResponse_applicationId :: Lens' CampaignResponse Text
- data CampaignSmsMessage = CampaignSmsMessage' {
- body :: Maybe Text
- entityId :: Maybe Text
- messageType :: Maybe MessageType
- originationNumber :: Maybe Text
- senderId :: Maybe Text
- templateId :: Maybe Text
- newCampaignSmsMessage :: CampaignSmsMessage
- campaignSmsMessage_body :: Lens' CampaignSmsMessage (Maybe Text)
- campaignSmsMessage_entityId :: Lens' CampaignSmsMessage (Maybe Text)
- campaignSmsMessage_messageType :: Lens' CampaignSmsMessage (Maybe MessageType)
- campaignSmsMessage_originationNumber :: Lens' CampaignSmsMessage (Maybe Text)
- campaignSmsMessage_senderId :: Lens' CampaignSmsMessage (Maybe Text)
- campaignSmsMessage_templateId :: Lens' CampaignSmsMessage (Maybe Text)
- data CampaignState = CampaignState' {}
- newCampaignState :: CampaignState
- campaignState_campaignStatus :: Lens' CampaignState (Maybe CampaignStatus)
- data CampaignsResponse = CampaignsResponse' {
- nextToken :: Maybe Text
- item :: [CampaignResponse]
- newCampaignsResponse :: CampaignsResponse
- campaignsResponse_nextToken :: Lens' CampaignsResponse (Maybe Text)
- campaignsResponse_item :: Lens' CampaignsResponse [CampaignResponse]
- data ChannelResponse = ChannelResponse' {
- applicationId :: Maybe Text
- creationDate :: Maybe Text
- enabled :: Maybe Bool
- hasCredential :: Maybe Bool
- id :: Maybe Text
- isArchived :: Maybe Bool
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe Text
- version :: Maybe Int
- newChannelResponse :: ChannelResponse
- channelResponse_applicationId :: Lens' ChannelResponse (Maybe Text)
- channelResponse_creationDate :: Lens' ChannelResponse (Maybe Text)
- channelResponse_enabled :: Lens' ChannelResponse (Maybe Bool)
- channelResponse_hasCredential :: Lens' ChannelResponse (Maybe Bool)
- channelResponse_id :: Lens' ChannelResponse (Maybe Text)
- channelResponse_isArchived :: Lens' ChannelResponse (Maybe Bool)
- channelResponse_lastModifiedBy :: Lens' ChannelResponse (Maybe Text)
- channelResponse_lastModifiedDate :: Lens' ChannelResponse (Maybe Text)
- channelResponse_version :: Lens' ChannelResponse (Maybe Int)
- data ChannelsResponse = ChannelsResponse' {}
- newChannelsResponse :: ChannelsResponse
- channelsResponse_channels :: Lens' ChannelsResponse (HashMap Text ChannelResponse)
- data ClosedDays = ClosedDays' {
- custom :: Maybe [ClosedDaysRule]
- email :: Maybe [ClosedDaysRule]
- push :: Maybe [ClosedDaysRule]
- sms :: Maybe [ClosedDaysRule]
- voice :: Maybe [ClosedDaysRule]
- newClosedDays :: ClosedDays
- closedDays_custom :: Lens' ClosedDays (Maybe [ClosedDaysRule])
- closedDays_email :: Lens' ClosedDays (Maybe [ClosedDaysRule])
- closedDays_push :: Lens' ClosedDays (Maybe [ClosedDaysRule])
- closedDays_sms :: Lens' ClosedDays (Maybe [ClosedDaysRule])
- closedDays_voice :: Lens' ClosedDays (Maybe [ClosedDaysRule])
- data ClosedDaysRule = ClosedDaysRule' {
- endDateTime :: Maybe Text
- name :: Maybe Text
- startDateTime :: Maybe Text
- newClosedDaysRule :: ClosedDaysRule
- closedDaysRule_endDateTime :: Lens' ClosedDaysRule (Maybe Text)
- closedDaysRule_name :: Lens' ClosedDaysRule (Maybe Text)
- closedDaysRule_startDateTime :: Lens' ClosedDaysRule (Maybe Text)
- data Condition = Condition' {}
- newCondition :: Condition
- condition_conditions :: Lens' Condition (Maybe [SimpleCondition])
- condition_operator :: Lens' Condition (Maybe Operator)
- data ConditionalSplitActivity = ConditionalSplitActivity' {}
- newConditionalSplitActivity :: ConditionalSplitActivity
- conditionalSplitActivity_condition :: Lens' ConditionalSplitActivity (Maybe Condition)
- conditionalSplitActivity_evaluationWaitTime :: Lens' ConditionalSplitActivity (Maybe WaitTime)
- conditionalSplitActivity_falseActivity :: Lens' ConditionalSplitActivity (Maybe Text)
- conditionalSplitActivity_trueActivity :: Lens' ConditionalSplitActivity (Maybe Text)
- data ContactCenterActivity = ContactCenterActivity' {}
- newContactCenterActivity :: ContactCenterActivity
- contactCenterActivity_nextActivity :: Lens' ContactCenterActivity (Maybe Text)
- data CreateApplicationRequest = CreateApplicationRequest' {}
- newCreateApplicationRequest :: Text -> CreateApplicationRequest
- createApplicationRequest_tags :: Lens' CreateApplicationRequest (Maybe (HashMap Text Text))
- createApplicationRequest_name :: Lens' CreateApplicationRequest Text
- data CreateRecommenderConfiguration = CreateRecommenderConfiguration' {
- attributes :: Maybe (HashMap Text Text)
- description :: Maybe Text
- name :: Maybe Text
- recommendationProviderIdType :: Maybe Text
- recommendationTransformerUri :: Maybe Text
- recommendationsDisplayName :: Maybe Text
- recommendationsPerMessage :: Maybe Int
- recommendationProviderUri :: Text
- recommendationProviderRoleArn :: Text
- newCreateRecommenderConfiguration :: Text -> Text -> CreateRecommenderConfiguration
- createRecommenderConfiguration_attributes :: Lens' CreateRecommenderConfiguration (Maybe (HashMap Text Text))
- createRecommenderConfiguration_description :: Lens' CreateRecommenderConfiguration (Maybe Text)
- createRecommenderConfiguration_name :: Lens' CreateRecommenderConfiguration (Maybe Text)
- createRecommenderConfiguration_recommendationProviderIdType :: Lens' CreateRecommenderConfiguration (Maybe Text)
- createRecommenderConfiguration_recommendationTransformerUri :: Lens' CreateRecommenderConfiguration (Maybe Text)
- createRecommenderConfiguration_recommendationsDisplayName :: Lens' CreateRecommenderConfiguration (Maybe Text)
- createRecommenderConfiguration_recommendationsPerMessage :: Lens' CreateRecommenderConfiguration (Maybe Int)
- createRecommenderConfiguration_recommendationProviderUri :: Lens' CreateRecommenderConfiguration Text
- createRecommenderConfiguration_recommendationProviderRoleArn :: Lens' CreateRecommenderConfiguration Text
- data CreateTemplateMessageBody = CreateTemplateMessageBody' {}
- newCreateTemplateMessageBody :: CreateTemplateMessageBody
- createTemplateMessageBody_arn :: Lens' CreateTemplateMessageBody (Maybe Text)
- createTemplateMessageBody_message :: Lens' CreateTemplateMessageBody (Maybe Text)
- createTemplateMessageBody_requestID :: Lens' CreateTemplateMessageBody (Maybe Text)
- data CustomDeliveryConfiguration = CustomDeliveryConfiguration' {}
- newCustomDeliveryConfiguration :: Text -> CustomDeliveryConfiguration
- customDeliveryConfiguration_endpointTypes :: Lens' CustomDeliveryConfiguration (Maybe [EndpointTypesElement])
- customDeliveryConfiguration_deliveryUri :: Lens' CustomDeliveryConfiguration Text
- data CustomMessageActivity = CustomMessageActivity' {}
- newCustomMessageActivity :: CustomMessageActivity
- customMessageActivity_deliveryUri :: Lens' CustomMessageActivity (Maybe Text)
- customMessageActivity_endpointTypes :: Lens' CustomMessageActivity (Maybe [EndpointTypesElement])
- customMessageActivity_messageConfig :: Lens' CustomMessageActivity (Maybe JourneyCustomMessage)
- customMessageActivity_nextActivity :: Lens' CustomMessageActivity (Maybe Text)
- customMessageActivity_templateName :: Lens' CustomMessageActivity (Maybe Text)
- customMessageActivity_templateVersion :: Lens' CustomMessageActivity (Maybe Text)
- data DefaultButtonConfiguration = DefaultButtonConfiguration' {
- backgroundColor :: Maybe Text
- borderRadius :: Maybe Int
- link :: Maybe Text
- textColor :: Maybe Text
- buttonAction :: ButtonAction
- text :: Text
- newDefaultButtonConfiguration :: ButtonAction -> Text -> DefaultButtonConfiguration
- defaultButtonConfiguration_backgroundColor :: Lens' DefaultButtonConfiguration (Maybe Text)
- defaultButtonConfiguration_borderRadius :: Lens' DefaultButtonConfiguration (Maybe Int)
- defaultButtonConfiguration_link :: Lens' DefaultButtonConfiguration (Maybe Text)
- defaultButtonConfiguration_textColor :: Lens' DefaultButtonConfiguration (Maybe Text)
- defaultButtonConfiguration_buttonAction :: Lens' DefaultButtonConfiguration ButtonAction
- defaultButtonConfiguration_text :: Lens' DefaultButtonConfiguration Text
- data DefaultMessage = DefaultMessage' {}
- newDefaultMessage :: DefaultMessage
- defaultMessage_body :: Lens' DefaultMessage (Maybe Text)
- defaultMessage_substitutions :: Lens' DefaultMessage (Maybe (HashMap Text [Text]))
- data DefaultPushNotificationMessage = DefaultPushNotificationMessage' {}
- newDefaultPushNotificationMessage :: DefaultPushNotificationMessage
- defaultPushNotificationMessage_action :: Lens' DefaultPushNotificationMessage (Maybe Action)
- defaultPushNotificationMessage_body :: Lens' DefaultPushNotificationMessage (Maybe Text)
- defaultPushNotificationMessage_data :: Lens' DefaultPushNotificationMessage (Maybe (HashMap Text Text))
- defaultPushNotificationMessage_silentPush :: Lens' DefaultPushNotificationMessage (Maybe Bool)
- defaultPushNotificationMessage_substitutions :: Lens' DefaultPushNotificationMessage (Maybe (HashMap Text [Text]))
- defaultPushNotificationMessage_title :: Lens' DefaultPushNotificationMessage (Maybe Text)
- defaultPushNotificationMessage_url :: Lens' DefaultPushNotificationMessage (Maybe Text)
- data DefaultPushNotificationTemplate = DefaultPushNotificationTemplate' {}
- newDefaultPushNotificationTemplate :: DefaultPushNotificationTemplate
- defaultPushNotificationTemplate_action :: Lens' DefaultPushNotificationTemplate (Maybe Action)
- defaultPushNotificationTemplate_body :: Lens' DefaultPushNotificationTemplate (Maybe Text)
- defaultPushNotificationTemplate_sound :: Lens' DefaultPushNotificationTemplate (Maybe Text)
- defaultPushNotificationTemplate_title :: Lens' DefaultPushNotificationTemplate (Maybe Text)
- defaultPushNotificationTemplate_url :: Lens' DefaultPushNotificationTemplate (Maybe Text)
- data DirectMessageConfiguration = DirectMessageConfiguration' {
- aDMMessage :: Maybe ADMMessage
- aPNSMessage :: Maybe APNSMessage
- baiduMessage :: Maybe BaiduMessage
- defaultMessage :: Maybe DefaultMessage
- defaultPushNotificationMessage :: Maybe DefaultPushNotificationMessage
- emailMessage :: Maybe EmailMessage
- gCMMessage :: Maybe GCMMessage
- sMSMessage :: Maybe SMSMessage
- voiceMessage :: Maybe VoiceMessage
- newDirectMessageConfiguration :: DirectMessageConfiguration
- directMessageConfiguration_aDMMessage :: Lens' DirectMessageConfiguration (Maybe ADMMessage)
- directMessageConfiguration_aPNSMessage :: Lens' DirectMessageConfiguration (Maybe APNSMessage)
- directMessageConfiguration_baiduMessage :: Lens' DirectMessageConfiguration (Maybe BaiduMessage)
- directMessageConfiguration_defaultMessage :: Lens' DirectMessageConfiguration (Maybe DefaultMessage)
- directMessageConfiguration_defaultPushNotificationMessage :: Lens' DirectMessageConfiguration (Maybe DefaultPushNotificationMessage)
- directMessageConfiguration_emailMessage :: Lens' DirectMessageConfiguration (Maybe EmailMessage)
- directMessageConfiguration_gCMMessage :: Lens' DirectMessageConfiguration (Maybe GCMMessage)
- directMessageConfiguration_sMSMessage :: Lens' DirectMessageConfiguration (Maybe SMSMessage)
- directMessageConfiguration_voiceMessage :: Lens' DirectMessageConfiguration (Maybe VoiceMessage)
- data EmailChannelRequest = EmailChannelRequest' {}
- newEmailChannelRequest :: Text -> Text -> EmailChannelRequest
- emailChannelRequest_configurationSet :: Lens' EmailChannelRequest (Maybe Text)
- emailChannelRequest_enabled :: Lens' EmailChannelRequest (Maybe Bool)
- emailChannelRequest_roleArn :: Lens' EmailChannelRequest (Maybe Text)
- emailChannelRequest_fromAddress :: Lens' EmailChannelRequest Text
- emailChannelRequest_identity :: Lens' EmailChannelRequest Text
- data EmailChannelResponse = EmailChannelResponse' {
- applicationId :: Maybe Text
- configurationSet :: Maybe Text
- creationDate :: Maybe Text
- enabled :: Maybe Bool
- fromAddress :: Maybe Text
- hasCredential :: Maybe Bool
- id :: Maybe Text
- identity :: Maybe Text
- isArchived :: Maybe Bool
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe Text
- messagesPerSecond :: Maybe Int
- roleArn :: Maybe Text
- version :: Maybe Int
- platform :: Text
- newEmailChannelResponse :: Text -> EmailChannelResponse
- emailChannelResponse_applicationId :: Lens' EmailChannelResponse (Maybe Text)
- emailChannelResponse_configurationSet :: Lens' EmailChannelResponse (Maybe Text)
- emailChannelResponse_creationDate :: Lens' EmailChannelResponse (Maybe Text)
- emailChannelResponse_enabled :: Lens' EmailChannelResponse (Maybe Bool)
- emailChannelResponse_fromAddress :: Lens' EmailChannelResponse (Maybe Text)
- emailChannelResponse_hasCredential :: Lens' EmailChannelResponse (Maybe Bool)
- emailChannelResponse_id :: Lens' EmailChannelResponse (Maybe Text)
- emailChannelResponse_identity :: Lens' EmailChannelResponse (Maybe Text)
- emailChannelResponse_isArchived :: Lens' EmailChannelResponse (Maybe Bool)
- emailChannelResponse_lastModifiedBy :: Lens' EmailChannelResponse (Maybe Text)
- emailChannelResponse_lastModifiedDate :: Lens' EmailChannelResponse (Maybe Text)
- emailChannelResponse_messagesPerSecond :: Lens' EmailChannelResponse (Maybe Int)
- emailChannelResponse_roleArn :: Lens' EmailChannelResponse (Maybe Text)
- emailChannelResponse_version :: Lens' EmailChannelResponse (Maybe Int)
- emailChannelResponse_platform :: Lens' EmailChannelResponse Text
- data EmailMessage = EmailMessage' {}
- newEmailMessage :: EmailMessage
- emailMessage_body :: Lens' EmailMessage (Maybe Text)
- emailMessage_feedbackForwardingAddress :: Lens' EmailMessage (Maybe Text)
- emailMessage_fromAddress :: Lens' EmailMessage (Maybe Text)
- emailMessage_rawEmail :: Lens' EmailMessage (Maybe RawEmail)
- emailMessage_replyToAddresses :: Lens' EmailMessage (Maybe [Text])
- emailMessage_simpleEmail :: Lens' EmailMessage (Maybe SimpleEmail)
- emailMessage_substitutions :: Lens' EmailMessage (Maybe (HashMap Text [Text]))
- data EmailMessageActivity = EmailMessageActivity' {}
- newEmailMessageActivity :: EmailMessageActivity
- emailMessageActivity_messageConfig :: Lens' EmailMessageActivity (Maybe JourneyEmailMessage)
- emailMessageActivity_nextActivity :: Lens' EmailMessageActivity (Maybe Text)
- emailMessageActivity_templateName :: Lens' EmailMessageActivity (Maybe Text)
- emailMessageActivity_templateVersion :: Lens' EmailMessageActivity (Maybe Text)
- data EmailTemplateRequest = EmailTemplateRequest' {}
- newEmailTemplateRequest :: EmailTemplateRequest
- emailTemplateRequest_defaultSubstitutions :: Lens' EmailTemplateRequest (Maybe Text)
- emailTemplateRequest_htmlPart :: Lens' EmailTemplateRequest (Maybe Text)
- emailTemplateRequest_recommenderId :: Lens' EmailTemplateRequest (Maybe Text)
- emailTemplateRequest_subject :: Lens' EmailTemplateRequest (Maybe Text)
- emailTemplateRequest_templateDescription :: Lens' EmailTemplateRequest (Maybe Text)
- emailTemplateRequest_textPart :: Lens' EmailTemplateRequest (Maybe Text)
- emailTemplateRequest_tags :: Lens' EmailTemplateRequest (Maybe (HashMap Text Text))
- data EmailTemplateResponse = EmailTemplateResponse' {
- arn :: Maybe Text
- defaultSubstitutions :: Maybe Text
- htmlPart :: Maybe Text
- recommenderId :: Maybe Text
- subject :: Maybe Text
- templateDescription :: Maybe Text
- textPart :: Maybe Text
- version :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- lastModifiedDate :: Text
- creationDate :: Text
- templateName :: Text
- templateType :: TemplateType
- newEmailTemplateResponse :: Text -> Text -> Text -> TemplateType -> EmailTemplateResponse
- emailTemplateResponse_arn :: Lens' EmailTemplateResponse (Maybe Text)
- emailTemplateResponse_defaultSubstitutions :: Lens' EmailTemplateResponse (Maybe Text)
- emailTemplateResponse_htmlPart :: Lens' EmailTemplateResponse (Maybe Text)
- emailTemplateResponse_recommenderId :: Lens' EmailTemplateResponse (Maybe Text)
- emailTemplateResponse_subject :: Lens' EmailTemplateResponse (Maybe Text)
- emailTemplateResponse_templateDescription :: Lens' EmailTemplateResponse (Maybe Text)
- emailTemplateResponse_textPart :: Lens' EmailTemplateResponse (Maybe Text)
- emailTemplateResponse_version :: Lens' EmailTemplateResponse (Maybe Text)
- emailTemplateResponse_tags :: Lens' EmailTemplateResponse (Maybe (HashMap Text Text))
- emailTemplateResponse_lastModifiedDate :: Lens' EmailTemplateResponse Text
- emailTemplateResponse_creationDate :: Lens' EmailTemplateResponse Text
- emailTemplateResponse_templateName :: Lens' EmailTemplateResponse Text
- emailTemplateResponse_templateType :: Lens' EmailTemplateResponse TemplateType
- data EndpointBatchItem = EndpointBatchItem' {
- address :: Maybe Text
- attributes :: Maybe (HashMap Text [Text])
- channelType :: Maybe ChannelType
- demographic :: Maybe EndpointDemographic
- effectiveDate :: Maybe Text
- endpointStatus :: Maybe Text
- id :: Maybe Text
- location :: Maybe EndpointLocation
- metrics :: Maybe (HashMap Text Double)
- optOut :: Maybe Text
- requestId :: Maybe Text
- user :: Maybe EndpointUser
- newEndpointBatchItem :: EndpointBatchItem
- endpointBatchItem_address :: Lens' EndpointBatchItem (Maybe Text)
- endpointBatchItem_attributes :: Lens' EndpointBatchItem (Maybe (HashMap Text [Text]))
- endpointBatchItem_channelType :: Lens' EndpointBatchItem (Maybe ChannelType)
- endpointBatchItem_demographic :: Lens' EndpointBatchItem (Maybe EndpointDemographic)
- endpointBatchItem_effectiveDate :: Lens' EndpointBatchItem (Maybe Text)
- endpointBatchItem_endpointStatus :: Lens' EndpointBatchItem (Maybe Text)
- endpointBatchItem_id :: Lens' EndpointBatchItem (Maybe Text)
- endpointBatchItem_location :: Lens' EndpointBatchItem (Maybe EndpointLocation)
- endpointBatchItem_metrics :: Lens' EndpointBatchItem (Maybe (HashMap Text Double))
- endpointBatchItem_optOut :: Lens' EndpointBatchItem (Maybe Text)
- endpointBatchItem_requestId :: Lens' EndpointBatchItem (Maybe Text)
- endpointBatchItem_user :: Lens' EndpointBatchItem (Maybe EndpointUser)
- data EndpointBatchRequest = EndpointBatchRequest' {
- item :: [EndpointBatchItem]
- newEndpointBatchRequest :: EndpointBatchRequest
- endpointBatchRequest_item :: Lens' EndpointBatchRequest [EndpointBatchItem]
- data EndpointDemographic = EndpointDemographic' {}
- newEndpointDemographic :: EndpointDemographic
- endpointDemographic_appVersion :: Lens' EndpointDemographic (Maybe Text)
- endpointDemographic_locale :: Lens' EndpointDemographic (Maybe Text)
- endpointDemographic_make :: Lens' EndpointDemographic (Maybe Text)
- endpointDemographic_model :: Lens' EndpointDemographic (Maybe Text)
- endpointDemographic_modelVersion :: Lens' EndpointDemographic (Maybe Text)
- endpointDemographic_platform :: Lens' EndpointDemographic (Maybe Text)
- endpointDemographic_platformVersion :: Lens' EndpointDemographic (Maybe Text)
- endpointDemographic_timezone :: Lens' EndpointDemographic (Maybe Text)
- data EndpointItemResponse = EndpointItemResponse' {}
- newEndpointItemResponse :: EndpointItemResponse
- endpointItemResponse_message :: Lens' EndpointItemResponse (Maybe Text)
- endpointItemResponse_statusCode :: Lens' EndpointItemResponse (Maybe Int)
- data EndpointLocation = EndpointLocation' {}
- newEndpointLocation :: EndpointLocation
- endpointLocation_city :: Lens' EndpointLocation (Maybe Text)
- endpointLocation_country :: Lens' EndpointLocation (Maybe Text)
- endpointLocation_latitude :: Lens' EndpointLocation (Maybe Double)
- endpointLocation_longitude :: Lens' EndpointLocation (Maybe Double)
- endpointLocation_postalCode :: Lens' EndpointLocation (Maybe Text)
- endpointLocation_region :: Lens' EndpointLocation (Maybe Text)
- data EndpointMessageResult = EndpointMessageResult' {}
- newEndpointMessageResult :: DeliveryStatus -> Int -> EndpointMessageResult
- endpointMessageResult_address :: Lens' EndpointMessageResult (Maybe Text)
- endpointMessageResult_messageId :: Lens' EndpointMessageResult (Maybe Text)
- endpointMessageResult_statusMessage :: Lens' EndpointMessageResult (Maybe Text)
- endpointMessageResult_updatedToken :: Lens' EndpointMessageResult (Maybe Text)
- endpointMessageResult_deliveryStatus :: Lens' EndpointMessageResult DeliveryStatus
- endpointMessageResult_statusCode :: Lens' EndpointMessageResult Int
- data EndpointRequest = EndpointRequest' {
- address :: Maybe Text
- attributes :: Maybe (HashMap Text [Text])
- channelType :: Maybe ChannelType
- demographic :: Maybe EndpointDemographic
- effectiveDate :: Maybe Text
- endpointStatus :: Maybe Text
- location :: Maybe EndpointLocation
- metrics :: Maybe (HashMap Text Double)
- optOut :: Maybe Text
- requestId :: Maybe Text
- user :: Maybe EndpointUser
- newEndpointRequest :: EndpointRequest
- endpointRequest_address :: Lens' EndpointRequest (Maybe Text)
- endpointRequest_attributes :: Lens' EndpointRequest (Maybe (HashMap Text [Text]))
- endpointRequest_channelType :: Lens' EndpointRequest (Maybe ChannelType)
- endpointRequest_demographic :: Lens' EndpointRequest (Maybe EndpointDemographic)
- endpointRequest_effectiveDate :: Lens' EndpointRequest (Maybe Text)
- endpointRequest_endpointStatus :: Lens' EndpointRequest (Maybe Text)
- endpointRequest_location :: Lens' EndpointRequest (Maybe EndpointLocation)
- endpointRequest_metrics :: Lens' EndpointRequest (Maybe (HashMap Text Double))
- endpointRequest_optOut :: Lens' EndpointRequest (Maybe Text)
- endpointRequest_requestId :: Lens' EndpointRequest (Maybe Text)
- endpointRequest_user :: Lens' EndpointRequest (Maybe EndpointUser)
- data EndpointResponse = EndpointResponse' {
- address :: Maybe Text
- applicationId :: Maybe Text
- attributes :: Maybe (HashMap Text [Text])
- channelType :: Maybe ChannelType
- cohortId :: Maybe Text
- creationDate :: Maybe Text
- demographic :: Maybe EndpointDemographic
- effectiveDate :: Maybe Text
- endpointStatus :: Maybe Text
- id :: Maybe Text
- location :: Maybe EndpointLocation
- metrics :: Maybe (HashMap Text Double)
- optOut :: Maybe Text
- requestId :: Maybe Text
- user :: Maybe EndpointUser
- newEndpointResponse :: EndpointResponse
- endpointResponse_address :: Lens' EndpointResponse (Maybe Text)
- endpointResponse_applicationId :: Lens' EndpointResponse (Maybe Text)
- endpointResponse_attributes :: Lens' EndpointResponse (Maybe (HashMap Text [Text]))
- endpointResponse_channelType :: Lens' EndpointResponse (Maybe ChannelType)
- endpointResponse_cohortId :: Lens' EndpointResponse (Maybe Text)
- endpointResponse_creationDate :: Lens' EndpointResponse (Maybe Text)
- endpointResponse_demographic :: Lens' EndpointResponse (Maybe EndpointDemographic)
- endpointResponse_effectiveDate :: Lens' EndpointResponse (Maybe Text)
- endpointResponse_endpointStatus :: Lens' EndpointResponse (Maybe Text)
- endpointResponse_id :: Lens' EndpointResponse (Maybe Text)
- endpointResponse_location :: Lens' EndpointResponse (Maybe EndpointLocation)
- endpointResponse_metrics :: Lens' EndpointResponse (Maybe (HashMap Text Double))
- endpointResponse_optOut :: Lens' EndpointResponse (Maybe Text)
- endpointResponse_requestId :: Lens' EndpointResponse (Maybe Text)
- endpointResponse_user :: Lens' EndpointResponse (Maybe EndpointUser)
- data EndpointSendConfiguration = EndpointSendConfiguration' {
- bodyOverride :: Maybe Text
- context :: Maybe (HashMap Text Text)
- rawContent :: Maybe Text
- substitutions :: Maybe (HashMap Text [Text])
- titleOverride :: Maybe Text
- newEndpointSendConfiguration :: EndpointSendConfiguration
- endpointSendConfiguration_bodyOverride :: Lens' EndpointSendConfiguration (Maybe Text)
- endpointSendConfiguration_context :: Lens' EndpointSendConfiguration (Maybe (HashMap Text Text))
- endpointSendConfiguration_rawContent :: Lens' EndpointSendConfiguration (Maybe Text)
- endpointSendConfiguration_substitutions :: Lens' EndpointSendConfiguration (Maybe (HashMap Text [Text]))
- endpointSendConfiguration_titleOverride :: Lens' EndpointSendConfiguration (Maybe Text)
- data EndpointUser = EndpointUser' {}
- newEndpointUser :: EndpointUser
- endpointUser_userAttributes :: Lens' EndpointUser (Maybe (HashMap Text [Text]))
- endpointUser_userId :: Lens' EndpointUser (Maybe Text)
- data EndpointsResponse = EndpointsResponse' {
- item :: [EndpointResponse]
- newEndpointsResponse :: EndpointsResponse
- endpointsResponse_item :: Lens' EndpointsResponse [EndpointResponse]
- data Event = Event' {}
- newEvent :: Text -> Text -> Event
- event_appPackageName :: Lens' Event (Maybe Text)
- event_appTitle :: Lens' Event (Maybe Text)
- event_appVersionCode :: Lens' Event (Maybe Text)
- event_attributes :: Lens' Event (Maybe (HashMap Text Text))
- event_clientSdkVersion :: Lens' Event (Maybe Text)
- event_metrics :: Lens' Event (Maybe (HashMap Text Double))
- event_sdkName :: Lens' Event (Maybe Text)
- event_session :: Lens' Event (Maybe Session)
- event_eventType :: Lens' Event Text
- event_timestamp :: Lens' Event Text
- data EventCondition = EventCondition' {}
- newEventCondition :: EventCondition
- eventCondition_dimensions :: Lens' EventCondition (Maybe EventDimensions)
- eventCondition_messageActivity :: Lens' EventCondition (Maybe Text)
- data EventDimensions = EventDimensions' {}
- newEventDimensions :: EventDimensions
- eventDimensions_attributes :: Lens' EventDimensions (Maybe (HashMap Text AttributeDimension))
- eventDimensions_eventType :: Lens' EventDimensions (Maybe SetDimension)
- eventDimensions_metrics :: Lens' EventDimensions (Maybe (HashMap Text MetricDimension))
- data EventFilter = EventFilter' {}
- newEventFilter :: FilterType -> EventDimensions -> EventFilter
- eventFilter_filterType :: Lens' EventFilter FilterType
- eventFilter_dimensions :: Lens' EventFilter EventDimensions
- data EventItemResponse = EventItemResponse' {}
- newEventItemResponse :: EventItemResponse
- eventItemResponse_message :: Lens' EventItemResponse (Maybe Text)
- eventItemResponse_statusCode :: Lens' EventItemResponse (Maybe Int)
- data EventStartCondition = EventStartCondition' {}
- newEventStartCondition :: EventStartCondition
- eventStartCondition_eventFilter :: Lens' EventStartCondition (Maybe EventFilter)
- eventStartCondition_segmentId :: Lens' EventStartCondition (Maybe Text)
- data EventStream = EventStream' {}
- newEventStream :: Text -> Text -> Text -> EventStream
- eventStream_externalId :: Lens' EventStream (Maybe Text)
- eventStream_lastModifiedDate :: Lens' EventStream (Maybe Text)
- eventStream_lastUpdatedBy :: Lens' EventStream (Maybe Text)
- eventStream_applicationId :: Lens' EventStream Text
- eventStream_roleArn :: Lens' EventStream Text
- eventStream_destinationStreamArn :: Lens' EventStream Text
- data EventsBatch = EventsBatch' {}
- newEventsBatch :: PublicEndpoint -> EventsBatch
- eventsBatch_endpoint :: Lens' EventsBatch PublicEndpoint
- eventsBatch_events :: Lens' EventsBatch (HashMap Text Event)
- data EventsRequest = EventsRequest' {}
- newEventsRequest :: EventsRequest
- eventsRequest_batchItem :: Lens' EventsRequest (HashMap Text EventsBatch)
- data EventsResponse = EventsResponse' {
- results :: Maybe (HashMap Text ItemResponse)
- newEventsResponse :: EventsResponse
- eventsResponse_results :: Lens' EventsResponse (Maybe (HashMap Text ItemResponse))
- data ExportJobRequest = ExportJobRequest' {
- segmentId :: Maybe Text
- segmentVersion :: Maybe Int
- s3UrlPrefix :: Text
- roleArn :: Text
- newExportJobRequest :: Text -> Text -> ExportJobRequest
- exportJobRequest_segmentId :: Lens' ExportJobRequest (Maybe Text)
- exportJobRequest_segmentVersion :: Lens' ExportJobRequest (Maybe Int)
- exportJobRequest_s3UrlPrefix :: Lens' ExportJobRequest Text
- exportJobRequest_roleArn :: Lens' ExportJobRequest Text
- data ExportJobResource = ExportJobResource' {
- segmentId :: Maybe Text
- segmentVersion :: Maybe Int
- s3UrlPrefix :: Text
- roleArn :: Text
- newExportJobResource :: Text -> Text -> ExportJobResource
- exportJobResource_segmentId :: Lens' ExportJobResource (Maybe Text)
- exportJobResource_segmentVersion :: Lens' ExportJobResource (Maybe Int)
- exportJobResource_s3UrlPrefix :: Lens' ExportJobResource Text
- exportJobResource_roleArn :: Lens' ExportJobResource Text
- data ExportJobResponse = ExportJobResponse' {
- completedPieces :: Maybe Int
- completionDate :: Maybe Text
- failedPieces :: Maybe Int
- failures :: Maybe [Text]
- totalFailures :: Maybe Int
- totalPieces :: Maybe Int
- totalProcessed :: Maybe Int
- jobStatus :: JobStatus
- creationDate :: Text
- type' :: Text
- definition :: ExportJobResource
- id :: Text
- applicationId :: Text
- newExportJobResponse :: JobStatus -> Text -> Text -> ExportJobResource -> Text -> Text -> ExportJobResponse
- exportJobResponse_completedPieces :: Lens' ExportJobResponse (Maybe Int)
- exportJobResponse_completionDate :: Lens' ExportJobResponse (Maybe Text)
- exportJobResponse_failedPieces :: Lens' ExportJobResponse (Maybe Int)
- exportJobResponse_failures :: Lens' ExportJobResponse (Maybe [Text])
- exportJobResponse_totalFailures :: Lens' ExportJobResponse (Maybe Int)
- exportJobResponse_totalPieces :: Lens' ExportJobResponse (Maybe Int)
- exportJobResponse_totalProcessed :: Lens' ExportJobResponse (Maybe Int)
- exportJobResponse_jobStatus :: Lens' ExportJobResponse JobStatus
- exportJobResponse_creationDate :: Lens' ExportJobResponse Text
- exportJobResponse_type :: Lens' ExportJobResponse Text
- exportJobResponse_definition :: Lens' ExportJobResponse ExportJobResource
- exportJobResponse_id :: Lens' ExportJobResponse Text
- exportJobResponse_applicationId :: Lens' ExportJobResponse Text
- data ExportJobsResponse = ExportJobsResponse' {
- nextToken :: Maybe Text
- item :: [ExportJobResponse]
- newExportJobsResponse :: ExportJobsResponse
- exportJobsResponse_nextToken :: Lens' ExportJobsResponse (Maybe Text)
- exportJobsResponse_item :: Lens' ExportJobsResponse [ExportJobResponse]
- data GCMChannelRequest = GCMChannelRequest' {}
- newGCMChannelRequest :: Text -> GCMChannelRequest
- gCMChannelRequest_enabled :: Lens' GCMChannelRequest (Maybe Bool)
- gCMChannelRequest_apiKey :: Lens' GCMChannelRequest Text
- data GCMChannelResponse = GCMChannelResponse' {
- applicationId :: Maybe Text
- creationDate :: Maybe Text
- enabled :: Maybe Bool
- hasCredential :: Maybe Bool
- id :: Maybe Text
- isArchived :: Maybe Bool
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe Text
- version :: Maybe Int
- credential :: Text
- platform :: Text
- newGCMChannelResponse :: Text -> Text -> GCMChannelResponse
- gCMChannelResponse_applicationId :: Lens' GCMChannelResponse (Maybe Text)
- gCMChannelResponse_creationDate :: Lens' GCMChannelResponse (Maybe Text)
- gCMChannelResponse_enabled :: Lens' GCMChannelResponse (Maybe Bool)
- gCMChannelResponse_hasCredential :: Lens' GCMChannelResponse (Maybe Bool)
- gCMChannelResponse_id :: Lens' GCMChannelResponse (Maybe Text)
- gCMChannelResponse_isArchived :: Lens' GCMChannelResponse (Maybe Bool)
- gCMChannelResponse_lastModifiedBy :: Lens' GCMChannelResponse (Maybe Text)
- gCMChannelResponse_lastModifiedDate :: Lens' GCMChannelResponse (Maybe Text)
- gCMChannelResponse_version :: Lens' GCMChannelResponse (Maybe Int)
- gCMChannelResponse_credential :: Lens' GCMChannelResponse Text
- gCMChannelResponse_platform :: Lens' GCMChannelResponse Text
- data GCMMessage = GCMMessage' {
- action :: Maybe Action
- body :: Maybe Text
- collapseKey :: Maybe Text
- data' :: Maybe (HashMap Text Text)
- iconReference :: Maybe Text
- imageIconUrl :: Maybe Text
- imageUrl :: Maybe Text
- priority :: Maybe Text
- rawContent :: Maybe Text
- restrictedPackageName :: Maybe Text
- silentPush :: Maybe Bool
- smallImageIconUrl :: Maybe Text
- sound :: Maybe Text
- substitutions :: Maybe (HashMap Text [Text])
- timeToLive :: Maybe Int
- title :: Maybe Text
- url :: Maybe Text
- newGCMMessage :: GCMMessage
- gCMMessage_action :: Lens' GCMMessage (Maybe Action)
- gCMMessage_body :: Lens' GCMMessage (Maybe Text)
- gCMMessage_collapseKey :: Lens' GCMMessage (Maybe Text)
- gCMMessage_data :: Lens' GCMMessage (Maybe (HashMap Text Text))
- gCMMessage_iconReference :: Lens' GCMMessage (Maybe Text)
- gCMMessage_imageIconUrl :: Lens' GCMMessage (Maybe Text)
- gCMMessage_imageUrl :: Lens' GCMMessage (Maybe Text)
- gCMMessage_priority :: Lens' GCMMessage (Maybe Text)
- gCMMessage_rawContent :: Lens' GCMMessage (Maybe Text)
- gCMMessage_restrictedPackageName :: Lens' GCMMessage (Maybe Text)
- gCMMessage_silentPush :: Lens' GCMMessage (Maybe Bool)
- gCMMessage_smallImageIconUrl :: Lens' GCMMessage (Maybe Text)
- gCMMessage_sound :: Lens' GCMMessage (Maybe Text)
- gCMMessage_substitutions :: Lens' GCMMessage (Maybe (HashMap Text [Text]))
- gCMMessage_timeToLive :: Lens' GCMMessage (Maybe Int)
- gCMMessage_title :: Lens' GCMMessage (Maybe Text)
- gCMMessage_url :: Lens' GCMMessage (Maybe Text)
- data GPSCoordinates = GPSCoordinates' {}
- newGPSCoordinates :: Double -> Double -> GPSCoordinates
- gPSCoordinates_latitude :: Lens' GPSCoordinates Double
- gPSCoordinates_longitude :: Lens' GPSCoordinates Double
- data GPSPointDimension = GPSPointDimension' {}
- newGPSPointDimension :: GPSCoordinates -> GPSPointDimension
- gPSPointDimension_rangeInKilometers :: Lens' GPSPointDimension (Maybe Double)
- gPSPointDimension_coordinates :: Lens' GPSPointDimension GPSCoordinates
- data HoldoutActivity = HoldoutActivity' {
- nextActivity :: Maybe Text
- percentage :: Int
- newHoldoutActivity :: Int -> HoldoutActivity
- holdoutActivity_nextActivity :: Lens' HoldoutActivity (Maybe Text)
- holdoutActivity_percentage :: Lens' HoldoutActivity Int
- data ImportJobRequest = ImportJobRequest' {
- defineSegment :: Maybe Bool
- externalId :: Maybe Text
- registerEndpoints :: Maybe Bool
- segmentId :: Maybe Text
- segmentName :: Maybe Text
- format :: DefinitionFormat
- s3Url :: Text
- roleArn :: Text
- newImportJobRequest :: DefinitionFormat -> Text -> Text -> ImportJobRequest
- importJobRequest_defineSegment :: Lens' ImportJobRequest (Maybe Bool)
- importJobRequest_externalId :: Lens' ImportJobRequest (Maybe Text)
- importJobRequest_registerEndpoints :: Lens' ImportJobRequest (Maybe Bool)
- importJobRequest_segmentId :: Lens' ImportJobRequest (Maybe Text)
- importJobRequest_segmentName :: Lens' ImportJobRequest (Maybe Text)
- importJobRequest_format :: Lens' ImportJobRequest DefinitionFormat
- importJobRequest_s3Url :: Lens' ImportJobRequest Text
- importJobRequest_roleArn :: Lens' ImportJobRequest Text
- data ImportJobResource = ImportJobResource' {
- defineSegment :: Maybe Bool
- externalId :: Maybe Text
- registerEndpoints :: Maybe Bool
- segmentId :: Maybe Text
- segmentName :: Maybe Text
- format :: DefinitionFormat
- s3Url :: Text
- roleArn :: Text
- newImportJobResource :: DefinitionFormat -> Text -> Text -> ImportJobResource
- importJobResource_defineSegment :: Lens' ImportJobResource (Maybe Bool)
- importJobResource_externalId :: Lens' ImportJobResource (Maybe Text)
- importJobResource_registerEndpoints :: Lens' ImportJobResource (Maybe Bool)
- importJobResource_segmentId :: Lens' ImportJobResource (Maybe Text)
- importJobResource_segmentName :: Lens' ImportJobResource (Maybe Text)
- importJobResource_format :: Lens' ImportJobResource DefinitionFormat
- importJobResource_s3Url :: Lens' ImportJobResource Text
- importJobResource_roleArn :: Lens' ImportJobResource Text
- data ImportJobResponse = ImportJobResponse' {
- completedPieces :: Maybe Int
- completionDate :: Maybe Text
- failedPieces :: Maybe Int
- failures :: Maybe [Text]
- totalFailures :: Maybe Int
- totalPieces :: Maybe Int
- totalProcessed :: Maybe Int
- jobStatus :: JobStatus
- creationDate :: Text
- type' :: Text
- definition :: ImportJobResource
- id :: Text
- applicationId :: Text
- newImportJobResponse :: JobStatus -> Text -> Text -> ImportJobResource -> Text -> Text -> ImportJobResponse
- importJobResponse_completedPieces :: Lens' ImportJobResponse (Maybe Int)
- importJobResponse_completionDate :: Lens' ImportJobResponse (Maybe Text)
- importJobResponse_failedPieces :: Lens' ImportJobResponse (Maybe Int)
- importJobResponse_failures :: Lens' ImportJobResponse (Maybe [Text])
- importJobResponse_totalFailures :: Lens' ImportJobResponse (Maybe Int)
- importJobResponse_totalPieces :: Lens' ImportJobResponse (Maybe Int)
- importJobResponse_totalProcessed :: Lens' ImportJobResponse (Maybe Int)
- importJobResponse_jobStatus :: Lens' ImportJobResponse JobStatus
- importJobResponse_creationDate :: Lens' ImportJobResponse Text
- importJobResponse_type :: Lens' ImportJobResponse Text
- importJobResponse_definition :: Lens' ImportJobResponse ImportJobResource
- importJobResponse_id :: Lens' ImportJobResponse Text
- importJobResponse_applicationId :: Lens' ImportJobResponse Text
- data ImportJobsResponse = ImportJobsResponse' {
- nextToken :: Maybe Text
- item :: [ImportJobResponse]
- newImportJobsResponse :: ImportJobsResponse
- importJobsResponse_nextToken :: Lens' ImportJobsResponse (Maybe Text)
- importJobsResponse_item :: Lens' ImportJobsResponse [ImportJobResponse]
- data InAppCampaignSchedule = InAppCampaignSchedule' {}
- newInAppCampaignSchedule :: InAppCampaignSchedule
- inAppCampaignSchedule_endDate :: Lens' InAppCampaignSchedule (Maybe Text)
- inAppCampaignSchedule_eventFilter :: Lens' InAppCampaignSchedule (Maybe CampaignEventFilter)
- inAppCampaignSchedule_quietTime :: Lens' InAppCampaignSchedule (Maybe QuietTime)
- data InAppMessage = InAppMessage' {}
- newInAppMessage :: InAppMessage
- inAppMessage_content :: Lens' InAppMessage (Maybe [InAppMessageContent])
- inAppMessage_customConfig :: Lens' InAppMessage (Maybe (HashMap Text Text))
- inAppMessage_layout :: Lens' InAppMessage (Maybe Layout)
- data InAppMessageBodyConfig = InAppMessageBodyConfig' {}
- newInAppMessageBodyConfig :: Alignment -> Text -> Text -> InAppMessageBodyConfig
- inAppMessageBodyConfig_alignment :: Lens' InAppMessageBodyConfig Alignment
- inAppMessageBodyConfig_textColor :: Lens' InAppMessageBodyConfig Text
- inAppMessageBodyConfig_body :: Lens' InAppMessageBodyConfig Text
- data InAppMessageButton = InAppMessageButton' {}
- newInAppMessageButton :: InAppMessageButton
- inAppMessageButton_android :: Lens' InAppMessageButton (Maybe OverrideButtonConfiguration)
- inAppMessageButton_defaultConfig :: Lens' InAppMessageButton (Maybe DefaultButtonConfiguration)
- inAppMessageButton_ios :: Lens' InAppMessageButton (Maybe OverrideButtonConfiguration)
- inAppMessageButton_web :: Lens' InAppMessageButton (Maybe OverrideButtonConfiguration)
- data InAppMessageCampaign = InAppMessageCampaign' {}
- newInAppMessageCampaign :: InAppMessageCampaign
- inAppMessageCampaign_campaignId :: Lens' InAppMessageCampaign (Maybe Text)
- inAppMessageCampaign_dailyCap :: Lens' InAppMessageCampaign (Maybe Int)
- inAppMessageCampaign_inAppMessage :: Lens' InAppMessageCampaign (Maybe InAppMessage)
- inAppMessageCampaign_priority :: Lens' InAppMessageCampaign (Maybe Int)
- inAppMessageCampaign_schedule :: Lens' InAppMessageCampaign (Maybe InAppCampaignSchedule)
- inAppMessageCampaign_sessionCap :: Lens' InAppMessageCampaign (Maybe Int)
- inAppMessageCampaign_totalCap :: Lens' InAppMessageCampaign (Maybe Int)
- inAppMessageCampaign_treatmentId :: Lens' InAppMessageCampaign (Maybe Text)
- data InAppMessageContent = InAppMessageContent' {}
- newInAppMessageContent :: InAppMessageContent
- inAppMessageContent_backgroundColor :: Lens' InAppMessageContent (Maybe Text)
- inAppMessageContent_bodyConfig :: Lens' InAppMessageContent (Maybe InAppMessageBodyConfig)
- inAppMessageContent_headerConfig :: Lens' InAppMessageContent (Maybe InAppMessageHeaderConfig)
- inAppMessageContent_imageUrl :: Lens' InAppMessageContent (Maybe Text)
- inAppMessageContent_primaryBtn :: Lens' InAppMessageContent (Maybe InAppMessageButton)
- inAppMessageContent_secondaryBtn :: Lens' InAppMessageContent (Maybe InAppMessageButton)
- data InAppMessageHeaderConfig = InAppMessageHeaderConfig' {}
- newInAppMessageHeaderConfig :: Alignment -> Text -> Text -> InAppMessageHeaderConfig
- inAppMessageHeaderConfig_alignment :: Lens' InAppMessageHeaderConfig Alignment
- inAppMessageHeaderConfig_header :: Lens' InAppMessageHeaderConfig Text
- inAppMessageHeaderConfig_textColor :: Lens' InAppMessageHeaderConfig Text
- data InAppMessagesResponse = InAppMessagesResponse' {}
- newInAppMessagesResponse :: InAppMessagesResponse
- inAppMessagesResponse_inAppMessageCampaigns :: Lens' InAppMessagesResponse (Maybe [InAppMessageCampaign])
- data InAppTemplateRequest = InAppTemplateRequest' {}
- newInAppTemplateRequest :: InAppTemplateRequest
- inAppTemplateRequest_content :: Lens' InAppTemplateRequest (Maybe [InAppMessageContent])
- inAppTemplateRequest_customConfig :: Lens' InAppTemplateRequest (Maybe (HashMap Text Text))
- inAppTemplateRequest_layout :: Lens' InAppTemplateRequest (Maybe Layout)
- inAppTemplateRequest_templateDescription :: Lens' InAppTemplateRequest (Maybe Text)
- inAppTemplateRequest_tags :: Lens' InAppTemplateRequest (Maybe (HashMap Text Text))
- data InAppTemplateResponse = InAppTemplateResponse' {
- arn :: Maybe Text
- content :: Maybe [InAppMessageContent]
- customConfig :: Maybe (HashMap Text Text)
- layout :: Maybe Layout
- templateDescription :: Maybe Text
- version :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- lastModifiedDate :: Text
- creationDate :: Text
- templateName :: Text
- templateType :: TemplateType
- newInAppTemplateResponse :: Text -> Text -> Text -> TemplateType -> InAppTemplateResponse
- inAppTemplateResponse_arn :: Lens' InAppTemplateResponse (Maybe Text)
- inAppTemplateResponse_content :: Lens' InAppTemplateResponse (Maybe [InAppMessageContent])
- inAppTemplateResponse_customConfig :: Lens' InAppTemplateResponse (Maybe (HashMap Text Text))
- inAppTemplateResponse_layout :: Lens' InAppTemplateResponse (Maybe Layout)
- inAppTemplateResponse_templateDescription :: Lens' InAppTemplateResponse (Maybe Text)
- inAppTemplateResponse_version :: Lens' InAppTemplateResponse (Maybe Text)
- inAppTemplateResponse_tags :: Lens' InAppTemplateResponse (Maybe (HashMap Text Text))
- inAppTemplateResponse_lastModifiedDate :: Lens' InAppTemplateResponse Text
- inAppTemplateResponse_creationDate :: Lens' InAppTemplateResponse Text
- inAppTemplateResponse_templateName :: Lens' InAppTemplateResponse Text
- inAppTemplateResponse_templateType :: Lens' InAppTemplateResponse TemplateType
- data ItemResponse = ItemResponse' {}
- newItemResponse :: ItemResponse
- itemResponse_endpointItemResponse :: Lens' ItemResponse (Maybe EndpointItemResponse)
- itemResponse_eventsItemResponse :: Lens' ItemResponse (Maybe (HashMap Text EventItemResponse))
- data JourneyChannelSettings = JourneyChannelSettings' {}
- newJourneyChannelSettings :: JourneyChannelSettings
- journeyChannelSettings_connectCampaignArn :: Lens' JourneyChannelSettings (Maybe Text)
- journeyChannelSettings_connectCampaignExecutionRoleArn :: Lens' JourneyChannelSettings (Maybe Text)
- data JourneyCustomMessage = JourneyCustomMessage' {}
- newJourneyCustomMessage :: JourneyCustomMessage
- journeyCustomMessage_data :: Lens' JourneyCustomMessage (Maybe Text)
- data JourneyDateRangeKpiResponse = JourneyDateRangeKpiResponse' {}
- newJourneyDateRangeKpiResponse :: BaseKpiResult -> Text -> Text -> UTCTime -> UTCTime -> Text -> JourneyDateRangeKpiResponse
- journeyDateRangeKpiResponse_nextToken :: Lens' JourneyDateRangeKpiResponse (Maybe Text)
- journeyDateRangeKpiResponse_kpiResult :: Lens' JourneyDateRangeKpiResponse BaseKpiResult
- journeyDateRangeKpiResponse_kpiName :: Lens' JourneyDateRangeKpiResponse Text
- journeyDateRangeKpiResponse_journeyId :: Lens' JourneyDateRangeKpiResponse Text
- journeyDateRangeKpiResponse_endTime :: Lens' JourneyDateRangeKpiResponse UTCTime
- journeyDateRangeKpiResponse_startTime :: Lens' JourneyDateRangeKpiResponse UTCTime
- journeyDateRangeKpiResponse_applicationId :: Lens' JourneyDateRangeKpiResponse Text
- data JourneyEmailMessage = JourneyEmailMessage' {
- fromAddress :: Maybe Text
- newJourneyEmailMessage :: JourneyEmailMessage
- journeyEmailMessage_fromAddress :: Lens' JourneyEmailMessage (Maybe Text)
- data JourneyExecutionActivityMetricsResponse = JourneyExecutionActivityMetricsResponse' {}
- newJourneyExecutionActivityMetricsResponse :: Text -> Text -> Text -> Text -> Text -> JourneyExecutionActivityMetricsResponse
- journeyExecutionActivityMetricsResponse_metrics :: Lens' JourneyExecutionActivityMetricsResponse (HashMap Text Text)
- journeyExecutionActivityMetricsResponse_journeyId :: Lens' JourneyExecutionActivityMetricsResponse Text
- journeyExecutionActivityMetricsResponse_lastEvaluatedTime :: Lens' JourneyExecutionActivityMetricsResponse Text
- journeyExecutionActivityMetricsResponse_journeyActivityId :: Lens' JourneyExecutionActivityMetricsResponse Text
- journeyExecutionActivityMetricsResponse_activityType :: Lens' JourneyExecutionActivityMetricsResponse Text
- journeyExecutionActivityMetricsResponse_applicationId :: Lens' JourneyExecutionActivityMetricsResponse Text
- data JourneyExecutionMetricsResponse = JourneyExecutionMetricsResponse' {}
- newJourneyExecutionMetricsResponse :: Text -> Text -> Text -> JourneyExecutionMetricsResponse
- journeyExecutionMetricsResponse_metrics :: Lens' JourneyExecutionMetricsResponse (HashMap Text Text)
- journeyExecutionMetricsResponse_journeyId :: Lens' JourneyExecutionMetricsResponse Text
- journeyExecutionMetricsResponse_lastEvaluatedTime :: Lens' JourneyExecutionMetricsResponse Text
- journeyExecutionMetricsResponse_applicationId :: Lens' JourneyExecutionMetricsResponse Text
- data JourneyLimits = JourneyLimits' {}
- newJourneyLimits :: JourneyLimits
- journeyLimits_dailyCap :: Lens' JourneyLimits (Maybe Int)
- journeyLimits_endpointReentryCap :: Lens' JourneyLimits (Maybe Int)
- journeyLimits_endpointReentryInterval :: Lens' JourneyLimits (Maybe Text)
- journeyLimits_messagesPerSecond :: Lens' JourneyLimits (Maybe Int)
- data JourneyPushMessage = JourneyPushMessage' {
- timeToLive :: Maybe Text
- newJourneyPushMessage :: JourneyPushMessage
- journeyPushMessage_timeToLive :: Lens' JourneyPushMessage (Maybe Text)
- data JourneyResponse = JourneyResponse' {
- activities :: Maybe (HashMap Text Activity)
- closedDays :: Maybe ClosedDays
- creationDate :: Maybe Text
- journeyChannelSettings :: Maybe JourneyChannelSettings
- lastModifiedDate :: Maybe Text
- limits :: Maybe JourneyLimits
- localTime :: Maybe Bool
- openHours :: Maybe OpenHours
- quietTime :: Maybe QuietTime
- refreshFrequency :: Maybe Text
- refreshOnSegmentUpdate :: Maybe Bool
- schedule :: Maybe JourneySchedule
- sendingSchedule :: Maybe Bool
- startActivity :: Maybe Text
- startCondition :: Maybe StartCondition
- state :: Maybe State
- waitForQuietTime :: Maybe Bool
- tags :: Maybe (HashMap Text Text)
- name :: Text
- id :: Text
- applicationId :: Text
- newJourneyResponse :: Text -> Text -> Text -> JourneyResponse
- journeyResponse_activities :: Lens' JourneyResponse (Maybe (HashMap Text Activity))
- journeyResponse_closedDays :: Lens' JourneyResponse (Maybe ClosedDays)
- journeyResponse_creationDate :: Lens' JourneyResponse (Maybe Text)
- journeyResponse_journeyChannelSettings :: Lens' JourneyResponse (Maybe JourneyChannelSettings)
- journeyResponse_lastModifiedDate :: Lens' JourneyResponse (Maybe Text)
- journeyResponse_limits :: Lens' JourneyResponse (Maybe JourneyLimits)
- journeyResponse_localTime :: Lens' JourneyResponse (Maybe Bool)
- journeyResponse_openHours :: Lens' JourneyResponse (Maybe OpenHours)
- journeyResponse_quietTime :: Lens' JourneyResponse (Maybe QuietTime)
- journeyResponse_refreshFrequency :: Lens' JourneyResponse (Maybe Text)
- journeyResponse_refreshOnSegmentUpdate :: Lens' JourneyResponse (Maybe Bool)
- journeyResponse_schedule :: Lens' JourneyResponse (Maybe JourneySchedule)
- journeyResponse_sendingSchedule :: Lens' JourneyResponse (Maybe Bool)
- journeyResponse_startActivity :: Lens' JourneyResponse (Maybe Text)
- journeyResponse_startCondition :: Lens' JourneyResponse (Maybe StartCondition)
- journeyResponse_state :: Lens' JourneyResponse (Maybe State)
- journeyResponse_waitForQuietTime :: Lens' JourneyResponse (Maybe Bool)
- journeyResponse_tags :: Lens' JourneyResponse (Maybe (HashMap Text Text))
- journeyResponse_name :: Lens' JourneyResponse Text
- journeyResponse_id :: Lens' JourneyResponse Text
- journeyResponse_applicationId :: Lens' JourneyResponse Text
- data JourneySMSMessage = JourneySMSMessage' {}
- newJourneySMSMessage :: JourneySMSMessage
- journeySMSMessage_entityId :: Lens' JourneySMSMessage (Maybe Text)
- journeySMSMessage_messageType :: Lens' JourneySMSMessage (Maybe MessageType)
- journeySMSMessage_originationNumber :: Lens' JourneySMSMessage (Maybe Text)
- journeySMSMessage_senderId :: Lens' JourneySMSMessage (Maybe Text)
- journeySMSMessage_templateId :: Lens' JourneySMSMessage (Maybe Text)
- data JourneySchedule = JourneySchedule' {}
- newJourneySchedule :: JourneySchedule
- journeySchedule_endTime :: Lens' JourneySchedule (Maybe UTCTime)
- journeySchedule_startTime :: Lens' JourneySchedule (Maybe UTCTime)
- journeySchedule_timezone :: Lens' JourneySchedule (Maybe Text)
- data JourneyStateRequest = JourneyStateRequest' {}
- newJourneyStateRequest :: JourneyStateRequest
- journeyStateRequest_state :: Lens' JourneyStateRequest (Maybe State)
- data JourneysResponse = JourneysResponse' {
- nextToken :: Maybe Text
- item :: [JourneyResponse]
- newJourneysResponse :: JourneysResponse
- journeysResponse_nextToken :: Lens' JourneysResponse (Maybe Text)
- journeysResponse_item :: Lens' JourneysResponse [JourneyResponse]
- data ListRecommenderConfigurationsResponse = ListRecommenderConfigurationsResponse' {}
- newListRecommenderConfigurationsResponse :: ListRecommenderConfigurationsResponse
- listRecommenderConfigurationsResponse_nextToken :: Lens' ListRecommenderConfigurationsResponse (Maybe Text)
- listRecommenderConfigurationsResponse_item :: Lens' ListRecommenderConfigurationsResponse [RecommenderConfigurationResponse]
- data Message = Message' {}
- newMessage :: Message
- message_action :: Lens' Message (Maybe Action)
- message_body :: Lens' Message (Maybe Text)
- message_imageIconUrl :: Lens' Message (Maybe Text)
- message_imageSmallIconUrl :: Lens' Message (Maybe Text)
- message_imageUrl :: Lens' Message (Maybe Text)
- message_jsonBody :: Lens' Message (Maybe Text)
- message_mediaUrl :: Lens' Message (Maybe Text)
- message_rawContent :: Lens' Message (Maybe Text)
- message_silentPush :: Lens' Message (Maybe Bool)
- message_timeToLive :: Lens' Message (Maybe Int)
- message_title :: Lens' Message (Maybe Text)
- message_url :: Lens' Message (Maybe Text)
- data MessageBody = MessageBody' {}
- newMessageBody :: MessageBody
- messageBody_message :: Lens' MessageBody (Maybe Text)
- messageBody_requestID :: Lens' MessageBody (Maybe Text)
- data MessageConfiguration = MessageConfiguration' {
- aDMMessage :: Maybe Message
- aPNSMessage :: Maybe Message
- baiduMessage :: Maybe Message
- customMessage :: Maybe CampaignCustomMessage
- defaultMessage :: Maybe Message
- emailMessage :: Maybe CampaignEmailMessage
- gCMMessage :: Maybe Message
- inAppMessage :: Maybe CampaignInAppMessage
- sMSMessage :: Maybe CampaignSmsMessage
- newMessageConfiguration :: MessageConfiguration
- messageConfiguration_aDMMessage :: Lens' MessageConfiguration (Maybe Message)
- messageConfiguration_aPNSMessage :: Lens' MessageConfiguration (Maybe Message)
- messageConfiguration_baiduMessage :: Lens' MessageConfiguration (Maybe Message)
- messageConfiguration_customMessage :: Lens' MessageConfiguration (Maybe CampaignCustomMessage)
- messageConfiguration_defaultMessage :: Lens' MessageConfiguration (Maybe Message)
- messageConfiguration_emailMessage :: Lens' MessageConfiguration (Maybe CampaignEmailMessage)
- messageConfiguration_gCMMessage :: Lens' MessageConfiguration (Maybe Message)
- messageConfiguration_inAppMessage :: Lens' MessageConfiguration (Maybe CampaignInAppMessage)
- messageConfiguration_sMSMessage :: Lens' MessageConfiguration (Maybe CampaignSmsMessage)
- data MessageRequest = MessageRequest' {}
- newMessageRequest :: DirectMessageConfiguration -> MessageRequest
- messageRequest_addresses :: Lens' MessageRequest (Maybe (HashMap Text AddressConfiguration))
- messageRequest_context :: Lens' MessageRequest (Maybe (HashMap Text Text))
- messageRequest_endpoints :: Lens' MessageRequest (Maybe (HashMap Text EndpointSendConfiguration))
- messageRequest_templateConfiguration :: Lens' MessageRequest (Maybe TemplateConfiguration)
- messageRequest_traceId :: Lens' MessageRequest (Maybe Text)
- messageRequest_messageConfiguration :: Lens' MessageRequest DirectMessageConfiguration
- data MessageResponse = MessageResponse' {}
- newMessageResponse :: Text -> MessageResponse
- messageResponse_endpointResult :: Lens' MessageResponse (Maybe (HashMap Text EndpointMessageResult))
- messageResponse_requestId :: Lens' MessageResponse (Maybe Text)
- messageResponse_result :: Lens' MessageResponse (Maybe (HashMap Text MessageResult))
- messageResponse_applicationId :: Lens' MessageResponse Text
- data MessageResult = MessageResult' {}
- newMessageResult :: DeliveryStatus -> Int -> MessageResult
- messageResult_messageId :: Lens' MessageResult (Maybe Text)
- messageResult_statusMessage :: Lens' MessageResult (Maybe Text)
- messageResult_updatedToken :: Lens' MessageResult (Maybe Text)
- messageResult_deliveryStatus :: Lens' MessageResult DeliveryStatus
- messageResult_statusCode :: Lens' MessageResult Int
- data MetricDimension = MetricDimension' {}
- newMetricDimension :: Text -> Double -> MetricDimension
- metricDimension_comparisonOperator :: Lens' MetricDimension Text
- metricDimension_value :: Lens' MetricDimension Double
- data MultiConditionalBranch = MultiConditionalBranch' {}
- newMultiConditionalBranch :: MultiConditionalBranch
- multiConditionalBranch_condition :: Lens' MultiConditionalBranch (Maybe SimpleCondition)
- multiConditionalBranch_nextActivity :: Lens' MultiConditionalBranch (Maybe Text)
- data MultiConditionalSplitActivity = MultiConditionalSplitActivity' {}
- newMultiConditionalSplitActivity :: MultiConditionalSplitActivity
- multiConditionalSplitActivity_branches :: Lens' MultiConditionalSplitActivity (Maybe [MultiConditionalBranch])
- multiConditionalSplitActivity_defaultActivity :: Lens' MultiConditionalSplitActivity (Maybe Text)
- multiConditionalSplitActivity_evaluationWaitTime :: Lens' MultiConditionalSplitActivity (Maybe WaitTime)
- data NumberValidateRequest = NumberValidateRequest' {}
- newNumberValidateRequest :: NumberValidateRequest
- numberValidateRequest_isoCountryCode :: Lens' NumberValidateRequest (Maybe Text)
- numberValidateRequest_phoneNumber :: Lens' NumberValidateRequest (Maybe Text)
- data NumberValidateResponse = NumberValidateResponse' {
- carrier :: Maybe Text
- city :: Maybe Text
- cleansedPhoneNumberE164 :: Maybe Text
- cleansedPhoneNumberNational :: Maybe Text
- country :: Maybe Text
- countryCodeIso2 :: Maybe Text
- countryCodeNumeric :: Maybe Text
- county :: Maybe Text
- originalCountryCodeIso2 :: Maybe Text
- originalPhoneNumber :: Maybe Text
- phoneType :: Maybe Text
- phoneTypeCode :: Maybe Int
- timezone :: Maybe Text
- zipCode :: Maybe Text
- newNumberValidateResponse :: NumberValidateResponse
- numberValidateResponse_carrier :: Lens' NumberValidateResponse (Maybe Text)
- numberValidateResponse_city :: Lens' NumberValidateResponse (Maybe Text)
- numberValidateResponse_cleansedPhoneNumberE164 :: Lens' NumberValidateResponse (Maybe Text)
- numberValidateResponse_cleansedPhoneNumberNational :: Lens' NumberValidateResponse (Maybe Text)
- numberValidateResponse_country :: Lens' NumberValidateResponse (Maybe Text)
- numberValidateResponse_countryCodeIso2 :: Lens' NumberValidateResponse (Maybe Text)
- numberValidateResponse_countryCodeNumeric :: Lens' NumberValidateResponse (Maybe Text)
- numberValidateResponse_county :: Lens' NumberValidateResponse (Maybe Text)
- numberValidateResponse_originalCountryCodeIso2 :: Lens' NumberValidateResponse (Maybe Text)
- numberValidateResponse_originalPhoneNumber :: Lens' NumberValidateResponse (Maybe Text)
- numberValidateResponse_phoneType :: Lens' NumberValidateResponse (Maybe Text)
- numberValidateResponse_phoneTypeCode :: Lens' NumberValidateResponse (Maybe Int)
- numberValidateResponse_timezone :: Lens' NumberValidateResponse (Maybe Text)
- numberValidateResponse_zipCode :: Lens' NumberValidateResponse (Maybe Text)
- data OpenHours = OpenHours' {
- custom :: Maybe (HashMap DayOfWeek [OpenHoursRule])
- email :: Maybe (HashMap DayOfWeek [OpenHoursRule])
- push :: Maybe (HashMap DayOfWeek [OpenHoursRule])
- sms :: Maybe (HashMap DayOfWeek [OpenHoursRule])
- voice :: Maybe (HashMap DayOfWeek [OpenHoursRule])
- newOpenHours :: OpenHours
- openHours_custom :: Lens' OpenHours (Maybe (HashMap DayOfWeek [OpenHoursRule]))
- openHours_email :: Lens' OpenHours (Maybe (HashMap DayOfWeek [OpenHoursRule]))
- openHours_push :: Lens' OpenHours (Maybe (HashMap DayOfWeek [OpenHoursRule]))
- openHours_sms :: Lens' OpenHours (Maybe (HashMap DayOfWeek [OpenHoursRule]))
- openHours_voice :: Lens' OpenHours (Maybe (HashMap DayOfWeek [OpenHoursRule]))
- data OpenHoursRule = OpenHoursRule' {}
- newOpenHoursRule :: OpenHoursRule
- openHoursRule_endTime :: Lens' OpenHoursRule (Maybe Text)
- openHoursRule_startTime :: Lens' OpenHoursRule (Maybe Text)
- data OverrideButtonConfiguration = OverrideButtonConfiguration' {}
- newOverrideButtonConfiguration :: ButtonAction -> OverrideButtonConfiguration
- overrideButtonConfiguration_link :: Lens' OverrideButtonConfiguration (Maybe Text)
- overrideButtonConfiguration_buttonAction :: Lens' OverrideButtonConfiguration ButtonAction
- data PublicEndpoint = PublicEndpoint' {
- address :: Maybe Text
- attributes :: Maybe (HashMap Text [Text])
- channelType :: Maybe ChannelType
- demographic :: Maybe EndpointDemographic
- effectiveDate :: Maybe Text
- endpointStatus :: Maybe Text
- location :: Maybe EndpointLocation
- metrics :: Maybe (HashMap Text Double)
- optOut :: Maybe Text
- requestId :: Maybe Text
- user :: Maybe EndpointUser
- newPublicEndpoint :: PublicEndpoint
- publicEndpoint_address :: Lens' PublicEndpoint (Maybe Text)
- publicEndpoint_attributes :: Lens' PublicEndpoint (Maybe (HashMap Text [Text]))
- publicEndpoint_channelType :: Lens' PublicEndpoint (Maybe ChannelType)
- publicEndpoint_demographic :: Lens' PublicEndpoint (Maybe EndpointDemographic)
- publicEndpoint_effectiveDate :: Lens' PublicEndpoint (Maybe Text)
- publicEndpoint_endpointStatus :: Lens' PublicEndpoint (Maybe Text)
- publicEndpoint_location :: Lens' PublicEndpoint (Maybe EndpointLocation)
- publicEndpoint_metrics :: Lens' PublicEndpoint (Maybe (HashMap Text Double))
- publicEndpoint_optOut :: Lens' PublicEndpoint (Maybe Text)
- publicEndpoint_requestId :: Lens' PublicEndpoint (Maybe Text)
- publicEndpoint_user :: Lens' PublicEndpoint (Maybe EndpointUser)
- data PushMessageActivity = PushMessageActivity' {}
- newPushMessageActivity :: PushMessageActivity
- pushMessageActivity_messageConfig :: Lens' PushMessageActivity (Maybe JourneyPushMessage)
- pushMessageActivity_nextActivity :: Lens' PushMessageActivity (Maybe Text)
- pushMessageActivity_templateName :: Lens' PushMessageActivity (Maybe Text)
- pushMessageActivity_templateVersion :: Lens' PushMessageActivity (Maybe Text)
- data PushNotificationTemplateRequest = PushNotificationTemplateRequest' {
- adm :: Maybe AndroidPushNotificationTemplate
- apns :: Maybe APNSPushNotificationTemplate
- baidu :: Maybe AndroidPushNotificationTemplate
- default' :: Maybe DefaultPushNotificationTemplate
- defaultSubstitutions :: Maybe Text
- gcm :: Maybe AndroidPushNotificationTemplate
- recommenderId :: Maybe Text
- templateDescription :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- newPushNotificationTemplateRequest :: PushNotificationTemplateRequest
- pushNotificationTemplateRequest_adm :: Lens' PushNotificationTemplateRequest (Maybe AndroidPushNotificationTemplate)
- pushNotificationTemplateRequest_apns :: Lens' PushNotificationTemplateRequest (Maybe APNSPushNotificationTemplate)
- pushNotificationTemplateRequest_baidu :: Lens' PushNotificationTemplateRequest (Maybe AndroidPushNotificationTemplate)
- pushNotificationTemplateRequest_default :: Lens' PushNotificationTemplateRequest (Maybe DefaultPushNotificationTemplate)
- pushNotificationTemplateRequest_defaultSubstitutions :: Lens' PushNotificationTemplateRequest (Maybe Text)
- pushNotificationTemplateRequest_gcm :: Lens' PushNotificationTemplateRequest (Maybe AndroidPushNotificationTemplate)
- pushNotificationTemplateRequest_recommenderId :: Lens' PushNotificationTemplateRequest (Maybe Text)
- pushNotificationTemplateRequest_templateDescription :: Lens' PushNotificationTemplateRequest (Maybe Text)
- pushNotificationTemplateRequest_tags :: Lens' PushNotificationTemplateRequest (Maybe (HashMap Text Text))
- data PushNotificationTemplateResponse = PushNotificationTemplateResponse' {
- adm :: Maybe AndroidPushNotificationTemplate
- apns :: Maybe APNSPushNotificationTemplate
- arn :: Maybe Text
- baidu :: Maybe AndroidPushNotificationTemplate
- default' :: Maybe DefaultPushNotificationTemplate
- defaultSubstitutions :: Maybe Text
- gcm :: Maybe AndroidPushNotificationTemplate
- recommenderId :: Maybe Text
- templateDescription :: Maybe Text
- version :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- lastModifiedDate :: Text
- creationDate :: Text
- templateType :: TemplateType
- templateName :: Text
- newPushNotificationTemplateResponse :: Text -> Text -> TemplateType -> Text -> PushNotificationTemplateResponse
- pushNotificationTemplateResponse_adm :: Lens' PushNotificationTemplateResponse (Maybe AndroidPushNotificationTemplate)
- pushNotificationTemplateResponse_apns :: Lens' PushNotificationTemplateResponse (Maybe APNSPushNotificationTemplate)
- pushNotificationTemplateResponse_arn :: Lens' PushNotificationTemplateResponse (Maybe Text)
- pushNotificationTemplateResponse_baidu :: Lens' PushNotificationTemplateResponse (Maybe AndroidPushNotificationTemplate)
- pushNotificationTemplateResponse_default :: Lens' PushNotificationTemplateResponse (Maybe DefaultPushNotificationTemplate)
- pushNotificationTemplateResponse_defaultSubstitutions :: Lens' PushNotificationTemplateResponse (Maybe Text)
- pushNotificationTemplateResponse_gcm :: Lens' PushNotificationTemplateResponse (Maybe AndroidPushNotificationTemplate)
- pushNotificationTemplateResponse_recommenderId :: Lens' PushNotificationTemplateResponse (Maybe Text)
- pushNotificationTemplateResponse_templateDescription :: Lens' PushNotificationTemplateResponse (Maybe Text)
- pushNotificationTemplateResponse_version :: Lens' PushNotificationTemplateResponse (Maybe Text)
- pushNotificationTemplateResponse_tags :: Lens' PushNotificationTemplateResponse (Maybe (HashMap Text Text))
- pushNotificationTemplateResponse_lastModifiedDate :: Lens' PushNotificationTemplateResponse Text
- pushNotificationTemplateResponse_creationDate :: Lens' PushNotificationTemplateResponse Text
- pushNotificationTemplateResponse_templateType :: Lens' PushNotificationTemplateResponse TemplateType
- pushNotificationTemplateResponse_templateName :: Lens' PushNotificationTemplateResponse Text
- data QuietTime = QuietTime' {}
- newQuietTime :: QuietTime
- quietTime_end :: Lens' QuietTime (Maybe Text)
- quietTime_start :: Lens' QuietTime (Maybe Text)
- data RandomSplitActivity = RandomSplitActivity' {}
- newRandomSplitActivity :: RandomSplitActivity
- randomSplitActivity_branches :: Lens' RandomSplitActivity (Maybe [RandomSplitEntry])
- data RandomSplitEntry = RandomSplitEntry' {
- nextActivity :: Maybe Text
- percentage :: Maybe Int
- newRandomSplitEntry :: RandomSplitEntry
- randomSplitEntry_nextActivity :: Lens' RandomSplitEntry (Maybe Text)
- randomSplitEntry_percentage :: Lens' RandomSplitEntry (Maybe Int)
- data RawEmail = RawEmail' {}
- newRawEmail :: RawEmail
- rawEmail_data :: Lens' RawEmail (Maybe ByteString)
- data RecencyDimension = RecencyDimension' {}
- newRecencyDimension :: Duration -> RecencyType -> RecencyDimension
- recencyDimension_duration :: Lens' RecencyDimension Duration
- recencyDimension_recencyType :: Lens' RecencyDimension RecencyType
- data RecommenderConfigurationResponse = RecommenderConfigurationResponse' {
- attributes :: Maybe (HashMap Text Text)
- description :: Maybe Text
- name :: Maybe Text
- recommendationProviderIdType :: Maybe Text
- recommendationTransformerUri :: Maybe Text
- recommendationsDisplayName :: Maybe Text
- recommendationsPerMessage :: Maybe Int
- recommendationProviderUri :: Text
- lastModifiedDate :: Text
- creationDate :: Text
- recommendationProviderRoleArn :: Text
- id :: Text
- newRecommenderConfigurationResponse :: Text -> Text -> Text -> Text -> Text -> RecommenderConfigurationResponse
- recommenderConfigurationResponse_attributes :: Lens' RecommenderConfigurationResponse (Maybe (HashMap Text Text))
- recommenderConfigurationResponse_description :: Lens' RecommenderConfigurationResponse (Maybe Text)
- recommenderConfigurationResponse_name :: Lens' RecommenderConfigurationResponse (Maybe Text)
- recommenderConfigurationResponse_recommendationProviderIdType :: Lens' RecommenderConfigurationResponse (Maybe Text)
- recommenderConfigurationResponse_recommendationTransformerUri :: Lens' RecommenderConfigurationResponse (Maybe Text)
- recommenderConfigurationResponse_recommendationsDisplayName :: Lens' RecommenderConfigurationResponse (Maybe Text)
- recommenderConfigurationResponse_recommendationsPerMessage :: Lens' RecommenderConfigurationResponse (Maybe Int)
- recommenderConfigurationResponse_recommendationProviderUri :: Lens' RecommenderConfigurationResponse Text
- recommenderConfigurationResponse_lastModifiedDate :: Lens' RecommenderConfigurationResponse Text
- recommenderConfigurationResponse_creationDate :: Lens' RecommenderConfigurationResponse Text
- recommenderConfigurationResponse_recommendationProviderRoleArn :: Lens' RecommenderConfigurationResponse Text
- recommenderConfigurationResponse_id :: Lens' RecommenderConfigurationResponse Text
- data ResultRow = ResultRow' {
- groupedBys :: [ResultRowValue]
- values :: [ResultRowValue]
- newResultRow :: ResultRow
- resultRow_groupedBys :: Lens' ResultRow [ResultRowValue]
- resultRow_values :: Lens' ResultRow [ResultRowValue]
- data ResultRowValue = ResultRowValue' {}
- newResultRowValue :: Text -> Text -> Text -> ResultRowValue
- resultRowValue_type :: Lens' ResultRowValue Text
- resultRowValue_value :: Lens' ResultRowValue Text
- resultRowValue_key :: Lens' ResultRowValue Text
- data SMSChannelRequest = SMSChannelRequest' {}
- newSMSChannelRequest :: SMSChannelRequest
- sMSChannelRequest_enabled :: Lens' SMSChannelRequest (Maybe Bool)
- sMSChannelRequest_senderId :: Lens' SMSChannelRequest (Maybe Text)
- sMSChannelRequest_shortCode :: Lens' SMSChannelRequest (Maybe Text)
- data SMSChannelResponse = SMSChannelResponse' {
- applicationId :: Maybe Text
- creationDate :: Maybe Text
- enabled :: Maybe Bool
- hasCredential :: Maybe Bool
- id :: Maybe Text
- isArchived :: Maybe Bool
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe Text
- promotionalMessagesPerSecond :: Maybe Int
- senderId :: Maybe Text
- shortCode :: Maybe Text
- transactionalMessagesPerSecond :: Maybe Int
- version :: Maybe Int
- platform :: Text
- newSMSChannelResponse :: Text -> SMSChannelResponse
- sMSChannelResponse_applicationId :: Lens' SMSChannelResponse (Maybe Text)
- sMSChannelResponse_creationDate :: Lens' SMSChannelResponse (Maybe Text)
- sMSChannelResponse_enabled :: Lens' SMSChannelResponse (Maybe Bool)
- sMSChannelResponse_hasCredential :: Lens' SMSChannelResponse (Maybe Bool)
- sMSChannelResponse_id :: Lens' SMSChannelResponse (Maybe Text)
- sMSChannelResponse_isArchived :: Lens' SMSChannelResponse (Maybe Bool)
- sMSChannelResponse_lastModifiedBy :: Lens' SMSChannelResponse (Maybe Text)
- sMSChannelResponse_lastModifiedDate :: Lens' SMSChannelResponse (Maybe Text)
- sMSChannelResponse_promotionalMessagesPerSecond :: Lens' SMSChannelResponse (Maybe Int)
- sMSChannelResponse_senderId :: Lens' SMSChannelResponse (Maybe Text)
- sMSChannelResponse_shortCode :: Lens' SMSChannelResponse (Maybe Text)
- sMSChannelResponse_transactionalMessagesPerSecond :: Lens' SMSChannelResponse (Maybe Int)
- sMSChannelResponse_version :: Lens' SMSChannelResponse (Maybe Int)
- sMSChannelResponse_platform :: Lens' SMSChannelResponse Text
- data SMSMessage = SMSMessage' {}
- newSMSMessage :: SMSMessage
- sMSMessage_body :: Lens' SMSMessage (Maybe Text)
- sMSMessage_entityId :: Lens' SMSMessage (Maybe Text)
- sMSMessage_keyword :: Lens' SMSMessage (Maybe Text)
- sMSMessage_mediaUrl :: Lens' SMSMessage (Maybe Text)
- sMSMessage_messageType :: Lens' SMSMessage (Maybe MessageType)
- sMSMessage_originationNumber :: Lens' SMSMessage (Maybe Text)
- sMSMessage_senderId :: Lens' SMSMessage (Maybe Text)
- sMSMessage_substitutions :: Lens' SMSMessage (Maybe (HashMap Text [Text]))
- sMSMessage_templateId :: Lens' SMSMessage (Maybe Text)
- data SMSMessageActivity = SMSMessageActivity' {}
- newSMSMessageActivity :: SMSMessageActivity
- sMSMessageActivity_messageConfig :: Lens' SMSMessageActivity (Maybe JourneySMSMessage)
- sMSMessageActivity_nextActivity :: Lens' SMSMessageActivity (Maybe Text)
- sMSMessageActivity_templateName :: Lens' SMSMessageActivity (Maybe Text)
- sMSMessageActivity_templateVersion :: Lens' SMSMessageActivity (Maybe Text)
- data SMSTemplateRequest = SMSTemplateRequest' {}
- newSMSTemplateRequest :: SMSTemplateRequest
- sMSTemplateRequest_body :: Lens' SMSTemplateRequest (Maybe Text)
- sMSTemplateRequest_defaultSubstitutions :: Lens' SMSTemplateRequest (Maybe Text)
- sMSTemplateRequest_recommenderId :: Lens' SMSTemplateRequest (Maybe Text)
- sMSTemplateRequest_templateDescription :: Lens' SMSTemplateRequest (Maybe Text)
- sMSTemplateRequest_tags :: Lens' SMSTemplateRequest (Maybe (HashMap Text Text))
- data SMSTemplateResponse = SMSTemplateResponse' {
- arn :: Maybe Text
- body :: Maybe Text
- defaultSubstitutions :: Maybe Text
- recommenderId :: Maybe Text
- templateDescription :: Maybe Text
- version :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- lastModifiedDate :: Text
- creationDate :: Text
- templateName :: Text
- templateType :: TemplateType
- newSMSTemplateResponse :: Text -> Text -> Text -> TemplateType -> SMSTemplateResponse
- sMSTemplateResponse_arn :: Lens' SMSTemplateResponse (Maybe Text)
- sMSTemplateResponse_body :: Lens' SMSTemplateResponse (Maybe Text)
- sMSTemplateResponse_defaultSubstitutions :: Lens' SMSTemplateResponse (Maybe Text)
- sMSTemplateResponse_recommenderId :: Lens' SMSTemplateResponse (Maybe Text)
- sMSTemplateResponse_templateDescription :: Lens' SMSTemplateResponse (Maybe Text)
- sMSTemplateResponse_version :: Lens' SMSTemplateResponse (Maybe Text)
- sMSTemplateResponse_tags :: Lens' SMSTemplateResponse (Maybe (HashMap Text Text))
- sMSTemplateResponse_lastModifiedDate :: Lens' SMSTemplateResponse Text
- sMSTemplateResponse_creationDate :: Lens' SMSTemplateResponse Text
- sMSTemplateResponse_templateName :: Lens' SMSTemplateResponse Text
- sMSTemplateResponse_templateType :: Lens' SMSTemplateResponse TemplateType
- data Schedule = Schedule' {}
- newSchedule :: Text -> Schedule
- schedule_endTime :: Lens' Schedule (Maybe Text)
- schedule_eventFilter :: Lens' Schedule (Maybe CampaignEventFilter)
- schedule_frequency :: Lens' Schedule (Maybe Frequency)
- schedule_isLocalTime :: Lens' Schedule (Maybe Bool)
- schedule_quietTime :: Lens' Schedule (Maybe QuietTime)
- schedule_timezone :: Lens' Schedule (Maybe Text)
- schedule_startTime :: Lens' Schedule Text
- data SegmentBehaviors = SegmentBehaviors' {}
- newSegmentBehaviors :: SegmentBehaviors
- segmentBehaviors_recency :: Lens' SegmentBehaviors (Maybe RecencyDimension)
- data SegmentCondition = SegmentCondition' {}
- newSegmentCondition :: Text -> SegmentCondition
- segmentCondition_segmentId :: Lens' SegmentCondition Text
- data SegmentDemographics = SegmentDemographics' {}
- newSegmentDemographics :: SegmentDemographics
- segmentDemographics_appVersion :: Lens' SegmentDemographics (Maybe SetDimension)
- segmentDemographics_channel :: Lens' SegmentDemographics (Maybe SetDimension)
- segmentDemographics_deviceType :: Lens' SegmentDemographics (Maybe SetDimension)
- segmentDemographics_make :: Lens' SegmentDemographics (Maybe SetDimension)
- segmentDemographics_model :: Lens' SegmentDemographics (Maybe SetDimension)
- segmentDemographics_platform :: Lens' SegmentDemographics (Maybe SetDimension)
- data SegmentDimensions = SegmentDimensions' {}
- newSegmentDimensions :: SegmentDimensions
- segmentDimensions_attributes :: Lens' SegmentDimensions (Maybe (HashMap Text AttributeDimension))
- segmentDimensions_behavior :: Lens' SegmentDimensions (Maybe SegmentBehaviors)
- segmentDimensions_demographic :: Lens' SegmentDimensions (Maybe SegmentDemographics)
- segmentDimensions_location :: Lens' SegmentDimensions (Maybe SegmentLocation)
- segmentDimensions_metrics :: Lens' SegmentDimensions (Maybe (HashMap Text MetricDimension))
- segmentDimensions_userAttributes :: Lens' SegmentDimensions (Maybe (HashMap Text AttributeDimension))
- data SegmentGroup = SegmentGroup' {}
- newSegmentGroup :: SegmentGroup
- segmentGroup_dimensions :: Lens' SegmentGroup (Maybe [SegmentDimensions])
- segmentGroup_sourceSegments :: Lens' SegmentGroup (Maybe [SegmentReference])
- segmentGroup_sourceType :: Lens' SegmentGroup (Maybe SourceType)
- segmentGroup_type :: Lens' SegmentGroup (Maybe Type)
- data SegmentGroupList = SegmentGroupList' {}
- newSegmentGroupList :: SegmentGroupList
- segmentGroupList_groups :: Lens' SegmentGroupList (Maybe [SegmentGroup])
- segmentGroupList_include :: Lens' SegmentGroupList (Maybe Include)
- data SegmentImportResource = SegmentImportResource' {
- channelCounts :: Maybe (HashMap Text Int)
- format :: DefinitionFormat
- s3Url :: Text
- size :: Int
- externalId :: Text
- roleArn :: Text
- newSegmentImportResource :: DefinitionFormat -> Text -> Int -> Text -> Text -> SegmentImportResource
- segmentImportResource_channelCounts :: Lens' SegmentImportResource (Maybe (HashMap Text Int))
- segmentImportResource_format :: Lens' SegmentImportResource DefinitionFormat
- segmentImportResource_s3Url :: Lens' SegmentImportResource Text
- segmentImportResource_size :: Lens' SegmentImportResource Int
- segmentImportResource_externalId :: Lens' SegmentImportResource Text
- segmentImportResource_roleArn :: Lens' SegmentImportResource Text
- data SegmentLocation = SegmentLocation' {}
- newSegmentLocation :: SegmentLocation
- segmentLocation_country :: Lens' SegmentLocation (Maybe SetDimension)
- segmentLocation_gPSPoint :: Lens' SegmentLocation (Maybe GPSPointDimension)
- data SegmentReference = SegmentReference' {}
- newSegmentReference :: Text -> SegmentReference
- segmentReference_version :: Lens' SegmentReference (Maybe Int)
- segmentReference_id :: Lens' SegmentReference Text
- data SegmentResponse = SegmentResponse' {
- dimensions :: Maybe SegmentDimensions
- importDefinition :: Maybe SegmentImportResource
- lastModifiedDate :: Maybe Text
- name :: Maybe Text
- segmentGroups :: Maybe SegmentGroupList
- version :: Maybe Int
- tags :: Maybe (HashMap Text Text)
- segmentType :: SegmentType
- creationDate :: Text
- id :: Text
- arn :: Text
- applicationId :: Text
- newSegmentResponse :: SegmentType -> Text -> Text -> Text -> Text -> SegmentResponse
- segmentResponse_dimensions :: Lens' SegmentResponse (Maybe SegmentDimensions)
- segmentResponse_importDefinition :: Lens' SegmentResponse (Maybe SegmentImportResource)
- segmentResponse_lastModifiedDate :: Lens' SegmentResponse (Maybe Text)
- segmentResponse_name :: Lens' SegmentResponse (Maybe Text)
- segmentResponse_segmentGroups :: Lens' SegmentResponse (Maybe SegmentGroupList)
- segmentResponse_version :: Lens' SegmentResponse (Maybe Int)
- segmentResponse_tags :: Lens' SegmentResponse (Maybe (HashMap Text Text))
- segmentResponse_segmentType :: Lens' SegmentResponse SegmentType
- segmentResponse_creationDate :: Lens' SegmentResponse Text
- segmentResponse_id :: Lens' SegmentResponse Text
- segmentResponse_arn :: Lens' SegmentResponse Text
- segmentResponse_applicationId :: Lens' SegmentResponse Text
- data SegmentsResponse = SegmentsResponse' {
- nextToken :: Maybe Text
- item :: [SegmentResponse]
- newSegmentsResponse :: SegmentsResponse
- segmentsResponse_nextToken :: Lens' SegmentsResponse (Maybe Text)
- segmentsResponse_item :: Lens' SegmentsResponse [SegmentResponse]
- data SendOTPMessageRequestParameters = SendOTPMessageRequestParameters' {}
- newSendOTPMessageRequestParameters :: Text -> Text -> Text -> Text -> Text -> SendOTPMessageRequestParameters
- sendOTPMessageRequestParameters_allowedAttempts :: Lens' SendOTPMessageRequestParameters (Maybe Int)
- sendOTPMessageRequestParameters_codeLength :: Lens' SendOTPMessageRequestParameters (Maybe Int)
- sendOTPMessageRequestParameters_entityId :: Lens' SendOTPMessageRequestParameters (Maybe Text)
- sendOTPMessageRequestParameters_language :: Lens' SendOTPMessageRequestParameters (Maybe Text)
- sendOTPMessageRequestParameters_templateId :: Lens' SendOTPMessageRequestParameters (Maybe Text)
- sendOTPMessageRequestParameters_validityPeriod :: Lens' SendOTPMessageRequestParameters (Maybe Int)
- sendOTPMessageRequestParameters_brandName :: Lens' SendOTPMessageRequestParameters Text
- sendOTPMessageRequestParameters_referenceId :: Lens' SendOTPMessageRequestParameters Text
- sendOTPMessageRequestParameters_channel :: Lens' SendOTPMessageRequestParameters Text
- sendOTPMessageRequestParameters_destinationIdentity :: Lens' SendOTPMessageRequestParameters Text
- sendOTPMessageRequestParameters_originationIdentity :: Lens' SendOTPMessageRequestParameters Text
- data SendUsersMessageRequest = SendUsersMessageRequest' {}
- newSendUsersMessageRequest :: DirectMessageConfiguration -> SendUsersMessageRequest
- sendUsersMessageRequest_context :: Lens' SendUsersMessageRequest (Maybe (HashMap Text Text))
- sendUsersMessageRequest_templateConfiguration :: Lens' SendUsersMessageRequest (Maybe TemplateConfiguration)
- sendUsersMessageRequest_traceId :: Lens' SendUsersMessageRequest (Maybe Text)
- sendUsersMessageRequest_messageConfiguration :: Lens' SendUsersMessageRequest DirectMessageConfiguration
- sendUsersMessageRequest_users :: Lens' SendUsersMessageRequest (HashMap Text EndpointSendConfiguration)
- data SendUsersMessageResponse = SendUsersMessageResponse' {}
- newSendUsersMessageResponse :: Text -> SendUsersMessageResponse
- sendUsersMessageResponse_requestId :: Lens' SendUsersMessageResponse (Maybe Text)
- sendUsersMessageResponse_result :: Lens' SendUsersMessageResponse (Maybe (HashMap Text (HashMap Text EndpointMessageResult)))
- sendUsersMessageResponse_applicationId :: Lens' SendUsersMessageResponse Text
- data Session = Session' {
- duration :: Maybe Int
- stopTimestamp :: Maybe Text
- startTimestamp :: Text
- id :: Text
- newSession :: Text -> Text -> Session
- session_duration :: Lens' Session (Maybe Int)
- session_stopTimestamp :: Lens' Session (Maybe Text)
- session_startTimestamp :: Lens' Session Text
- session_id :: Lens' Session Text
- data SetDimension = SetDimension' {
- dimensionType :: Maybe DimensionType
- values :: [Text]
- newSetDimension :: SetDimension
- setDimension_dimensionType :: Lens' SetDimension (Maybe DimensionType)
- setDimension_values :: Lens' SetDimension [Text]
- data SimpleCondition = SimpleCondition' {}
- newSimpleCondition :: SimpleCondition
- simpleCondition_eventCondition :: Lens' SimpleCondition (Maybe EventCondition)
- simpleCondition_segmentCondition :: Lens' SimpleCondition (Maybe SegmentCondition)
- simpleCondition_segmentDimensions :: Lens' SimpleCondition (Maybe SegmentDimensions)
- data SimpleEmail = SimpleEmail' {}
- newSimpleEmail :: SimpleEmail
- simpleEmail_htmlPart :: Lens' SimpleEmail (Maybe SimpleEmailPart)
- simpleEmail_subject :: Lens' SimpleEmail (Maybe SimpleEmailPart)
- simpleEmail_textPart :: Lens' SimpleEmail (Maybe SimpleEmailPart)
- data SimpleEmailPart = SimpleEmailPart' {}
- newSimpleEmailPart :: SimpleEmailPart
- simpleEmailPart_charset :: Lens' SimpleEmailPart (Maybe Text)
- simpleEmailPart_data :: Lens' SimpleEmailPart (Maybe Text)
- data StartCondition = StartCondition' {}
- newStartCondition :: StartCondition
- startCondition_description :: Lens' StartCondition (Maybe Text)
- startCondition_eventStartCondition :: Lens' StartCondition (Maybe EventStartCondition)
- startCondition_segmentStartCondition :: Lens' StartCondition (Maybe SegmentCondition)
- data TagsModel = TagsModel' {}
- newTagsModel :: TagsModel
- tagsModel_tags :: Lens' TagsModel (HashMap Text Text)
- data Template = Template' {}
- newTemplate :: Template
- template_name :: Lens' Template (Maybe Text)
- template_version :: Lens' Template (Maybe Text)
- data TemplateActiveVersionRequest = TemplateActiveVersionRequest' {}
- newTemplateActiveVersionRequest :: TemplateActiveVersionRequest
- templateActiveVersionRequest_version :: Lens' TemplateActiveVersionRequest (Maybe Text)
- data TemplateConfiguration = TemplateConfiguration' {}
- newTemplateConfiguration :: TemplateConfiguration
- templateConfiguration_emailTemplate :: Lens' TemplateConfiguration (Maybe Template)
- templateConfiguration_pushTemplate :: Lens' TemplateConfiguration (Maybe Template)
- templateConfiguration_sMSTemplate :: Lens' TemplateConfiguration (Maybe Template)
- templateConfiguration_voiceTemplate :: Lens' TemplateConfiguration (Maybe Template)
- data TemplateCreateMessageBody = TemplateCreateMessageBody' {}
- newTemplateCreateMessageBody :: TemplateCreateMessageBody
- templateCreateMessageBody_arn :: Lens' TemplateCreateMessageBody (Maybe Text)
- templateCreateMessageBody_message :: Lens' TemplateCreateMessageBody (Maybe Text)
- templateCreateMessageBody_requestID :: Lens' TemplateCreateMessageBody (Maybe Text)
- data TemplateResponse = TemplateResponse' {}
- newTemplateResponse :: Text -> Text -> Text -> TemplateType -> TemplateResponse
- templateResponse_arn :: Lens' TemplateResponse (Maybe Text)
- templateResponse_defaultSubstitutions :: Lens' TemplateResponse (Maybe Text)
- templateResponse_templateDescription :: Lens' TemplateResponse (Maybe Text)
- templateResponse_version :: Lens' TemplateResponse (Maybe Text)
- templateResponse_tags :: Lens' TemplateResponse (Maybe (HashMap Text Text))
- templateResponse_lastModifiedDate :: Lens' TemplateResponse Text
- templateResponse_creationDate :: Lens' TemplateResponse Text
- templateResponse_templateName :: Lens' TemplateResponse Text
- templateResponse_templateType :: Lens' TemplateResponse TemplateType
- data TemplateVersionResponse = TemplateVersionResponse' {}
- newTemplateVersionResponse :: Text -> Text -> Text -> Text -> TemplateVersionResponse
- templateVersionResponse_defaultSubstitutions :: Lens' TemplateVersionResponse (Maybe Text)
- templateVersionResponse_templateDescription :: Lens' TemplateVersionResponse (Maybe Text)
- templateVersionResponse_version :: Lens' TemplateVersionResponse (Maybe Text)
- templateVersionResponse_lastModifiedDate :: Lens' TemplateVersionResponse Text
- templateVersionResponse_creationDate :: Lens' TemplateVersionResponse Text
- templateVersionResponse_templateName :: Lens' TemplateVersionResponse Text
- templateVersionResponse_templateType :: Lens' TemplateVersionResponse Text
- data TemplateVersionsResponse = TemplateVersionsResponse' {}
- newTemplateVersionsResponse :: TemplateVersionsResponse
- templateVersionsResponse_message :: Lens' TemplateVersionsResponse (Maybe Text)
- templateVersionsResponse_nextToken :: Lens' TemplateVersionsResponse (Maybe Text)
- templateVersionsResponse_requestID :: Lens' TemplateVersionsResponse (Maybe Text)
- templateVersionsResponse_item :: Lens' TemplateVersionsResponse [TemplateVersionResponse]
- data TemplatesResponse = TemplatesResponse' {
- nextToken :: Maybe Text
- item :: [TemplateResponse]
- newTemplatesResponse :: TemplatesResponse
- templatesResponse_nextToken :: Lens' TemplatesResponse (Maybe Text)
- templatesResponse_item :: Lens' TemplatesResponse [TemplateResponse]
- data TreatmentResource = TreatmentResource' {
- customDeliveryConfiguration :: Maybe CustomDeliveryConfiguration
- messageConfiguration :: Maybe MessageConfiguration
- schedule :: Maybe Schedule
- state :: Maybe CampaignState
- templateConfiguration :: Maybe TemplateConfiguration
- treatmentDescription :: Maybe Text
- treatmentName :: Maybe Text
- id :: Text
- sizePercent :: Int
- newTreatmentResource :: Text -> Int -> TreatmentResource
- treatmentResource_customDeliveryConfiguration :: Lens' TreatmentResource (Maybe CustomDeliveryConfiguration)
- treatmentResource_messageConfiguration :: Lens' TreatmentResource (Maybe MessageConfiguration)
- treatmentResource_schedule :: Lens' TreatmentResource (Maybe Schedule)
- treatmentResource_state :: Lens' TreatmentResource (Maybe CampaignState)
- treatmentResource_templateConfiguration :: Lens' TreatmentResource (Maybe TemplateConfiguration)
- treatmentResource_treatmentDescription :: Lens' TreatmentResource (Maybe Text)
- treatmentResource_treatmentName :: Lens' TreatmentResource (Maybe Text)
- treatmentResource_id :: Lens' TreatmentResource Text
- treatmentResource_sizePercent :: Lens' TreatmentResource Int
- data UpdateAttributesRequest = UpdateAttributesRequest' {}
- newUpdateAttributesRequest :: UpdateAttributesRequest
- updateAttributesRequest_blacklist :: Lens' UpdateAttributesRequest (Maybe [Text])
- data UpdateRecommenderConfiguration = UpdateRecommenderConfiguration' {
- attributes :: Maybe (HashMap Text Text)
- description :: Maybe Text
- name :: Maybe Text
- recommendationProviderIdType :: Maybe Text
- recommendationTransformerUri :: Maybe Text
- recommendationsDisplayName :: Maybe Text
- recommendationsPerMessage :: Maybe Int
- recommendationProviderUri :: Text
- recommendationProviderRoleArn :: Text
- newUpdateRecommenderConfiguration :: Text -> Text -> UpdateRecommenderConfiguration
- updateRecommenderConfiguration_attributes :: Lens' UpdateRecommenderConfiguration (Maybe (HashMap Text Text))
- updateRecommenderConfiguration_description :: Lens' UpdateRecommenderConfiguration (Maybe Text)
- updateRecommenderConfiguration_name :: Lens' UpdateRecommenderConfiguration (Maybe Text)
- updateRecommenderConfiguration_recommendationProviderIdType :: Lens' UpdateRecommenderConfiguration (Maybe Text)
- updateRecommenderConfiguration_recommendationTransformerUri :: Lens' UpdateRecommenderConfiguration (Maybe Text)
- updateRecommenderConfiguration_recommendationsDisplayName :: Lens' UpdateRecommenderConfiguration (Maybe Text)
- updateRecommenderConfiguration_recommendationsPerMessage :: Lens' UpdateRecommenderConfiguration (Maybe Int)
- updateRecommenderConfiguration_recommendationProviderUri :: Lens' UpdateRecommenderConfiguration Text
- updateRecommenderConfiguration_recommendationProviderRoleArn :: Lens' UpdateRecommenderConfiguration Text
- data VerificationResponse = VerificationResponse' {}
- newVerificationResponse :: VerificationResponse
- verificationResponse_valid :: Lens' VerificationResponse (Maybe Bool)
- data VerifyOTPMessageRequestParameters = VerifyOTPMessageRequestParameters' {
- referenceId :: Text
- otp :: Text
- destinationIdentity :: Text
- newVerifyOTPMessageRequestParameters :: Text -> Text -> Text -> VerifyOTPMessageRequestParameters
- verifyOTPMessageRequestParameters_referenceId :: Lens' VerifyOTPMessageRequestParameters Text
- verifyOTPMessageRequestParameters_otp :: Lens' VerifyOTPMessageRequestParameters Text
- verifyOTPMessageRequestParameters_destinationIdentity :: Lens' VerifyOTPMessageRequestParameters Text
- data VoiceChannelRequest = VoiceChannelRequest' {}
- newVoiceChannelRequest :: VoiceChannelRequest
- voiceChannelRequest_enabled :: Lens' VoiceChannelRequest (Maybe Bool)
- data VoiceChannelResponse = VoiceChannelResponse' {
- applicationId :: Maybe Text
- creationDate :: Maybe Text
- enabled :: Maybe Bool
- hasCredential :: Maybe Bool
- id :: Maybe Text
- isArchived :: Maybe Bool
- lastModifiedBy :: Maybe Text
- lastModifiedDate :: Maybe Text
- version :: Maybe Int
- platform :: Text
- newVoiceChannelResponse :: Text -> VoiceChannelResponse
- voiceChannelResponse_applicationId :: Lens' VoiceChannelResponse (Maybe Text)
- voiceChannelResponse_creationDate :: Lens' VoiceChannelResponse (Maybe Text)
- voiceChannelResponse_enabled :: Lens' VoiceChannelResponse (Maybe Bool)
- voiceChannelResponse_hasCredential :: Lens' VoiceChannelResponse (Maybe Bool)
- voiceChannelResponse_id :: Lens' VoiceChannelResponse (Maybe Text)
- voiceChannelResponse_isArchived :: Lens' VoiceChannelResponse (Maybe Bool)
- voiceChannelResponse_lastModifiedBy :: Lens' VoiceChannelResponse (Maybe Text)
- voiceChannelResponse_lastModifiedDate :: Lens' VoiceChannelResponse (Maybe Text)
- voiceChannelResponse_version :: Lens' VoiceChannelResponse (Maybe Int)
- voiceChannelResponse_platform :: Lens' VoiceChannelResponse Text
- data VoiceMessage = VoiceMessage' {}
- newVoiceMessage :: VoiceMessage
- voiceMessage_body :: Lens' VoiceMessage (Maybe Text)
- voiceMessage_languageCode :: Lens' VoiceMessage (Maybe Text)
- voiceMessage_originationNumber :: Lens' VoiceMessage (Maybe Text)
- voiceMessage_substitutions :: Lens' VoiceMessage (Maybe (HashMap Text [Text]))
- voiceMessage_voiceId :: Lens' VoiceMessage (Maybe Text)
- data VoiceTemplateRequest = VoiceTemplateRequest' {}
- newVoiceTemplateRequest :: VoiceTemplateRequest
- voiceTemplateRequest_body :: Lens' VoiceTemplateRequest (Maybe Text)
- voiceTemplateRequest_defaultSubstitutions :: Lens' VoiceTemplateRequest (Maybe Text)
- voiceTemplateRequest_languageCode :: Lens' VoiceTemplateRequest (Maybe Text)
- voiceTemplateRequest_templateDescription :: Lens' VoiceTemplateRequest (Maybe Text)
- voiceTemplateRequest_voiceId :: Lens' VoiceTemplateRequest (Maybe Text)
- voiceTemplateRequest_tags :: Lens' VoiceTemplateRequest (Maybe (HashMap Text Text))
- data VoiceTemplateResponse = VoiceTemplateResponse' {
- arn :: Maybe Text
- body :: Maybe Text
- defaultSubstitutions :: Maybe Text
- languageCode :: Maybe Text
- templateDescription :: Maybe Text
- version :: Maybe Text
- voiceId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- lastModifiedDate :: Text
- creationDate :: Text
- templateName :: Text
- templateType :: TemplateType
- newVoiceTemplateResponse :: Text -> Text -> Text -> TemplateType -> VoiceTemplateResponse
- voiceTemplateResponse_arn :: Lens' VoiceTemplateResponse (Maybe Text)
- voiceTemplateResponse_body :: Lens' VoiceTemplateResponse (Maybe Text)
- voiceTemplateResponse_defaultSubstitutions :: Lens' VoiceTemplateResponse (Maybe Text)
- voiceTemplateResponse_languageCode :: Lens' VoiceTemplateResponse (Maybe Text)
- voiceTemplateResponse_templateDescription :: Lens' VoiceTemplateResponse (Maybe Text)
- voiceTemplateResponse_version :: Lens' VoiceTemplateResponse (Maybe Text)
- voiceTemplateResponse_voiceId :: Lens' VoiceTemplateResponse (Maybe Text)
- voiceTemplateResponse_tags :: Lens' VoiceTemplateResponse (Maybe (HashMap Text Text))
- voiceTemplateResponse_lastModifiedDate :: Lens' VoiceTemplateResponse Text
- voiceTemplateResponse_creationDate :: Lens' VoiceTemplateResponse Text
- voiceTemplateResponse_templateName :: Lens' VoiceTemplateResponse Text
- voiceTemplateResponse_templateType :: Lens' VoiceTemplateResponse TemplateType
- data WaitActivity = WaitActivity' {}
- newWaitActivity :: WaitActivity
- waitActivity_nextActivity :: Lens' WaitActivity (Maybe Text)
- waitActivity_waitTime :: Lens' WaitActivity (Maybe WaitTime)
- data WaitTime = WaitTime' {}
- newWaitTime :: WaitTime
- waitTime_waitFor :: Lens' WaitTime (Maybe Text)
- waitTime_waitUntil :: Lens' WaitTime (Maybe Text)
- data WriteApplicationSettingsRequest = WriteApplicationSettingsRequest' {}
- newWriteApplicationSettingsRequest :: WriteApplicationSettingsRequest
- writeApplicationSettingsRequest_campaignHook :: Lens' WriteApplicationSettingsRequest (Maybe CampaignHook)
- writeApplicationSettingsRequest_cloudWatchMetricsEnabled :: Lens' WriteApplicationSettingsRequest (Maybe Bool)
- writeApplicationSettingsRequest_eventTaggingEnabled :: Lens' WriteApplicationSettingsRequest (Maybe Bool)
- writeApplicationSettingsRequest_limits :: Lens' WriteApplicationSettingsRequest (Maybe CampaignLimits)
- writeApplicationSettingsRequest_quietTime :: Lens' WriteApplicationSettingsRequest (Maybe QuietTime)
- data WriteCampaignRequest = WriteCampaignRequest' {
- additionalTreatments :: Maybe [WriteTreatmentResource]
- customDeliveryConfiguration :: Maybe CustomDeliveryConfiguration
- description :: Maybe Text
- holdoutPercent :: Maybe Int
- hook :: Maybe CampaignHook
- isPaused :: Maybe Bool
- limits :: Maybe CampaignLimits
- messageConfiguration :: Maybe MessageConfiguration
- name :: Maybe Text
- priority :: Maybe Int
- schedule :: Maybe Schedule
- segmentId :: Maybe Text
- segmentVersion :: Maybe Int
- templateConfiguration :: Maybe TemplateConfiguration
- treatmentDescription :: Maybe Text
- treatmentName :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- newWriteCampaignRequest :: WriteCampaignRequest
- writeCampaignRequest_additionalTreatments :: Lens' WriteCampaignRequest (Maybe [WriteTreatmentResource])
- writeCampaignRequest_customDeliveryConfiguration :: Lens' WriteCampaignRequest (Maybe CustomDeliveryConfiguration)
- writeCampaignRequest_description :: Lens' WriteCampaignRequest (Maybe Text)
- writeCampaignRequest_holdoutPercent :: Lens' WriteCampaignRequest (Maybe Int)
- writeCampaignRequest_hook :: Lens' WriteCampaignRequest (Maybe CampaignHook)
- writeCampaignRequest_isPaused :: Lens' WriteCampaignRequest (Maybe Bool)
- writeCampaignRequest_limits :: Lens' WriteCampaignRequest (Maybe CampaignLimits)
- writeCampaignRequest_messageConfiguration :: Lens' WriteCampaignRequest (Maybe MessageConfiguration)
- writeCampaignRequest_name :: Lens' WriteCampaignRequest (Maybe Text)
- writeCampaignRequest_priority :: Lens' WriteCampaignRequest (Maybe Int)
- writeCampaignRequest_schedule :: Lens' WriteCampaignRequest (Maybe Schedule)
- writeCampaignRequest_segmentId :: Lens' WriteCampaignRequest (Maybe Text)
- writeCampaignRequest_segmentVersion :: Lens' WriteCampaignRequest (Maybe Int)
- writeCampaignRequest_templateConfiguration :: Lens' WriteCampaignRequest (Maybe TemplateConfiguration)
- writeCampaignRequest_treatmentDescription :: Lens' WriteCampaignRequest (Maybe Text)
- writeCampaignRequest_treatmentName :: Lens' WriteCampaignRequest (Maybe Text)
- writeCampaignRequest_tags :: Lens' WriteCampaignRequest (Maybe (HashMap Text Text))
- data WriteEventStream = WriteEventStream' {}
- newWriteEventStream :: Text -> Text -> WriteEventStream
- writeEventStream_roleArn :: Lens' WriteEventStream Text
- writeEventStream_destinationStreamArn :: Lens' WriteEventStream Text
- data WriteJourneyRequest = WriteJourneyRequest' {
- activities :: Maybe (HashMap Text Activity)
- closedDays :: Maybe ClosedDays
- creationDate :: Maybe Text
- journeyChannelSettings :: Maybe JourneyChannelSettings
- lastModifiedDate :: Maybe Text
- limits :: Maybe JourneyLimits
- localTime :: Maybe Bool
- openHours :: Maybe OpenHours
- quietTime :: Maybe QuietTime
- refreshFrequency :: Maybe Text
- refreshOnSegmentUpdate :: Maybe Bool
- schedule :: Maybe JourneySchedule
- sendingSchedule :: Maybe Bool
- startActivity :: Maybe Text
- startCondition :: Maybe StartCondition
- state :: Maybe State
- waitForQuietTime :: Maybe Bool
- name :: Text
- newWriteJourneyRequest :: Text -> WriteJourneyRequest
- writeJourneyRequest_activities :: Lens' WriteJourneyRequest (Maybe (HashMap Text Activity))
- writeJourneyRequest_closedDays :: Lens' WriteJourneyRequest (Maybe ClosedDays)
- writeJourneyRequest_creationDate :: Lens' WriteJourneyRequest (Maybe Text)
- writeJourneyRequest_journeyChannelSettings :: Lens' WriteJourneyRequest (Maybe JourneyChannelSettings)
- writeJourneyRequest_lastModifiedDate :: Lens' WriteJourneyRequest (Maybe Text)
- writeJourneyRequest_limits :: Lens' WriteJourneyRequest (Maybe JourneyLimits)
- writeJourneyRequest_localTime :: Lens' WriteJourneyRequest (Maybe Bool)
- writeJourneyRequest_openHours :: Lens' WriteJourneyRequest (Maybe OpenHours)
- writeJourneyRequest_quietTime :: Lens' WriteJourneyRequest (Maybe QuietTime)
- writeJourneyRequest_refreshFrequency :: Lens' WriteJourneyRequest (Maybe Text)
- writeJourneyRequest_refreshOnSegmentUpdate :: Lens' WriteJourneyRequest (Maybe Bool)
- writeJourneyRequest_schedule :: Lens' WriteJourneyRequest (Maybe JourneySchedule)
- writeJourneyRequest_sendingSchedule :: Lens' WriteJourneyRequest (Maybe Bool)
- writeJourneyRequest_startActivity :: Lens' WriteJourneyRequest (Maybe Text)
- writeJourneyRequest_startCondition :: Lens' WriteJourneyRequest (Maybe StartCondition)
- writeJourneyRequest_state :: Lens' WriteJourneyRequest (Maybe State)
- writeJourneyRequest_waitForQuietTime :: Lens' WriteJourneyRequest (Maybe Bool)
- writeJourneyRequest_name :: Lens' WriteJourneyRequest Text
- data WriteSegmentRequest = WriteSegmentRequest' {}
- newWriteSegmentRequest :: WriteSegmentRequest
- writeSegmentRequest_dimensions :: Lens' WriteSegmentRequest (Maybe SegmentDimensions)
- writeSegmentRequest_name :: Lens' WriteSegmentRequest (Maybe Text)
- writeSegmentRequest_segmentGroups :: Lens' WriteSegmentRequest (Maybe SegmentGroupList)
- writeSegmentRequest_tags :: Lens' WriteSegmentRequest (Maybe (HashMap Text Text))
- data WriteTreatmentResource = WriteTreatmentResource' {}
- newWriteTreatmentResource :: Int -> WriteTreatmentResource
- writeTreatmentResource_customDeliveryConfiguration :: Lens' WriteTreatmentResource (Maybe CustomDeliveryConfiguration)
- writeTreatmentResource_messageConfiguration :: Lens' WriteTreatmentResource (Maybe MessageConfiguration)
- writeTreatmentResource_schedule :: Lens' WriteTreatmentResource (Maybe Schedule)
- writeTreatmentResource_templateConfiguration :: Lens' WriteTreatmentResource (Maybe TemplateConfiguration)
- writeTreatmentResource_treatmentDescription :: Lens' WriteTreatmentResource (Maybe Text)
- writeTreatmentResource_treatmentName :: Lens' WriteTreatmentResource (Maybe Text)
- writeTreatmentResource_sizePercent :: Lens' WriteTreatmentResource Int
Service Configuration
defaultService :: Service Source #
API version 2016-12-01 of the Amazon Pinpoint SDK configuration.
Errors
_BadRequestException :: AsError a => Fold a ServiceError Source #
Provides information about an API request or response.
_ConflictException :: AsError a => Fold a ServiceError Source #
Provides information about an API request or response.
_ForbiddenException :: AsError a => Fold a ServiceError Source #
Provides information about an API request or response.
_InternalServerErrorException :: AsError a => Fold a ServiceError Source #
Provides information about an API request or response.
_MethodNotAllowedException :: AsError a => Fold a ServiceError Source #
Provides information about an API request or response.
_NotFoundException :: AsError a => Fold a ServiceError Source #
Provides information about an API request or response.
_PayloadTooLargeException :: AsError a => Fold a ServiceError Source #
Provides information about an API request or response.
_TooManyRequestsException :: AsError a => Fold a ServiceError Source #
Provides information about an API request or response.
Action
Constructors
| Action' | |
Fields
| |
Bundled Patterns
| pattern Action_DEEP_LINK :: Action | |
| pattern Action_OPEN_APP :: Action | |
| pattern Action_URL :: Action |
Instances
Alignment
Constructors
| Alignment' | |
Fields | |
Bundled Patterns
| pattern Alignment_CENTER :: Alignment | |
| pattern Alignment_LEFT :: Alignment | |
| pattern Alignment_RIGHT :: Alignment |
Instances
AttributeType
newtype AttributeType Source #
Constructors
| AttributeType' | |
Fields | |
Bundled Patterns
| pattern AttributeType_AFTER :: AttributeType | |
| pattern AttributeType_BEFORE :: AttributeType | |
| pattern AttributeType_BETWEEN :: AttributeType | |
| pattern AttributeType_CONTAINS :: AttributeType | |
| pattern AttributeType_EXCLUSIVE :: AttributeType | |
| pattern AttributeType_INCLUSIVE :: AttributeType | |
| pattern AttributeType_ON :: AttributeType |
Instances
ButtonAction
newtype ButtonAction Source #
Constructors
| ButtonAction' | |
Fields | |
Bundled Patterns
| pattern ButtonAction_CLOSE :: ButtonAction | |
| pattern ButtonAction_DEEP_LINK :: ButtonAction | |
| pattern ButtonAction_LINK :: ButtonAction |
Instances
CampaignStatus
newtype CampaignStatus Source #
Constructors
| CampaignStatus' | |
Fields | |
Bundled Patterns
| pattern CampaignStatus_COMPLETED :: CampaignStatus | |
| pattern CampaignStatus_DELETED :: CampaignStatus | |
| pattern CampaignStatus_EXECUTING :: CampaignStatus | |
| pattern CampaignStatus_INVALID :: CampaignStatus | |
| pattern CampaignStatus_PAUSED :: CampaignStatus | |
| pattern CampaignStatus_PENDING_NEXT_RUN :: CampaignStatus | |
| pattern CampaignStatus_SCHEDULED :: CampaignStatus |
Instances
ChannelType
newtype ChannelType Source #
Constructors
| ChannelType' | |
Fields | |
Bundled Patterns
| pattern ChannelType_ADM :: ChannelType | |
| pattern ChannelType_APNS :: ChannelType | |
| pattern ChannelType_APNS_SANDBOX :: ChannelType | |
| pattern ChannelType_APNS_VOIP :: ChannelType | |
| pattern ChannelType_APNS_VOIP_SANDBOX :: ChannelType | |
| pattern ChannelType_BAIDU :: ChannelType | |
| pattern ChannelType_CUSTOM :: ChannelType | |
| pattern ChannelType_EMAIL :: ChannelType | |
| pattern ChannelType_GCM :: ChannelType | |
| pattern ChannelType_IN_APP :: ChannelType | |
| pattern ChannelType_PUSH :: ChannelType | |
| pattern ChannelType_SMS :: ChannelType | |
| pattern ChannelType_VOICE :: ChannelType |
Instances
DayOfWeek
Constructors
| DayOfWeek' | |
Fields | |
Bundled Patterns
| pattern DayOfWeek_FRIDAY :: DayOfWeek | |
| pattern DayOfWeek_MONDAY :: DayOfWeek | |
| pattern DayOfWeek_SATURDAY :: DayOfWeek | |
| pattern DayOfWeek_SUNDAY :: DayOfWeek | |
| pattern DayOfWeek_THURSDAY :: DayOfWeek | |
| pattern DayOfWeek_TUESDAY :: DayOfWeek | |
| pattern DayOfWeek_WEDNESDAY :: DayOfWeek |
Instances
DefinitionFormat
newtype DefinitionFormat Source #
Constructors
| DefinitionFormat' | |
Fields | |
Bundled Patterns
| pattern DefinitionFormat_CSV :: DefinitionFormat | |
| pattern DefinitionFormat_JSON :: DefinitionFormat |
Instances
DeliveryStatus
newtype DeliveryStatus Source #
Constructors
| DeliveryStatus' | |
Fields | |
Bundled Patterns
| pattern DeliveryStatus_DUPLICATE :: DeliveryStatus | |
| pattern DeliveryStatus_OPT_OUT :: DeliveryStatus | |
| pattern DeliveryStatus_PERMANENT_FAILURE :: DeliveryStatus | |
| pattern DeliveryStatus_SUCCESSFUL :: DeliveryStatus | |
| pattern DeliveryStatus_TEMPORARY_FAILURE :: DeliveryStatus | |
| pattern DeliveryStatus_THROTTLED :: DeliveryStatus | |
| pattern DeliveryStatus_UNKNOWN_FAILURE :: DeliveryStatus |
Instances
DimensionType
newtype DimensionType Source #
Constructors
| DimensionType' | |
Fields | |
Bundled Patterns
| pattern DimensionType_EXCLUSIVE :: DimensionType | |
| pattern DimensionType_INCLUSIVE :: DimensionType |
Instances
Duration
Constructors
| Duration' | |
Fields
| |
Bundled Patterns
| pattern Duration_DAY_14 :: Duration | |
| pattern Duration_DAY_30 :: Duration | |
| pattern Duration_DAY_7 :: Duration | |
| pattern Duration_HR_24 :: Duration |
Instances
EndpointTypesElement
newtype EndpointTypesElement Source #
Constructors
| EndpointTypesElement' | |
Fields | |
Bundled Patterns
| pattern EndpointTypesElement_ADM :: EndpointTypesElement | |
| pattern EndpointTypesElement_APNS :: EndpointTypesElement | |
| pattern EndpointTypesElement_APNS_SANDBOX :: EndpointTypesElement | |
| pattern EndpointTypesElement_APNS_VOIP :: EndpointTypesElement | |
| pattern EndpointTypesElement_APNS_VOIP_SANDBOX :: EndpointTypesElement | |
| pattern EndpointTypesElement_BAIDU :: EndpointTypesElement | |
| pattern EndpointTypesElement_CUSTOM :: EndpointTypesElement | |
| pattern EndpointTypesElement_EMAIL :: EndpointTypesElement | |
| pattern EndpointTypesElement_GCM :: EndpointTypesElement | |
| pattern EndpointTypesElement_IN_APP :: EndpointTypesElement | |
| pattern EndpointTypesElement_PUSH :: EndpointTypesElement | |
| pattern EndpointTypesElement_SMS :: EndpointTypesElement | |
| pattern EndpointTypesElement_VOICE :: EndpointTypesElement |
Instances
FilterType
newtype FilterType Source #
Constructors
| FilterType' | |
Fields | |
Bundled Patterns
| pattern FilterType_ENDPOINT :: FilterType | |
| pattern FilterType_SYSTEM :: FilterType |
Instances
Frequency
Constructors
| Frequency' | |
Fields | |
Bundled Patterns
| pattern Frequency_DAILY :: Frequency | |
| pattern Frequency_EVENT :: Frequency | |
| pattern Frequency_HOURLY :: Frequency | |
| pattern Frequency_IN_APP_EVENT :: Frequency | |
| pattern Frequency_MONTHLY :: Frequency | |
| pattern Frequency_ONCE :: Frequency | |
| pattern Frequency_WEEKLY :: Frequency |
Instances
Include
Constructors
| Include' | |
Fields
| |
Bundled Patterns
| pattern Include_ALL :: Include | |
| pattern Include_ANY :: Include | |
| pattern Include_NONE :: Include |
Instances
JobStatus
Constructors
| JobStatus' | |
Fields | |
Bundled Patterns
| pattern JobStatus_COMPLETED :: JobStatus | |
| pattern JobStatus_COMPLETING :: JobStatus | |
| pattern JobStatus_CREATED :: JobStatus | |
| pattern JobStatus_FAILED :: JobStatus | |
| pattern JobStatus_FAILING :: JobStatus | |
| pattern JobStatus_INITIALIZING :: JobStatus | |
| pattern JobStatus_PENDING_JOB :: JobStatus | |
| pattern JobStatus_PREPARING_FOR_INITIALIZATION :: JobStatus | |
| pattern JobStatus_PROCESSING :: JobStatus |
Instances
Layout
Constructors
| Layout' | |
Fields
| |
Bundled Patterns
| pattern Layout_BOTTOM_BANNER :: Layout | |
| pattern Layout_CAROUSEL :: Layout | |
| pattern Layout_MIDDLE_BANNER :: Layout | |
| pattern Layout_MOBILE_FEED :: Layout | |
| pattern Layout_OVERLAYS :: Layout | |
| pattern Layout_TOP_BANNER :: Layout |
Instances
MessageType
newtype MessageType Source #
Constructors
| MessageType' | |
Fields | |
Bundled Patterns
| pattern MessageType_PROMOTIONAL :: MessageType | |
| pattern MessageType_TRANSACTIONAL :: MessageType |
Instances
Mode
Bundled Patterns
| pattern Mode_DELIVERY :: Mode | |
| pattern Mode_FILTER :: Mode |
Instances
Operator
Constructors
| Operator' | |
Fields
| |
Bundled Patterns
| pattern Operator_ALL :: Operator | |
| pattern Operator_ANY :: Operator |
Instances
RecencyType
newtype RecencyType Source #
Constructors
| RecencyType' | |
Fields | |
Bundled Patterns
| pattern RecencyType_ACTIVE :: RecencyType | |
| pattern RecencyType_INACTIVE :: RecencyType |
Instances
SegmentType
newtype SegmentType Source #
Constructors
| SegmentType' | |
Fields | |
Bundled Patterns
| pattern SegmentType_DIMENSIONAL :: SegmentType | |
| pattern SegmentType_IMPORT :: SegmentType |
Instances
SourceType
newtype SourceType Source #
Constructors
| SourceType' | |
Fields | |
Bundled Patterns
| pattern SourceType_ALL :: SourceType | |
| pattern SourceType_ANY :: SourceType | |
| pattern SourceType_NONE :: SourceType |
Instances
State
Bundled Patterns
| pattern State_ACTIVE :: State | |
| pattern State_CANCELLED :: State | |
| pattern State_CLOSED :: State | |
| pattern State_COMPLETED :: State | |
| pattern State_DRAFT :: State | |
| pattern State_PAUSED :: State |
Instances
TemplateType
newtype TemplateType Source #
Constructors
| TemplateType' | |
Fields | |
Bundled Patterns
| pattern TemplateType_EMAIL :: TemplateType | |
| pattern TemplateType_INAPP :: TemplateType | |
| pattern TemplateType_PUSH :: TemplateType | |
| pattern TemplateType_SMS :: TemplateType | |
| pattern TemplateType_VOICE :: TemplateType |
Instances
Type
Instances
ADMChannelRequest
data ADMChannelRequest Source #
Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.
See: newADMChannelRequest smart constructor.
Constructors
| ADMChannelRequest' | |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ADMChannelRequest |
Create a value of ADMChannelRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:ADMChannelRequest', aDMChannelRequest_enabled - Specifies whether to enable the ADM channel for the application.
$sel:clientSecret:ADMChannelRequest', aDMChannelRequest_clientSecret - The Client Secret that you received from Amazon to send messages by
using ADM.
$sel:clientId:ADMChannelRequest', aDMChannelRequest_clientId - The Client ID that you received from Amazon to send messages by using
ADM.
aDMChannelRequest_enabled :: Lens' ADMChannelRequest (Maybe Bool) Source #
Specifies whether to enable the ADM channel for the application.
aDMChannelRequest_clientSecret :: Lens' ADMChannelRequest Text Source #
The Client Secret that you received from Amazon to send messages by using ADM.
aDMChannelRequest_clientId :: Lens' ADMChannelRequest Text Source #
The Client ID that you received from Amazon to send messages by using ADM.
ADMChannelResponse
data ADMChannelResponse Source #
Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.
See: newADMChannelResponse smart constructor.
Constructors
| ADMChannelResponse' | |
Fields
| |
Instances
newADMChannelResponse Source #
Arguments
| :: Text | |
| -> ADMChannelResponse |
Create a value of ADMChannelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:ADMChannelResponse', aDMChannelResponse_applicationId - The unique identifier for the application that the ADM channel applies
to.
$sel:creationDate:ADMChannelResponse', aDMChannelResponse_creationDate - The date and time when the ADM channel was enabled.
$sel:enabled:ADMChannelResponse', aDMChannelResponse_enabled - Specifies whether the ADM channel is enabled for the application.
$sel:hasCredential:ADMChannelResponse', aDMChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.
$sel:id:ADMChannelResponse', aDMChannelResponse_id - (Deprecated) An identifier for the ADM channel. This property is
retained only for backward compatibility.
$sel:isArchived:ADMChannelResponse', aDMChannelResponse_isArchived - Specifies whether the ADM channel is archived.
$sel:lastModifiedBy:ADMChannelResponse', aDMChannelResponse_lastModifiedBy - The user who last modified the ADM channel.
$sel:lastModifiedDate:ADMChannelResponse', aDMChannelResponse_lastModifiedDate - The date and time when the ADM channel was last modified.
$sel:version:ADMChannelResponse', aDMChannelResponse_version - The current version of the ADM channel.
$sel:platform:ADMChannelResponse', aDMChannelResponse_platform - The type of messaging or notification platform for the channel. For the
ADM channel, this value is ADM.
aDMChannelResponse_applicationId :: Lens' ADMChannelResponse (Maybe Text) Source #
The unique identifier for the application that the ADM channel applies to.
aDMChannelResponse_creationDate :: Lens' ADMChannelResponse (Maybe Text) Source #
The date and time when the ADM channel was enabled.
aDMChannelResponse_enabled :: Lens' ADMChannelResponse (Maybe Bool) Source #
Specifies whether the ADM channel is enabled for the application.
aDMChannelResponse_hasCredential :: Lens' ADMChannelResponse (Maybe Bool) Source #
(Not used) This property is retained only for backward compatibility.
aDMChannelResponse_id :: Lens' ADMChannelResponse (Maybe Text) Source #
(Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.
aDMChannelResponse_isArchived :: Lens' ADMChannelResponse (Maybe Bool) Source #
Specifies whether the ADM channel is archived.
aDMChannelResponse_lastModifiedBy :: Lens' ADMChannelResponse (Maybe Text) Source #
The user who last modified the ADM channel.
aDMChannelResponse_lastModifiedDate :: Lens' ADMChannelResponse (Maybe Text) Source #
The date and time when the ADM channel was last modified.
aDMChannelResponse_version :: Lens' ADMChannelResponse (Maybe Int) Source #
The current version of the ADM channel.
aDMChannelResponse_platform :: Lens' ADMChannelResponse Text Source #
The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.
ADMMessage
data ADMMessage Source #
Specifies the settings for a one-time message that's sent directly to an endpoint through the ADM (Amazon Device Messaging) channel.
See: newADMMessage smart constructor.
Constructors
| ADMMessage' | |
Fields
| |
Instances
newADMMessage :: ADMMessage Source #
Create a value of ADMMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:ADMMessage', aDMMessage_action - The action to occur if the recipient taps the push notification. Valid
values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
$sel:body:ADMMessage', aDMMessage_body - The body of the notification message.
$sel:consolidationKey:ADMMessage', aDMMessage_consolidationKey - An arbitrary string that indicates that multiple messages are logically
the same and that Amazon Device Messaging (ADM) can drop previously
enqueued messages in favor of this message.
$sel:data':ADMMessage', aDMMessage_data - The JSON data payload to use for the push notification, if the
notification is a silent push notification. This payload is added to the
data.pinpoint.jsonBody object of the notification.
$sel:expiresAfter:ADMMessage', aDMMessage_expiresAfter - The amount of time, in seconds, that ADM should store the message if the
recipient's device is offline. Amazon Pinpoint specifies this value in
the expiresAfter parameter when it sends the notification message to
ADM.
$sel:iconReference:ADMMessage', aDMMessage_iconReference - The icon image name of the asset saved in your app.
$sel:imageIconUrl:ADMMessage', aDMMessage_imageIconUrl - The URL of the large icon image to display in the content view of the
push notification.
$sel:imageUrl:ADMMessage', aDMMessage_imageUrl - The URL of an image to display in the push notification.
$sel:md5:ADMMessage', aDMMessage_md5 - The base64-encoded, MD5 checksum of the value specified by the Data
property. ADM uses the MD5 value to verify the integrity of the data.
$sel:rawContent:ADMMessage', aDMMessage_rawContent - The raw, JSON-formatted string to use as the payload for the
notification message. If specified, this value overrides all other
content for the message.
$sel:silentPush:ADMMessage', aDMMessage_silentPush - Specifies whether the notification is a silent push notification, which
is a push notification that doesn't display on a recipient's device.
Silent push notifications can be used for cases such as updating an
app's configuration or supporting phone home functionality.
$sel:smallImageIconUrl:ADMMessage', aDMMessage_smallImageIconUrl - The URL of the small icon image to display in the status bar and the
content view of the push notification.
$sel:sound:ADMMessage', aDMMessage_sound - The sound to play when the recipient receives the push notification. You
can use the default stream or specify the file name of a sound resource
that's bundled in your app. On an Android platform, the sound file must
reside in /res/raw/.
$sel:substitutions:ADMMessage', aDMMessage_substitutions - The default message variables to use in the notification message. You
can override the default variables with individual address variables.
$sel:title:ADMMessage', aDMMessage_title - The title to display above the notification message on the recipient's
device.
$sel:url:ADMMessage', aDMMessage_url - The URL to open in the recipient's default mobile browser, if a
recipient taps the push notification and the value of the Action
property is URL.
aDMMessage_action :: Lens' ADMMessage (Maybe Action) Source #
The action to occur if the recipient taps the push notification. Valid values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
aDMMessage_body :: Lens' ADMMessage (Maybe Text) Source #
The body of the notification message.
aDMMessage_consolidationKey :: Lens' ADMMessage (Maybe Text) Source #
An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.
aDMMessage_data :: Lens' ADMMessage (Maybe (HashMap Text Text)) Source #
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
aDMMessage_expiresAfter :: Lens' ADMMessage (Maybe Text) Source #
The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.
aDMMessage_iconReference :: Lens' ADMMessage (Maybe Text) Source #
The icon image name of the asset saved in your app.
aDMMessage_imageIconUrl :: Lens' ADMMessage (Maybe Text) Source #
The URL of the large icon image to display in the content view of the push notification.
aDMMessage_imageUrl :: Lens' ADMMessage (Maybe Text) Source #
The URL of an image to display in the push notification.
aDMMessage_md5 :: Lens' ADMMessage (Maybe Text) Source #
The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.
aDMMessage_rawContent :: Lens' ADMMessage (Maybe Text) Source #
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
aDMMessage_silentPush :: Lens' ADMMessage (Maybe Bool) Source #
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
aDMMessage_smallImageIconUrl :: Lens' ADMMessage (Maybe Text) Source #
The URL of the small icon image to display in the status bar and the content view of the push notification.
aDMMessage_sound :: Lens' ADMMessage (Maybe Text) Source #
The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
aDMMessage_substitutions :: Lens' ADMMessage (Maybe (HashMap Text [Text])) Source #
The default message variables to use in the notification message. You can override the default variables with individual address variables.
aDMMessage_title :: Lens' ADMMessage (Maybe Text) Source #
The title to display above the notification message on the recipient's device.
aDMMessage_url :: Lens' ADMMessage (Maybe Text) Source #
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSChannelRequest
data APNSChannelRequest Source #
Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.
See: newAPNSChannelRequest smart constructor.
Constructors
| APNSChannelRequest' | |
Fields
| |
Instances
newAPNSChannelRequest :: APNSChannelRequest Source #
Create a value of APNSChannelRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bundleId:APNSChannelRequest', aPNSChannelRequest_bundleId - The bundle identifier that's assigned to your iOS app. This identifier
is used for APNs tokens.
$sel:certificate:APNSChannelRequest', aPNSChannelRequest_certificate - The APNs client certificate that you received from Apple, if you want
Amazon Pinpoint to communicate with APNs by using an APNs certificate.
$sel:defaultAuthenticationMethod:APNSChannelRequest', aPNSChannelRequest_defaultAuthenticationMethod - The default authentication method that you want Amazon Pinpoint to use
when authenticating with APNs, key or certificate.
$sel:enabled:APNSChannelRequest', aPNSChannelRequest_enabled - Specifies whether to enable the APNs channel for the application.
$sel:privateKey:APNSChannelRequest', aPNSChannelRequest_privateKey - The private key for the APNs client certificate that you want Amazon
Pinpoint to use to communicate with APNs.
$sel:teamId:APNSChannelRequest', aPNSChannelRequest_teamId - The identifier that's assigned to your Apple developer account team.
This identifier is used for APNs tokens.
$sel:tokenKey:APNSChannelRequest', aPNSChannelRequest_tokenKey - The authentication key to use for APNs tokens.
$sel:tokenKeyId:APNSChannelRequest', aPNSChannelRequest_tokenKeyId - The key identifier that's assigned to your APNs signing key, if you
want Amazon Pinpoint to communicate with APNs by using APNs tokens.
aPNSChannelRequest_bundleId :: Lens' APNSChannelRequest (Maybe Text) Source #
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
aPNSChannelRequest_certificate :: Lens' APNSChannelRequest (Maybe Text) Source #
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
aPNSChannelRequest_defaultAuthenticationMethod :: Lens' APNSChannelRequest (Maybe Text) Source #
The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
aPNSChannelRequest_enabled :: Lens' APNSChannelRequest (Maybe Bool) Source #
Specifies whether to enable the APNs channel for the application.
aPNSChannelRequest_privateKey :: Lens' APNSChannelRequest (Maybe Text) Source #
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
aPNSChannelRequest_teamId :: Lens' APNSChannelRequest (Maybe Text) Source #
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
aPNSChannelRequest_tokenKey :: Lens' APNSChannelRequest (Maybe Text) Source #
The authentication key to use for APNs tokens.
aPNSChannelRequest_tokenKeyId :: Lens' APNSChannelRequest (Maybe Text) Source #
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
APNSChannelResponse
data APNSChannelResponse Source #
Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.
See: newAPNSChannelResponse smart constructor.
Constructors
| APNSChannelResponse' | |
Fields
| |
Instances
newAPNSChannelResponse Source #
Arguments
| :: Text | |
| -> APNSChannelResponse |
Create a value of APNSChannelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:APNSChannelResponse', aPNSChannelResponse_applicationId - The unique identifier for the application that the APNs channel applies
to.
$sel:creationDate:APNSChannelResponse', aPNSChannelResponse_creationDate - The date and time when the APNs channel was enabled.
$sel:defaultAuthenticationMethod:APNSChannelResponse', aPNSChannelResponse_defaultAuthenticationMethod - The default authentication method that Amazon Pinpoint uses to
authenticate with APNs for this channel, key or certificate.
$sel:enabled:APNSChannelResponse', aPNSChannelResponse_enabled - Specifies whether the APNs channel is enabled for the application.
$sel:hasCredential:APNSChannelResponse', aPNSChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.
$sel:hasTokenKey:APNSChannelResponse', aPNSChannelResponse_hasTokenKey - Specifies whether the APNs channel is configured to communicate with
APNs by using APNs tokens. To provide an authentication key for APNs
tokens, set the TokenKey property of the channel.
$sel:id:APNSChannelResponse', aPNSChannelResponse_id - (Deprecated) An identifier for the APNs channel. This property is
retained only for backward compatibility.
$sel:isArchived:APNSChannelResponse', aPNSChannelResponse_isArchived - Specifies whether the APNs channel is archived.
$sel:lastModifiedBy:APNSChannelResponse', aPNSChannelResponse_lastModifiedBy - The user who last modified the APNs channel.
$sel:lastModifiedDate:APNSChannelResponse', aPNSChannelResponse_lastModifiedDate - The date and time when the APNs channel was last modified.
$sel:version:APNSChannelResponse', aPNSChannelResponse_version - The current version of the APNs channel.
$sel:platform:APNSChannelResponse', aPNSChannelResponse_platform - The type of messaging or notification platform for the channel. For the
APNs channel, this value is APNS.
aPNSChannelResponse_applicationId :: Lens' APNSChannelResponse (Maybe Text) Source #
The unique identifier for the application that the APNs channel applies to.
aPNSChannelResponse_creationDate :: Lens' APNSChannelResponse (Maybe Text) Source #
The date and time when the APNs channel was enabled.
aPNSChannelResponse_defaultAuthenticationMethod :: Lens' APNSChannelResponse (Maybe Text) Source #
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
aPNSChannelResponse_enabled :: Lens' APNSChannelResponse (Maybe Bool) Source #
Specifies whether the APNs channel is enabled for the application.
aPNSChannelResponse_hasCredential :: Lens' APNSChannelResponse (Maybe Bool) Source #
(Not used) This property is retained only for backward compatibility.
aPNSChannelResponse_hasTokenKey :: Lens' APNSChannelResponse (Maybe Bool) Source #
Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
aPNSChannelResponse_id :: Lens' APNSChannelResponse (Maybe Text) Source #
(Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.
aPNSChannelResponse_isArchived :: Lens' APNSChannelResponse (Maybe Bool) Source #
Specifies whether the APNs channel is archived.
aPNSChannelResponse_lastModifiedBy :: Lens' APNSChannelResponse (Maybe Text) Source #
The user who last modified the APNs channel.
aPNSChannelResponse_lastModifiedDate :: Lens' APNSChannelResponse (Maybe Text) Source #
The date and time when the APNs channel was last modified.
aPNSChannelResponse_version :: Lens' APNSChannelResponse (Maybe Int) Source #
The current version of the APNs channel.
aPNSChannelResponse_platform :: Lens' APNSChannelResponse Text Source #
The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.
APNSMessage
data APNSMessage Source #
Specifies the settings for a one-time message that's sent directly to an endpoint through the APNs (Apple Push Notification service) channel.
See: newAPNSMessage smart constructor.
Constructors
| APNSMessage' | |
Fields
| |
Instances
newAPNSMessage :: APNSMessage Source #
Create a value of APNSMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aPNSPushType:APNSMessage', aPNSMessage_aPNSPushType - The type of push notification to send. Valid values are:
- alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.
- background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.
- complication - For a notification that contains update information for an app’s complication timeline.
- fileprovider - For a notification that signals changes to a File Provider extension.
- mdm - For a notification that tells managed devices to contact the MDM server.
- voip - For a notification that provides information about an incoming VoIP call.
Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.
For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.
$sel:action:APNSMessage', aPNSMessage_action - The action to occur if the recipient taps the push notification. Valid
values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
$sel:badge:APNSMessage', aPNSMessage_badge - The key that indicates whether and how to modify the badge of your
app's icon when the recipient receives the push notification. If this
key isn't included in the dictionary, the badge doesn't change. To
remove the badge, set this value to 0.
$sel:body:APNSMessage', aPNSMessage_body - The body of the notification message.
$sel:category:APNSMessage', aPNSMessage_category - The key that indicates the notification type for the push notification.
This key is a value that's defined by the identifier property of one of
your app's registered categories.
$sel:collapseId:APNSMessage', aPNSMessage_collapseId - An arbitrary identifier that, if assigned to multiple messages, APNs
uses to coalesce the messages into a single push notification instead of
delivering each message individually. This value can't exceed 64 bytes.
Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.
$sel:data':APNSMessage', aPNSMessage_data - The JSON payload to use for a silent push notification. This payload is
added to the data.pinpoint.jsonBody object of the notification.
$sel:mediaUrl:APNSMessage', aPNSMessage_mediaUrl - The URL of an image or video to display in the push notification.
$sel:preferredAuthenticationMethod:APNSMessage', aPNSMessage_preferredAuthenticationMethod - The authentication method that you want Amazon Pinpoint to use when
authenticating with APNs, CERTIFICATE or TOKEN.
$sel:priority:APNSMessage', aPNSMessage_priority - para>5 - Low priority, the notification might be delayed, delivered as
part of a group, or throttled.
/listitem>
10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.
/para>
Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.
The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.
$sel:rawContent:APNSMessage', aPNSMessage_rawContent - The raw, JSON-formatted string to use as the payload for the
notification message. If specified, this value overrides all other
content for the message.
If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
$sel:silentPush:APNSMessage', aPNSMessage_silentPush - Specifies whether the notification is a silent push notification. A
silent (or background) push notification isn't displayed on
recipients' devices. You can use silent push notifications to make
small updates to your app, or to display messages in an in-app message
center.
Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background.
If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.
$sel:sound:APNSMessage', aPNSMessage_sound - The key for the sound to play when the recipient receives the push
notification. The value for this key is the name of a sound file in your
app's main bundle or the Library/Sounds folder in your app's data
container. If the sound file can't be found or you specify default for
the value, the system plays the default alert sound.
$sel:substitutions:APNSMessage', aPNSMessage_substitutions - The default message variables to use in the notification message. You
can override these default variables with individual address variables.
$sel:threadId:APNSMessage', aPNSMessage_threadId - The key that represents your app-specific identifier for grouping
notifications. If you provide a Notification Content app extension, you
can use this value to group your notifications together.
$sel:timeToLive:APNSMessage', aPNSMessage_timeToLive - The amount of time, in seconds, that APNs should store and attempt to
deliver the push notification, if the service is unable to deliver the
notification the first time. If this value is 0, APNs treats the
notification as if it expires immediately and the service doesn't store
or try to deliver the notification again.
Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.
$sel:title:APNSMessage', aPNSMessage_title - The title to display above the notification message on the recipient's
device.
$sel:url:APNSMessage', aPNSMessage_url - The URL to open in the recipient's default mobile browser, if a
recipient taps the push notification and the value of the Action
property is URL.
aPNSMessage_aPNSPushType :: Lens' APNSMessage (Maybe Text) Source #
The type of push notification to send. Valid values are:
- alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.
- background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.
- complication - For a notification that contains update information for an app’s complication timeline.
- fileprovider - For a notification that signals changes to a File Provider extension.
- mdm - For a notification that tells managed devices to contact the MDM server.
- voip - For a notification that provides information about an incoming VoIP call.
Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.
For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.
aPNSMessage_action :: Lens' APNSMessage (Maybe Action) Source #
The action to occur if the recipient taps the push notification. Valid values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
aPNSMessage_badge :: Lens' APNSMessage (Maybe Int) Source #
The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.
aPNSMessage_body :: Lens' APNSMessage (Maybe Text) Source #
The body of the notification message.
aPNSMessage_category :: Lens' APNSMessage (Maybe Text) Source #
The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.
aPNSMessage_collapseId :: Lens' APNSMessage (Maybe Text) Source #
An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.
Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.
aPNSMessage_data :: Lens' APNSMessage (Maybe (HashMap Text Text)) Source #
The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
aPNSMessage_mediaUrl :: Lens' APNSMessage (Maybe Text) Source #
The URL of an image or video to display in the push notification.
aPNSMessage_preferredAuthenticationMethod :: Lens' APNSMessage (Maybe Text) Source #
The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.
aPNSMessage_priority :: Lens' APNSMessage (Maybe Text) Source #
para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.
/listitem>
10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.
/para>
Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.
The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.
aPNSMessage_rawContent :: Lens' APNSMessage (Maybe Text) Source #
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
aPNSMessage_silentPush :: Lens' APNSMessage (Maybe Bool) Source #
Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center.
Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background.
If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.
aPNSMessage_sound :: Lens' APNSMessage (Maybe Text) Source #
The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
aPNSMessage_substitutions :: Lens' APNSMessage (Maybe (HashMap Text [Text])) Source #
The default message variables to use in the notification message. You can override these default variables with individual address variables.
aPNSMessage_threadId :: Lens' APNSMessage (Maybe Text) Source #
The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
aPNSMessage_timeToLive :: Lens' APNSMessage (Maybe Int) Source #
The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.
aPNSMessage_title :: Lens' APNSMessage (Maybe Text) Source #
The title to display above the notification message on the recipient's device.
aPNSMessage_url :: Lens' APNSMessage (Maybe Text) Source #
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
APNSPushNotificationTemplate
data APNSPushNotificationTemplate Source #
Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) channel.
See: newAPNSPushNotificationTemplate smart constructor.
Constructors
| APNSPushNotificationTemplate' | |
Fields
| |
Instances
newAPNSPushNotificationTemplate :: APNSPushNotificationTemplate Source #
Create a value of APNSPushNotificationTemplate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_action - The action to occur if a recipient taps a push notification that's
based on the message template. Valid values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
$sel:body:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_body - The message body to use in push notifications that are based on the
message template.
$sel:mediaUrl:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_mediaUrl - The URL of an image or video to display in push notifications that are
based on the message template.
$sel:rawContent:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_rawContent - The raw, JSON-formatted string to use as the payload for push
notifications that are based on the message template. If specified, this
value overrides all other content for the message template.
$sel:sound:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_sound - The key for the sound to play when the recipient receives a push
notification that's based on the message template. The value for this
key is the name of a sound file in your app's main bundle or the
Library/Sounds folder in your app's data container. If the sound file
can't be found or you specify default for the value, the system plays
the default alert sound.
$sel:title:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_title - The title to use in push notifications that are based on the message
template. This title appears above the notification message on a
recipient's device.
$sel:url:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_url - The URL to open in the recipient's default mobile browser, if a
recipient taps a push notification that's based on the message template
and the value of the Action property is URL.
aPNSPushNotificationTemplate_action :: Lens' APNSPushNotificationTemplate (Maybe Action) Source #
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
aPNSPushNotificationTemplate_body :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #
The message body to use in push notifications that are based on the message template.
aPNSPushNotificationTemplate_mediaUrl :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #
The URL of an image or video to display in push notifications that are based on the message template.
aPNSPushNotificationTemplate_rawContent :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #
The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.
aPNSPushNotificationTemplate_sound :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #
The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
aPNSPushNotificationTemplate_title :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #
The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
aPNSPushNotificationTemplate_url :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #
The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
APNSSandboxChannelRequest
data APNSSandboxChannelRequest Source #
Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
See: newAPNSSandboxChannelRequest smart constructor.
Constructors
| APNSSandboxChannelRequest' | |
Fields
| |
Instances
newAPNSSandboxChannelRequest :: APNSSandboxChannelRequest Source #
Create a value of APNSSandboxChannelRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bundleId:APNSSandboxChannelRequest', aPNSSandboxChannelRequest_bundleId - The bundle identifier that's assigned to your iOS app. This identifier
is used for APNs tokens.
$sel:certificate:APNSSandboxChannelRequest', aPNSSandboxChannelRequest_certificate - The APNs client certificate that you received from Apple, if you want
Amazon Pinpoint to communicate with the APNs sandbox environment by
using an APNs certificate.
$sel:defaultAuthenticationMethod:APNSSandboxChannelRequest', aPNSSandboxChannelRequest_defaultAuthenticationMethod - The default authentication method that you want Amazon Pinpoint to use
when authenticating with the APNs sandbox environment, key or
certificate.
$sel:enabled:APNSSandboxChannelRequest', aPNSSandboxChannelRequest_enabled - Specifies whether to enable the APNs sandbox channel for the
application.
$sel:privateKey:APNSSandboxChannelRequest', aPNSSandboxChannelRequest_privateKey - The private key for the APNs client certificate that you want Amazon
Pinpoint to use to communicate with the APNs sandbox environment.
$sel:teamId:APNSSandboxChannelRequest', aPNSSandboxChannelRequest_teamId - The identifier that's assigned to your Apple developer account team.
This identifier is used for APNs tokens.
$sel:tokenKey:APNSSandboxChannelRequest', aPNSSandboxChannelRequest_tokenKey - The authentication key to use for APNs tokens.
$sel:tokenKeyId:APNSSandboxChannelRequest', aPNSSandboxChannelRequest_tokenKeyId - The key identifier that's assigned to your APNs signing key, if you
want Amazon Pinpoint to communicate with the APNs sandbox environment by
using APNs tokens.
aPNSSandboxChannelRequest_bundleId :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
aPNSSandboxChannelRequest_certificate :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
aPNSSandboxChannelRequest_defaultAuthenticationMethod :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #
The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.
aPNSSandboxChannelRequest_enabled :: Lens' APNSSandboxChannelRequest (Maybe Bool) Source #
Specifies whether to enable the APNs sandbox channel for the application.
aPNSSandboxChannelRequest_privateKey :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
aPNSSandboxChannelRequest_teamId :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
aPNSSandboxChannelRequest_tokenKey :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #
The authentication key to use for APNs tokens.
aPNSSandboxChannelRequest_tokenKeyId :: Lens' APNSSandboxChannelRequest (Maybe Text) Source #
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.
APNSSandboxChannelResponse
data APNSSandboxChannelResponse Source #
Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.
See: newAPNSSandboxChannelResponse smart constructor.
Constructors
| APNSSandboxChannelResponse' | |
Fields
| |
Instances
newAPNSSandboxChannelResponse Source #
Create a value of APNSSandboxChannelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_applicationId - The unique identifier for the application that the APNs sandbox channel
applies to.
$sel:creationDate:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_creationDate - The date and time when the APNs sandbox channel was enabled.
$sel:defaultAuthenticationMethod:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_defaultAuthenticationMethod - The default authentication method that Amazon Pinpoint uses to
authenticate with the APNs sandbox environment for this channel, key or
certificate.
$sel:enabled:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_enabled - Specifies whether the APNs sandbox channel is enabled for the
application.
$sel:hasCredential:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.
$sel:hasTokenKey:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_hasTokenKey - Specifies whether the APNs sandbox channel is configured to communicate
with APNs by using APNs tokens. To provide an authentication key for
APNs tokens, set the TokenKey property of the channel.
$sel:id:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_id - (Deprecated) An identifier for the APNs sandbox channel. This property
is retained only for backward compatibility.
$sel:isArchived:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_isArchived - Specifies whether the APNs sandbox channel is archived.
$sel:lastModifiedBy:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_lastModifiedBy - The user who last modified the APNs sandbox channel.
$sel:lastModifiedDate:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_lastModifiedDate - The date and time when the APNs sandbox channel was last modified.
$sel:version:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_version - The current version of the APNs sandbox channel.
$sel:platform:APNSSandboxChannelResponse', aPNSSandboxChannelResponse_platform - The type of messaging or notification platform for the channel. For the
APNs sandbox channel, this value is APNS_SANDBOX.
aPNSSandboxChannelResponse_applicationId :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #
The unique identifier for the application that the APNs sandbox channel applies to.
aPNSSandboxChannelResponse_creationDate :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #
The date and time when the APNs sandbox channel was enabled.
aPNSSandboxChannelResponse_defaultAuthenticationMethod :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
aPNSSandboxChannelResponse_enabled :: Lens' APNSSandboxChannelResponse (Maybe Bool) Source #
Specifies whether the APNs sandbox channel is enabled for the application.
aPNSSandboxChannelResponse_hasCredential :: Lens' APNSSandboxChannelResponse (Maybe Bool) Source #
(Not used) This property is retained only for backward compatibility.
aPNSSandboxChannelResponse_hasTokenKey :: Lens' APNSSandboxChannelResponse (Maybe Bool) Source #
Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
aPNSSandboxChannelResponse_id :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #
(Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.
aPNSSandboxChannelResponse_isArchived :: Lens' APNSSandboxChannelResponse (Maybe Bool) Source #
Specifies whether the APNs sandbox channel is archived.
aPNSSandboxChannelResponse_lastModifiedBy :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #
The user who last modified the APNs sandbox channel.
aPNSSandboxChannelResponse_lastModifiedDate :: Lens' APNSSandboxChannelResponse (Maybe Text) Source #
The date and time when the APNs sandbox channel was last modified.
aPNSSandboxChannelResponse_version :: Lens' APNSSandboxChannelResponse (Maybe Int) Source #
The current version of the APNs sandbox channel.
aPNSSandboxChannelResponse_platform :: Lens' APNSSandboxChannelResponse Text Source #
The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.
APNSVoipChannelRequest
data APNSVoipChannelRequest Source #
Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
See: newAPNSVoipChannelRequest smart constructor.
Constructors
| APNSVoipChannelRequest' | |
Fields
| |
Instances
newAPNSVoipChannelRequest :: APNSVoipChannelRequest Source #
Create a value of APNSVoipChannelRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bundleId:APNSVoipChannelRequest', aPNSVoipChannelRequest_bundleId - The bundle identifier that's assigned to your iOS app. This identifier
is used for APNs tokens.
$sel:certificate:APNSVoipChannelRequest', aPNSVoipChannelRequest_certificate - The APNs client certificate that you received from Apple, if you want
Amazon Pinpoint to communicate with APNs by using an APNs certificate.
$sel:defaultAuthenticationMethod:APNSVoipChannelRequest', aPNSVoipChannelRequest_defaultAuthenticationMethod - The default authentication method that you want Amazon Pinpoint to use
when authenticating with APNs, key or certificate.
$sel:enabled:APNSVoipChannelRequest', aPNSVoipChannelRequest_enabled - Specifies whether to enable the APNs VoIP channel for the application.
$sel:privateKey:APNSVoipChannelRequest', aPNSVoipChannelRequest_privateKey - The private key for the APNs client certificate that you want Amazon
Pinpoint to use to communicate with APNs.
$sel:teamId:APNSVoipChannelRequest', aPNSVoipChannelRequest_teamId - The identifier that's assigned to your Apple developer account team.
This identifier is used for APNs tokens.
$sel:tokenKey:APNSVoipChannelRequest', aPNSVoipChannelRequest_tokenKey - The authentication key to use for APNs tokens.
$sel:tokenKeyId:APNSVoipChannelRequest', aPNSVoipChannelRequest_tokenKeyId - The key identifier that's assigned to your APNs signing key, if you
want Amazon Pinpoint to communicate with APNs by using APNs tokens.
aPNSVoipChannelRequest_bundleId :: Lens' APNSVoipChannelRequest (Maybe Text) Source #
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
aPNSVoipChannelRequest_certificate :: Lens' APNSVoipChannelRequest (Maybe Text) Source #
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
aPNSVoipChannelRequest_defaultAuthenticationMethod :: Lens' APNSVoipChannelRequest (Maybe Text) Source #
The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
aPNSVoipChannelRequest_enabled :: Lens' APNSVoipChannelRequest (Maybe Bool) Source #
Specifies whether to enable the APNs VoIP channel for the application.
aPNSVoipChannelRequest_privateKey :: Lens' APNSVoipChannelRequest (Maybe Text) Source #
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
aPNSVoipChannelRequest_teamId :: Lens' APNSVoipChannelRequest (Maybe Text) Source #
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
aPNSVoipChannelRequest_tokenKey :: Lens' APNSVoipChannelRequest (Maybe Text) Source #
The authentication key to use for APNs tokens.
aPNSVoipChannelRequest_tokenKeyId :: Lens' APNSVoipChannelRequest (Maybe Text) Source #
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
APNSVoipChannelResponse
data APNSVoipChannelResponse Source #
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
See: newAPNSVoipChannelResponse smart constructor.
Constructors
| APNSVoipChannelResponse' | |
Fields
| |
Instances
newAPNSVoipChannelResponse Source #
Create a value of APNSVoipChannelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:APNSVoipChannelResponse', aPNSVoipChannelResponse_applicationId - The unique identifier for the application that the APNs VoIP channel
applies to.
$sel:creationDate:APNSVoipChannelResponse', aPNSVoipChannelResponse_creationDate - The date and time when the APNs VoIP channel was enabled.
$sel:defaultAuthenticationMethod:APNSVoipChannelResponse', aPNSVoipChannelResponse_defaultAuthenticationMethod - The default authentication method that Amazon Pinpoint uses to
authenticate with APNs for this channel, key or certificate.
$sel:enabled:APNSVoipChannelResponse', aPNSVoipChannelResponse_enabled - Specifies whether the APNs VoIP channel is enabled for the application.
$sel:hasCredential:APNSVoipChannelResponse', aPNSVoipChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.
$sel:hasTokenKey:APNSVoipChannelResponse', aPNSVoipChannelResponse_hasTokenKey - Specifies whether the APNs VoIP channel is configured to communicate
with APNs by using APNs tokens. To provide an authentication key for
APNs tokens, set the TokenKey property of the channel.
$sel:id:APNSVoipChannelResponse', aPNSVoipChannelResponse_id - (Deprecated) An identifier for the APNs VoIP channel. This property is
retained only for backward compatibility.
$sel:isArchived:APNSVoipChannelResponse', aPNSVoipChannelResponse_isArchived - Specifies whether the APNs VoIP channel is archived.
$sel:lastModifiedBy:APNSVoipChannelResponse', aPNSVoipChannelResponse_lastModifiedBy - The user who last modified the APNs VoIP channel.
$sel:lastModifiedDate:APNSVoipChannelResponse', aPNSVoipChannelResponse_lastModifiedDate - The date and time when the APNs VoIP channel was last modified.
$sel:version:APNSVoipChannelResponse', aPNSVoipChannelResponse_version - The current version of the APNs VoIP channel.
$sel:platform:APNSVoipChannelResponse', aPNSVoipChannelResponse_platform - The type of messaging or notification platform for the channel. For the
APNs VoIP channel, this value is APNS_VOIP.
aPNSVoipChannelResponse_applicationId :: Lens' APNSVoipChannelResponse (Maybe Text) Source #
The unique identifier for the application that the APNs VoIP channel applies to.
aPNSVoipChannelResponse_creationDate :: Lens' APNSVoipChannelResponse (Maybe Text) Source #
The date and time when the APNs VoIP channel was enabled.
aPNSVoipChannelResponse_defaultAuthenticationMethod :: Lens' APNSVoipChannelResponse (Maybe Text) Source #
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
aPNSVoipChannelResponse_enabled :: Lens' APNSVoipChannelResponse (Maybe Bool) Source #
Specifies whether the APNs VoIP channel is enabled for the application.
aPNSVoipChannelResponse_hasCredential :: Lens' APNSVoipChannelResponse (Maybe Bool) Source #
(Not used) This property is retained only for backward compatibility.
aPNSVoipChannelResponse_hasTokenKey :: Lens' APNSVoipChannelResponse (Maybe Bool) Source #
Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
aPNSVoipChannelResponse_id :: Lens' APNSVoipChannelResponse (Maybe Text) Source #
(Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.
aPNSVoipChannelResponse_isArchived :: Lens' APNSVoipChannelResponse (Maybe Bool) Source #
Specifies whether the APNs VoIP channel is archived.
aPNSVoipChannelResponse_lastModifiedBy :: Lens' APNSVoipChannelResponse (Maybe Text) Source #
The user who last modified the APNs VoIP channel.
aPNSVoipChannelResponse_lastModifiedDate :: Lens' APNSVoipChannelResponse (Maybe Text) Source #
The date and time when the APNs VoIP channel was last modified.
aPNSVoipChannelResponse_version :: Lens' APNSVoipChannelResponse (Maybe Int) Source #
The current version of the APNs VoIP channel.
aPNSVoipChannelResponse_platform :: Lens' APNSVoipChannelResponse Text Source #
The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.
APNSVoipSandboxChannelRequest
data APNSVoipSandboxChannelRequest Source #
Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
See: newAPNSVoipSandboxChannelRequest smart constructor.
Constructors
| APNSVoipSandboxChannelRequest' | |
Fields
| |
Instances
newAPNSVoipSandboxChannelRequest :: APNSVoipSandboxChannelRequest Source #
Create a value of APNSVoipSandboxChannelRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bundleId:APNSVoipSandboxChannelRequest', aPNSVoipSandboxChannelRequest_bundleId - The bundle identifier that's assigned to your iOS app. This identifier
is used for APNs tokens.
$sel:certificate:APNSVoipSandboxChannelRequest', aPNSVoipSandboxChannelRequest_certificate - The APNs client certificate that you received from Apple, if you want
Amazon Pinpoint to communicate with the APNs sandbox environment by
using an APNs certificate.
$sel:defaultAuthenticationMethod:APNSVoipSandboxChannelRequest', aPNSVoipSandboxChannelRequest_defaultAuthenticationMethod - The default authentication method that you want Amazon Pinpoint to use
when authenticating with the APNs sandbox environment for this channel,
key or certificate.
$sel:enabled:APNSVoipSandboxChannelRequest', aPNSVoipSandboxChannelRequest_enabled - Specifies whether the APNs VoIP sandbox channel is enabled for the
application.
$sel:privateKey:APNSVoipSandboxChannelRequest', aPNSVoipSandboxChannelRequest_privateKey - The private key for the APNs client certificate that you want Amazon
Pinpoint to use to communicate with the APNs sandbox environment.
$sel:teamId:APNSVoipSandboxChannelRequest', aPNSVoipSandboxChannelRequest_teamId - The identifier that's assigned to your Apple developer account team.
This identifier is used for APNs tokens.
$sel:tokenKey:APNSVoipSandboxChannelRequest', aPNSVoipSandboxChannelRequest_tokenKey - The authentication key to use for APNs tokens.
$sel:tokenKeyId:APNSVoipSandboxChannelRequest', aPNSVoipSandboxChannelRequest_tokenKeyId - The key identifier that's assigned to your APNs signing key, if you
want Amazon Pinpoint to communicate with the APNs sandbox environment by
using APNs tokens.
aPNSVoipSandboxChannelRequest_bundleId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
aPNSVoipSandboxChannelRequest_certificate :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
aPNSVoipSandboxChannelRequest_defaultAuthenticationMethod :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #
The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.
aPNSVoipSandboxChannelRequest_enabled :: Lens' APNSVoipSandboxChannelRequest (Maybe Bool) Source #
Specifies whether the APNs VoIP sandbox channel is enabled for the application.
aPNSVoipSandboxChannelRequest_privateKey :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
aPNSVoipSandboxChannelRequest_teamId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
aPNSVoipSandboxChannelRequest_tokenKey :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #
The authentication key to use for APNs tokens.
aPNSVoipSandboxChannelRequest_tokenKeyId :: Lens' APNSVoipSandboxChannelRequest (Maybe Text) Source #
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.
APNSVoipSandboxChannelResponse
data APNSVoipSandboxChannelResponse Source #
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
See: newAPNSVoipSandboxChannelResponse smart constructor.
Constructors
| APNSVoipSandboxChannelResponse' | |
Fields
| |
Instances
newAPNSVoipSandboxChannelResponse Source #
Create a value of APNSVoipSandboxChannelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_applicationId - The unique identifier for the application that the APNs VoIP sandbox
channel applies to.
$sel:creationDate:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_creationDate - The date and time when the APNs VoIP sandbox channel was enabled.
$sel:defaultAuthenticationMethod:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_defaultAuthenticationMethod - The default authentication method that Amazon Pinpoint uses to
authenticate with the APNs sandbox environment for this channel, key or
certificate.
$sel:enabled:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_enabled - Specifies whether the APNs VoIP sandbox channel is enabled for the
application.
$sel:hasCredential:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.
$sel:hasTokenKey:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_hasTokenKey - Specifies whether the APNs VoIP sandbox channel is configured to
communicate with APNs by using APNs tokens. To provide an authentication
key for APNs tokens, set the TokenKey property of the channel.
$sel:id:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_id - (Deprecated) An identifier for the APNs VoIP sandbox channel. This
property is retained only for backward compatibility.
$sel:isArchived:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_isArchived - Specifies whether the APNs VoIP sandbox channel is archived.
$sel:lastModifiedBy:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_lastModifiedBy - The user who last modified the APNs VoIP sandbox channel.
$sel:lastModifiedDate:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_lastModifiedDate - The date and time when the APNs VoIP sandbox channel was last modified.
$sel:version:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_version - The current version of the APNs VoIP sandbox channel.
$sel:platform:APNSVoipSandboxChannelResponse', aPNSVoipSandboxChannelResponse_platform - The type of messaging or notification platform for the channel. For the
APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
aPNSVoipSandboxChannelResponse_applicationId :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #
The unique identifier for the application that the APNs VoIP sandbox channel applies to.
aPNSVoipSandboxChannelResponse_creationDate :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #
The date and time when the APNs VoIP sandbox channel was enabled.
aPNSVoipSandboxChannelResponse_defaultAuthenticationMethod :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
aPNSVoipSandboxChannelResponse_enabled :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) Source #
Specifies whether the APNs VoIP sandbox channel is enabled for the application.
aPNSVoipSandboxChannelResponse_hasCredential :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) Source #
(Not used) This property is retained only for backward compatibility.
aPNSVoipSandboxChannelResponse_hasTokenKey :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) Source #
Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
aPNSVoipSandboxChannelResponse_id :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #
(Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.
aPNSVoipSandboxChannelResponse_isArchived :: Lens' APNSVoipSandboxChannelResponse (Maybe Bool) Source #
Specifies whether the APNs VoIP sandbox channel is archived.
aPNSVoipSandboxChannelResponse_lastModifiedBy :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #
The user who last modified the APNs VoIP sandbox channel.
aPNSVoipSandboxChannelResponse_lastModifiedDate :: Lens' APNSVoipSandboxChannelResponse (Maybe Text) Source #
The date and time when the APNs VoIP sandbox channel was last modified.
aPNSVoipSandboxChannelResponse_version :: Lens' APNSVoipSandboxChannelResponse (Maybe Int) Source #
The current version of the APNs VoIP sandbox channel.
aPNSVoipSandboxChannelResponse_platform :: Lens' APNSVoipSandboxChannelResponse Text Source #
The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
ActivitiesResponse
data ActivitiesResponse Source #
Provides information about the activities that were performed by a campaign.
See: newActivitiesResponse smart constructor.
Constructors
| ActivitiesResponse' | |
Fields
| |
Instances
newActivitiesResponse :: ActivitiesResponse Source #
Create a value of ActivitiesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ActivitiesResponse', activitiesResponse_nextToken - The string to use in a subsequent request to get the next page of
results in a paginated response. This value is null if there are no
additional pages.
$sel:item:ActivitiesResponse', activitiesResponse_item - An array of responses, one for each activity that was performed by the
campaign.
activitiesResponse_nextToken :: Lens' ActivitiesResponse (Maybe Text) Source #
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
activitiesResponse_item :: Lens' ActivitiesResponse [ActivityResponse] Source #
An array of responses, one for each activity that was performed by the campaign.
Activity
Specifies the configuration and other settings for an activity in a journey.
See: newActivity smart constructor.
Constructors
| Activity' | |
Fields
| |
Instances
newActivity :: Activity Source #
Create a value of Activity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:custom:Activity', activity_custom - The settings for a custom message activity. This type of activity calls
an AWS Lambda function or web hook that sends messages to participants.
$sel:conditionalSplit:Activity', activity_conditionalSplit - The settings for a yes/no split activity. This type of activity sends
participants down one of two paths in a journey, based on conditions
that you specify.
$sel:contactCenter:Activity', activity_contactCenter - The settings for a connect activity. This type of activity initiates a
contact center call to participants.
$sel:description:Activity', activity_description - The custom description of the activity.
$sel:email:Activity', activity_email - The settings for an email activity. This type of activity sends an email
message to participants.
$sel:holdout:Activity', activity_holdout - The settings for a holdout activity. This type of activity stops a
journey for a specified percentage of participants.
$sel:multiCondition:Activity', activity_multiCondition - The settings for a multivariate split activity. This type of activity
sends participants down one of as many as five paths (including a
default Else path) in a journey, based on conditions that you specify.
$sel:push:Activity', activity_push - The settings for a push notification activity. This type of activity
sends a push notification to participants.
$sel:randomSplit:Activity', activity_randomSplit - The settings for a random split activity. This type of activity randomly
sends specified percentages of participants down one of as many as five
paths in a journey, based on conditions that you specify.
$sel:sms:Activity', activity_sms - The settings for an SMS activity. This type of activity sends a text
message to participants.
$sel:wait:Activity', activity_wait - The settings for a wait activity. This type of activity waits for a
certain amount of time or until a specific date and time before moving
participants to the next activity in a journey.
activity_custom :: Lens' Activity (Maybe CustomMessageActivity) Source #
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
activity_conditionalSplit :: Lens' Activity (Maybe ConditionalSplitActivity) Source #
The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
activity_contactCenter :: Lens' Activity (Maybe ContactCenterActivity) Source #
The settings for a connect activity. This type of activity initiates a contact center call to participants.
activity_email :: Lens' Activity (Maybe EmailMessageActivity) Source #
The settings for an email activity. This type of activity sends an email message to participants.
activity_holdout :: Lens' Activity (Maybe HoldoutActivity) Source #
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
activity_multiCondition :: Lens' Activity (Maybe MultiConditionalSplitActivity) Source #
The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
activity_push :: Lens' Activity (Maybe PushMessageActivity) Source #
The settings for a push notification activity. This type of activity sends a push notification to participants.
activity_randomSplit :: Lens' Activity (Maybe RandomSplitActivity) Source #
The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
activity_sms :: Lens' Activity (Maybe SMSMessageActivity) Source #
The settings for an SMS activity. This type of activity sends a text message to participants.
activity_wait :: Lens' Activity (Maybe WaitActivity) Source #
The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
ActivityResponse
data ActivityResponse Source #
Provides information about an activity that was performed by a campaign.
See: newActivityResponse smart constructor.
Constructors
| ActivityResponse' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ActivityResponse |
Create a value of ActivityResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:end:ActivityResponse', activityResponse_end - The actual time, in ISO 8601 format, when the activity was marked
CANCELLED or COMPLETED.
$sel:result:ActivityResponse', activityResponse_result - Specifies whether the activity succeeded. Possible values are SUCCESS
and FAIL.
$sel:scheduledStart:ActivityResponse', activityResponse_scheduledStart - The scheduled start time, in ISO 8601 format, for the activity.
$sel:start:ActivityResponse', activityResponse_start - The actual start time, in ISO 8601 format, of the activity.
$sel:state:ActivityResponse', activityResponse_state - The current status of the activity. Possible values are: PENDING,
INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.
$sel:successfulEndpointCount:ActivityResponse', activityResponse_successfulEndpointCount - The total number of endpoints that the campaign successfully delivered
messages to.
$sel:timezonesCompletedCount:ActivityResponse', activityResponse_timezonesCompletedCount - The total number of time zones that were completed.
$sel:timezonesTotalCount:ActivityResponse', activityResponse_timezonesTotalCount - The total number of unique time zones that are in the segment for the
campaign.
$sel:totalEndpointCount:ActivityResponse', activityResponse_totalEndpointCount - The total number of endpoints that the campaign attempted to deliver
messages to.
$sel:treatmentId:ActivityResponse', activityResponse_treatmentId - The unique identifier for the campaign treatment that the activity
applies to. A treatment is a variation of a campaign that's used for
A/B testing of a campaign.
$sel:campaignId:ActivityResponse', activityResponse_campaignId - The unique identifier for the campaign that the activity applies to.
$sel:id:ActivityResponse', activityResponse_id - The unique identifier for the activity.
$sel:applicationId:ActivityResponse', activityResponse_applicationId - The unique identifier for the application that the campaign applies to.
activityResponse_end :: Lens' ActivityResponse (Maybe Text) Source #
The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
activityResponse_result :: Lens' ActivityResponse (Maybe Text) Source #
Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
activityResponse_scheduledStart :: Lens' ActivityResponse (Maybe Text) Source #
The scheduled start time, in ISO 8601 format, for the activity.
activityResponse_start :: Lens' ActivityResponse (Maybe Text) Source #
The actual start time, in ISO 8601 format, of the activity.
activityResponse_state :: Lens' ActivityResponse (Maybe Text) Source #
The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.
activityResponse_successfulEndpointCount :: Lens' ActivityResponse (Maybe Int) Source #
The total number of endpoints that the campaign successfully delivered messages to.
activityResponse_timezonesCompletedCount :: Lens' ActivityResponse (Maybe Int) Source #
The total number of time zones that were completed.
activityResponse_timezonesTotalCount :: Lens' ActivityResponse (Maybe Int) Source #
The total number of unique time zones that are in the segment for the campaign.
activityResponse_totalEndpointCount :: Lens' ActivityResponse (Maybe Int) Source #
The total number of endpoints that the campaign attempted to deliver messages to.
activityResponse_treatmentId :: Lens' ActivityResponse (Maybe Text) Source #
The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
activityResponse_campaignId :: Lens' ActivityResponse Text Source #
The unique identifier for the campaign that the activity applies to.
activityResponse_id :: Lens' ActivityResponse Text Source #
The unique identifier for the activity.
activityResponse_applicationId :: Lens' ActivityResponse Text Source #
The unique identifier for the application that the campaign applies to.
AddressConfiguration
data AddressConfiguration Source #
Specifies address-based configuration settings for a message that's sent directly to an endpoint.
See: newAddressConfiguration smart constructor.
Constructors
| AddressConfiguration' | |
Fields
| |
Instances
newAddressConfiguration :: AddressConfiguration Source #
Create a value of AddressConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bodyOverride:AddressConfiguration', addressConfiguration_bodyOverride - The message body to use instead of the default message body. This value
overrides the default message body.
$sel:channelType:AddressConfiguration', addressConfiguration_channelType - The channel to use when sending the message.
$sel:context:AddressConfiguration', addressConfiguration_context - An object that maps custom attributes to attributes for the address and
is attached to the message. Attribute names are case sensitive.
For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
$sel:rawContent:AddressConfiguration', addressConfiguration_rawContent - The raw, JSON-formatted string to use as the payload for the message. If
specified, this value overrides all other values for the message.
$sel:substitutions:AddressConfiguration', addressConfiguration_substitutions - A map of the message variables to merge with the variables specified by
properties of the DefaultMessage object. The variables specified in this
map take precedence over all other variables.
$sel:titleOverride:AddressConfiguration', addressConfiguration_titleOverride - The message title to use instead of the default message title. This
value overrides the default message title.
addressConfiguration_bodyOverride :: Lens' AddressConfiguration (Maybe Text) Source #
The message body to use instead of the default message body. This value overrides the default message body.
addressConfiguration_channelType :: Lens' AddressConfiguration (Maybe ChannelType) Source #
The channel to use when sending the message.
addressConfiguration_context :: Lens' AddressConfiguration (Maybe (HashMap Text Text)) Source #
An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.
For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
addressConfiguration_rawContent :: Lens' AddressConfiguration (Maybe Text) Source #
The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
addressConfiguration_substitutions :: Lens' AddressConfiguration (Maybe (HashMap Text [Text])) Source #
A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.
addressConfiguration_titleOverride :: Lens' AddressConfiguration (Maybe Text) Source #
The message title to use instead of the default message title. This value overrides the default message title.
AndroidPushNotificationTemplate
data AndroidPushNotificationTemplate Source #
Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.
See: newAndroidPushNotificationTemplate smart constructor.
Constructors
| AndroidPushNotificationTemplate' | |
Fields
| |
Instances
newAndroidPushNotificationTemplate :: AndroidPushNotificationTemplate Source #
Create a value of AndroidPushNotificationTemplate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:AndroidPushNotificationTemplate', androidPushNotificationTemplate_action - The action to occur if a recipient taps a push notification that's
based on the message template. Valid values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
$sel:body:AndroidPushNotificationTemplate', androidPushNotificationTemplate_body - The message body to use in a push notification that's based on the
message template.
$sel:imageIconUrl:AndroidPushNotificationTemplate', androidPushNotificationTemplate_imageIconUrl - The URL of the large icon image to display in the content view of a push
notification that's based on the message template.
$sel:imageUrl:AndroidPushNotificationTemplate', androidPushNotificationTemplate_imageUrl - The URL of an image to display in a push notification that's based on
the message template.
$sel:rawContent:AndroidPushNotificationTemplate', androidPushNotificationTemplate_rawContent - The raw, JSON-formatted string to use as the payload for a push
notification that's based on the message template. If specified, this
value overrides all other content for the message template.
$sel:smallImageIconUrl:AndroidPushNotificationTemplate', androidPushNotificationTemplate_smallImageIconUrl - The URL of the small icon image to display in the status bar and the
content view of a push notification that's based on the message
template.
$sel:sound:AndroidPushNotificationTemplate', androidPushNotificationTemplate_sound - The sound to play when a recipient receives a push notification that's
based on the message template. You can use the default stream or specify
the file name of a sound resource that's bundled in your app. On an
Android platform, the sound file must reside in /res/raw/.
$sel:title:AndroidPushNotificationTemplate', androidPushNotificationTemplate_title - The title to use in a push notification that's based on the message
template. This title appears above the notification message on a
recipient's device.
$sel:url:AndroidPushNotificationTemplate', androidPushNotificationTemplate_url - The URL to open in a recipient's default mobile browser, if a recipient
taps a push notification that's based on the message template and the
value of the Action property is URL.
androidPushNotificationTemplate_action :: Lens' AndroidPushNotificationTemplate (Maybe Action) Source #
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
androidPushNotificationTemplate_body :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #
The message body to use in a push notification that's based on the message template.
androidPushNotificationTemplate_imageIconUrl :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
androidPushNotificationTemplate_imageUrl :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #
The URL of an image to display in a push notification that's based on the message template.
androidPushNotificationTemplate_rawContent :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #
The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
androidPushNotificationTemplate_smallImageIconUrl :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
androidPushNotificationTemplate_sound :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
androidPushNotificationTemplate_title :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
androidPushNotificationTemplate_url :: Lens' AndroidPushNotificationTemplate (Maybe Text) Source #
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
ApplicationDateRangeKpiResponse
data ApplicationDateRangeKpiResponse Source #
Provides the results of a query that retrieved the data for a standard metric that applies to an application, and provides information about that query.
See: newApplicationDateRangeKpiResponse smart constructor.
Constructors
| ApplicationDateRangeKpiResponse' | |
Fields
| |
Instances
newApplicationDateRangeKpiResponse Source #
Arguments
| :: BaseKpiResult | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> Text | |
| -> ApplicationDateRangeKpiResponse |
Create a value of ApplicationDateRangeKpiResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ApplicationDateRangeKpiResponse', applicationDateRangeKpiResponse_nextToken - The string to use in a subsequent request to get the next page of
results in a paginated response. This value is null for the Application
Metrics resource because the resource returns all results in a single
page.
$sel:kpiResult:ApplicationDateRangeKpiResponse', applicationDateRangeKpiResponse_kpiResult - An array of objects that contains the results of the query. Each object
contains the value for the metric and metadata about that value.
$sel:kpiName:ApplicationDateRangeKpiResponse', applicationDateRangeKpiResponse_kpiName - The name of the metric, also referred to as a /key performance indicator
(KPI)/, that the data was retrieved for. This value describes the
associated metric and consists of two or more terms, which are comprised
of lowercase alphanumeric characters, separated by a hyphen. For a list
of possible values, see the
Amazon Pinpoint Developer Guide.
$sel:endTime:ApplicationDateRangeKpiResponse', applicationDateRangeKpiResponse_endTime - The last date and time of the date range that was used to filter the
query results, in extended ISO 8601 format. The date range is inclusive.
$sel:startTime:ApplicationDateRangeKpiResponse', applicationDateRangeKpiResponse_startTime - The first date and time of the date range that was used to filter the
query results, in extended ISO 8601 format. The date range is inclusive.
$sel:applicationId:ApplicationDateRangeKpiResponse', applicationDateRangeKpiResponse_applicationId - The unique identifier for the application that the metric applies to.
applicationDateRangeKpiResponse_nextToken :: Lens' ApplicationDateRangeKpiResponse (Maybe Text) Source #
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Application Metrics resource because the resource returns all results in a single page.
applicationDateRangeKpiResponse_kpiResult :: Lens' ApplicationDateRangeKpiResponse BaseKpiResult Source #
An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
applicationDateRangeKpiResponse_kpiName :: Lens' ApplicationDateRangeKpiResponse Text Source #
The name of the metric, also referred to as a /key performance indicator (KPI)/, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
applicationDateRangeKpiResponse_endTime :: Lens' ApplicationDateRangeKpiResponse UTCTime Source #
The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
applicationDateRangeKpiResponse_startTime :: Lens' ApplicationDateRangeKpiResponse UTCTime Source #
The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
applicationDateRangeKpiResponse_applicationId :: Lens' ApplicationDateRangeKpiResponse Text Source #
The unique identifier for the application that the metric applies to.
ApplicationResponse
data ApplicationResponse Source #
Provides information about an application.
See: newApplicationResponse smart constructor.
Constructors
| ApplicationResponse' | |
Fields
| |
Instances
newApplicationResponse Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ApplicationResponse |
Create a value of ApplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationDate:ApplicationResponse', applicationResponse_creationDate - The date and time when the Application was created.
$sel:tags:ApplicationResponse', applicationResponse_tags - A string-to-string map of key-value pairs that identifies the tags that
are associated with the application. Each tag consists of a required tag
key and an associated tag value.
$sel:id:ApplicationResponse', applicationResponse_id - The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
$sel:arn:ApplicationResponse', applicationResponse_arn - The Amazon Resource Name (ARN) of the application.
$sel:name:ApplicationResponse', applicationResponse_name - The display name of the application. This name is displayed as the
Project name on the Amazon Pinpoint console.
applicationResponse_creationDate :: Lens' ApplicationResponse (Maybe Text) Source #
The date and time when the Application was created.
applicationResponse_tags :: Lens' ApplicationResponse (Maybe (HashMap Text Text)) Source #
A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.
applicationResponse_id :: Lens' ApplicationResponse Text Source #
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
applicationResponse_arn :: Lens' ApplicationResponse Text Source #
The Amazon Resource Name (ARN) of the application.
applicationResponse_name :: Lens' ApplicationResponse Text Source #
The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
ApplicationSettingsResource
data ApplicationSettingsResource Source #
Provides information about an application, including the default settings for an application.
See: newApplicationSettingsResource smart constructor.
Constructors
| ApplicationSettingsResource' | |
Fields
| |
Instances
newApplicationSettingsResource Source #
Create a value of ApplicationSettingsResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:campaignHook:ApplicationSettingsResource', applicationSettingsResource_campaignHook - The settings for the AWS Lambda function to invoke by default as a code
hook for campaigns in the application. You can use this hook to
customize segments that are used by campaigns in the application.
$sel:lastModifiedDate:ApplicationSettingsResource', applicationSettingsResource_lastModifiedDate - The date and time, in ISO 8601 format, when the application's settings
were last modified.
$sel:limits:ApplicationSettingsResource', applicationSettingsResource_limits - The default sending limits for campaigns in the application.
$sel:quietTime:ApplicationSettingsResource', applicationSettingsResource_quietTime - The default quiet time for campaigns in the application. Quiet time is a
specific time range when messages aren't sent to endpoints, if all the
following conditions are met:
- The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
- The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
- The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
$sel:applicationId:ApplicationSettingsResource', applicationSettingsResource_applicationId - The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
applicationSettingsResource_campaignHook :: Lens' ApplicationSettingsResource (Maybe CampaignHook) Source #
The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
applicationSettingsResource_lastModifiedDate :: Lens' ApplicationSettingsResource (Maybe Text) Source #
The date and time, in ISO 8601 format, when the application's settings were last modified.
applicationSettingsResource_limits :: Lens' ApplicationSettingsResource (Maybe CampaignLimits) Source #
The default sending limits for campaigns in the application.
applicationSettingsResource_quietTime :: Lens' ApplicationSettingsResource (Maybe QuietTime) Source #
The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:
- The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
- The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
- The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
applicationSettingsResource_applicationId :: Lens' ApplicationSettingsResource Text Source #
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
ApplicationsResponse
data ApplicationsResponse Source #
Provides information about all of your applications.
See: newApplicationsResponse smart constructor.
Constructors
| ApplicationsResponse' | |
Instances
newApplicationsResponse :: ApplicationsResponse Source #
Create a value of ApplicationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:item:ApplicationsResponse', applicationsResponse_item - An array of responses, one for each application that was returned.
$sel:nextToken:ApplicationsResponse', applicationsResponse_nextToken - The string to use in a subsequent request to get the next page of
results in a paginated response. This value is null if there are no
additional pages.
applicationsResponse_item :: Lens' ApplicationsResponse (Maybe [ApplicationResponse]) Source #
An array of responses, one for each application that was returned.
applicationsResponse_nextToken :: Lens' ApplicationsResponse (Maybe Text) Source #
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
AttributeDimension
data AttributeDimension Source #
Specifies attribute-based criteria for including or excluding endpoints from a segment.
See: newAttributeDimension smart constructor.
Constructors
| AttributeDimension' | |
Fields
| |
Instances
newAttributeDimension :: AttributeDimension Source #
Create a value of AttributeDimension with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeType:AttributeDimension', attributeDimension_attributeType - The type of segment dimension to use. Valid values are:
INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
$sel:values:AttributeDimension', attributeDimension_values - The criteria values to use for the segment dimension. Depending on the
value of the AttributeType property, endpoints are included or excluded
from the segment if their attribute values match the criteria values.
attributeDimension_attributeType :: Lens' AttributeDimension (Maybe AttributeType) Source #
The type of segment dimension to use. Valid values are:
INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
attributeDimension_values :: Lens' AttributeDimension [Text] Source #
The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
AttributesResource
data AttributesResource Source #
Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.
See: newAttributesResource smart constructor.
Constructors
| AttributesResource' | |
Fields
| |
Instances
newAttributesResource Source #
Arguments
| :: Text | |
| -> Text | |
| -> AttributesResource |
Create a value of AttributesResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:AttributesResource', attributesResource_attributes - An array that specifies the names of the attributes that were removed
from the endpoints.
$sel:attributeType:AttributesResource', attributesResource_attributeType - The type of attribute or attributes that were removed from the
endpoints. Valid values are:
- endpoint-custom-attributes - Custom attributes that describe endpoints.
- endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints.
- endpoint-user-attributes - Custom attributes that describe users.
$sel:applicationId:AttributesResource', attributesResource_applicationId - The unique identifier for the application.
attributesResource_attributes :: Lens' AttributesResource (Maybe [Text]) Source #
An array that specifies the names of the attributes that were removed from the endpoints.
attributesResource_attributeType :: Lens' AttributesResource Text Source #
The type of attribute or attributes that were removed from the endpoints. Valid values are:
- endpoint-custom-attributes - Custom attributes that describe endpoints.
- endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints.
- endpoint-user-attributes - Custom attributes that describe users.
attributesResource_applicationId :: Lens' AttributesResource Text Source #
The unique identifier for the application.
BaiduChannelRequest
data BaiduChannelRequest Source #
Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
See: newBaiduChannelRequest smart constructor.
Constructors
| BaiduChannelRequest' | |
Fields
| |
Instances
newBaiduChannelRequest Source #
Arguments
| :: Text | |
| -> Text | |
| -> BaiduChannelRequest |
Create a value of BaiduChannelRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:BaiduChannelRequest', baiduChannelRequest_enabled - Specifies whether to enable the Baidu channel for the application.
$sel:secretKey:BaiduChannelRequest', baiduChannelRequest_secretKey - The secret key that you received from the Baidu Cloud Push service to
communicate with the service.
$sel:apiKey:BaiduChannelRequest', baiduChannelRequest_apiKey - The API key that you received from the Baidu Cloud Push service to
communicate with the service.
baiduChannelRequest_enabled :: Lens' BaiduChannelRequest (Maybe Bool) Source #
Specifies whether to enable the Baidu channel for the application.
baiduChannelRequest_secretKey :: Lens' BaiduChannelRequest Text Source #
The secret key that you received from the Baidu Cloud Push service to communicate with the service.
baiduChannelRequest_apiKey :: Lens' BaiduChannelRequest Text Source #
The API key that you received from the Baidu Cloud Push service to communicate with the service.
BaiduChannelResponse
data BaiduChannelResponse Source #
Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.
See: newBaiduChannelResponse smart constructor.
Constructors
| BaiduChannelResponse' | |
Fields
| |
Instances
newBaiduChannelResponse Source #
Arguments
| :: Text | |
| -> Text | |
| -> BaiduChannelResponse |
Create a value of BaiduChannelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:BaiduChannelResponse', baiduChannelResponse_applicationId - The unique identifier for the application that the Baidu channel applies
to.
$sel:creationDate:BaiduChannelResponse', baiduChannelResponse_creationDate - The date and time when the Baidu channel was enabled.
$sel:enabled:BaiduChannelResponse', baiduChannelResponse_enabled - Specifies whether the Baidu channel is enabled for the application.
$sel:hasCredential:BaiduChannelResponse', baiduChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.
$sel:id:BaiduChannelResponse', baiduChannelResponse_id - (Deprecated) An identifier for the Baidu channel. This property is
retained only for backward compatibility.
$sel:isArchived:BaiduChannelResponse', baiduChannelResponse_isArchived - Specifies whether the Baidu channel is archived.
$sel:lastModifiedBy:BaiduChannelResponse', baiduChannelResponse_lastModifiedBy - The user who last modified the Baidu channel.
$sel:lastModifiedDate:BaiduChannelResponse', baiduChannelResponse_lastModifiedDate - The date and time when the Baidu channel was last modified.
$sel:version:BaiduChannelResponse', baiduChannelResponse_version - The current version of the Baidu channel.
$sel:credential:BaiduChannelResponse', baiduChannelResponse_credential - The API key that you received from the Baidu Cloud Push service to
communicate with the service.
$sel:platform:BaiduChannelResponse', baiduChannelResponse_platform - The type of messaging or notification platform for the channel. For the
Baidu channel, this value is BAIDU.
baiduChannelResponse_applicationId :: Lens' BaiduChannelResponse (Maybe Text) Source #
The unique identifier for the application that the Baidu channel applies to.
baiduChannelResponse_creationDate :: Lens' BaiduChannelResponse (Maybe Text) Source #
The date and time when the Baidu channel was enabled.
baiduChannelResponse_enabled :: Lens' BaiduChannelResponse (Maybe Bool) Source #
Specifies whether the Baidu channel is enabled for the application.
baiduChannelResponse_hasCredential :: Lens' BaiduChannelResponse (Maybe Bool) Source #
(Not used) This property is retained only for backward compatibility.
baiduChannelResponse_id :: Lens' BaiduChannelResponse (Maybe Text) Source #
(Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.
baiduChannelResponse_isArchived :: Lens' BaiduChannelResponse (Maybe Bool) Source #
Specifies whether the Baidu channel is archived.
baiduChannelResponse_lastModifiedBy :: Lens' BaiduChannelResponse (Maybe Text) Source #
The user who last modified the Baidu channel.
baiduChannelResponse_lastModifiedDate :: Lens' BaiduChannelResponse (Maybe Text) Source #
The date and time when the Baidu channel was last modified.
baiduChannelResponse_version :: Lens' BaiduChannelResponse (Maybe Int) Source #
The current version of the Baidu channel.
baiduChannelResponse_credential :: Lens' BaiduChannelResponse Text Source #
The API key that you received from the Baidu Cloud Push service to communicate with the service.
baiduChannelResponse_platform :: Lens' BaiduChannelResponse Text Source #
The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.
BaiduMessage
data BaiduMessage Source #
Specifies the settings for a one-time message that's sent directly to an endpoint through the Baidu (Baidu Cloud Push) channel.
See: newBaiduMessage smart constructor.
Constructors
| BaiduMessage' | |
Fields
| |
Instances
newBaiduMessage :: BaiduMessage Source #
Create a value of BaiduMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:BaiduMessage', baiduMessage_action - The action to occur if the recipient taps the push notification. Valid
values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
$sel:body:BaiduMessage', baiduMessage_body - The body of the notification message.
$sel:data':BaiduMessage', baiduMessage_data - The JSON data payload to use for the push notification, if the
notification is a silent push notification. This payload is added to the
data.pinpoint.jsonBody object of the notification.
$sel:iconReference:BaiduMessage', baiduMessage_iconReference - The icon image name of the asset saved in your app.
$sel:imageIconUrl:BaiduMessage', baiduMessage_imageIconUrl - The URL of the large icon image to display in the content view of the
push notification.
$sel:imageUrl:BaiduMessage', baiduMessage_imageUrl - The URL of an image to display in the push notification.
$sel:rawContent:BaiduMessage', baiduMessage_rawContent - The raw, JSON-formatted string to use as the payload for the
notification message. If specified, this value overrides all other
content for the message.
$sel:silentPush:BaiduMessage', baiduMessage_silentPush - Specifies whether the notification is a silent push notification, which
is a push notification that doesn't display on a recipient's device.
Silent push notifications can be used for cases such as updating an
app's configuration or supporting phone home functionality.
$sel:smallImageIconUrl:BaiduMessage', baiduMessage_smallImageIconUrl - The URL of the small icon image to display in the status bar and the
content view of the push notification.
$sel:sound:BaiduMessage', baiduMessage_sound - The sound to play when the recipient receives the push notification. You
can use the default stream or specify the file name of a sound resource
that's bundled in your app. On an Android platform, the sound file must
reside in /res/raw/.
$sel:substitutions:BaiduMessage', baiduMessage_substitutions - The default message variables to use in the notification message. You
can override the default variables with individual address variables.
$sel:timeToLive:BaiduMessage', baiduMessage_timeToLive - The amount of time, in seconds, that the Baidu Cloud Push service should
store the message if the recipient's device is offline. The default
value and maximum supported time is 604,800 seconds (7 days).
$sel:title:BaiduMessage', baiduMessage_title - The title to display above the notification message on the recipient's
device.
$sel:url:BaiduMessage', baiduMessage_url - The URL to open in the recipient's default mobile browser, if a
recipient taps the push notification and the value of the Action
property is URL.
baiduMessage_action :: Lens' BaiduMessage (Maybe Action) Source #
The action to occur if the recipient taps the push notification. Valid values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
baiduMessage_body :: Lens' BaiduMessage (Maybe Text) Source #
The body of the notification message.
baiduMessage_data :: Lens' BaiduMessage (Maybe (HashMap Text Text)) Source #
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
baiduMessage_iconReference :: Lens' BaiduMessage (Maybe Text) Source #
The icon image name of the asset saved in your app.
baiduMessage_imageIconUrl :: Lens' BaiduMessage (Maybe Text) Source #
The URL of the large icon image to display in the content view of the push notification.
baiduMessage_imageUrl :: Lens' BaiduMessage (Maybe Text) Source #
The URL of an image to display in the push notification.
baiduMessage_rawContent :: Lens' BaiduMessage (Maybe Text) Source #
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
baiduMessage_silentPush :: Lens' BaiduMessage (Maybe Bool) Source #
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
baiduMessage_smallImageIconUrl :: Lens' BaiduMessage (Maybe Text) Source #
The URL of the small icon image to display in the status bar and the content view of the push notification.
baiduMessage_sound :: Lens' BaiduMessage (Maybe Text) Source #
The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
baiduMessage_substitutions :: Lens' BaiduMessage (Maybe (HashMap Text [Text])) Source #
The default message variables to use in the notification message. You can override the default variables with individual address variables.
baiduMessage_timeToLive :: Lens' BaiduMessage (Maybe Int) Source #
The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).
baiduMessage_title :: Lens' BaiduMessage (Maybe Text) Source #
The title to display above the notification message on the recipient's device.
baiduMessage_url :: Lens' BaiduMessage (Maybe Text) Source #
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
BaseKpiResult
data BaseKpiResult Source #
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
See: newBaseKpiResult smart constructor.
Constructors
| BaseKpiResult' | |
Instances
newBaseKpiResult :: BaseKpiResult Source #
Create a value of BaseKpiResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rows:BaseKpiResult', baseKpiResult_rows - An array of objects that provides the results of a query that retrieved
the data for a standard metric that applies to an application, campaign,
or journey.
baseKpiResult_rows :: Lens' BaseKpiResult [ResultRow] Source #
An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
CampaignCustomMessage
data CampaignCustomMessage Source #
Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.
See: newCampaignCustomMessage smart constructor.
Constructors
| CampaignCustomMessage' | |
Instances
newCampaignCustomMessage :: CampaignCustomMessage Source #
Create a value of CampaignCustomMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:data':CampaignCustomMessage', campaignCustomMessage_data - The raw, JSON-formatted string to use as the payload for the message.
The maximum size is 5 KB.
campaignCustomMessage_data :: Lens' CampaignCustomMessage (Maybe Text) Source #
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
CampaignDateRangeKpiResponse
data CampaignDateRangeKpiResponse Source #
Provides the results of a query that retrieved the data for a standard metric that applies to a campaign, and provides information about that query.
See: newCampaignDateRangeKpiResponse smart constructor.
Constructors
| CampaignDateRangeKpiResponse' | |
Fields
| |
Instances
newCampaignDateRangeKpiResponse Source #
Arguments
| :: BaseKpiResult | |
| -> Text | |
| -> UTCTime | |
| -> Text | |
| -> UTCTime | |
| -> Text | |
| -> CampaignDateRangeKpiResponse |
Create a value of CampaignDateRangeKpiResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:CampaignDateRangeKpiResponse', campaignDateRangeKpiResponse_nextToken - The string to use in a subsequent request to get the next page of
results in a paginated response. This value is null for the Campaign
Metrics resource because the resource returns all results in a single
page.
$sel:kpiResult:CampaignDateRangeKpiResponse', campaignDateRangeKpiResponse_kpiResult - An array of objects that contains the results of the query. Each object
contains the value for the metric and metadata about that value.
$sel:kpiName:CampaignDateRangeKpiResponse', campaignDateRangeKpiResponse_kpiName - The name of the metric, also referred to as a /key performance indicator
(KPI)/, that the data was retrieved for. This value describes the
associated metric and consists of two or more terms, which are comprised
of lowercase alphanumeric characters, separated by a hyphen. For a list
of possible values, see the
Amazon Pinpoint Developer Guide.
$sel:endTime:CampaignDateRangeKpiResponse', campaignDateRangeKpiResponse_endTime - The last date and time of the date range that was used to filter the
query results, in extended ISO 8601 format. The date range is inclusive.
$sel:campaignId:CampaignDateRangeKpiResponse', campaignDateRangeKpiResponse_campaignId - The unique identifier for the campaign that the metric applies to.
$sel:startTime:CampaignDateRangeKpiResponse', campaignDateRangeKpiResponse_startTime - The first date and time of the date range that was used to filter the
query results, in extended ISO 8601 format. The date range is inclusive.
$sel:applicationId:CampaignDateRangeKpiResponse', campaignDateRangeKpiResponse_applicationId - The unique identifier for the application that the metric applies to.
campaignDateRangeKpiResponse_nextToken :: Lens' CampaignDateRangeKpiResponse (Maybe Text) Source #
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.
campaignDateRangeKpiResponse_kpiResult :: Lens' CampaignDateRangeKpiResponse BaseKpiResult Source #
An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
campaignDateRangeKpiResponse_kpiName :: Lens' CampaignDateRangeKpiResponse Text Source #
The name of the metric, also referred to as a /key performance indicator (KPI)/, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
campaignDateRangeKpiResponse_endTime :: Lens' CampaignDateRangeKpiResponse UTCTime Source #
The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
campaignDateRangeKpiResponse_campaignId :: Lens' CampaignDateRangeKpiResponse Text Source #
The unique identifier for the campaign that the metric applies to.
campaignDateRangeKpiResponse_startTime :: Lens' CampaignDateRangeKpiResponse UTCTime Source #
The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
campaignDateRangeKpiResponse_applicationId :: Lens' CampaignDateRangeKpiResponse Text Source #
The unique identifier for the application that the metric applies to.
CampaignEmailMessage
data CampaignEmailMessage Source #
Specifies the content and "From" address for an email message that's sent to recipients of a campaign.
See: newCampaignEmailMessage smart constructor.
Constructors
| CampaignEmailMessage' | |
Fields
| |
Instances
newCampaignEmailMessage :: CampaignEmailMessage Source #
Create a value of CampaignEmailMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:body:CampaignEmailMessage', campaignEmailMessage_body - The body of the email for recipients whose email clients don't render
HTML content.
$sel:fromAddress:CampaignEmailMessage', campaignEmailMessage_fromAddress - The verified email address to send the email from. The default address
is the FromAddress specified for the email channel for the application.
$sel:htmlBody:CampaignEmailMessage', campaignEmailMessage_htmlBody - The body of the email, in HTML format, for recipients whose email
clients render HTML content.
$sel:title:CampaignEmailMessage', campaignEmailMessage_title - The subject line, or title, of the email.
campaignEmailMessage_body :: Lens' CampaignEmailMessage (Maybe Text) Source #
The body of the email for recipients whose email clients don't render HTML content.
campaignEmailMessage_fromAddress :: Lens' CampaignEmailMessage (Maybe Text) Source #
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
campaignEmailMessage_htmlBody :: Lens' CampaignEmailMessage (Maybe Text) Source #
The body of the email, in HTML format, for recipients whose email clients render HTML content.
campaignEmailMessage_title :: Lens' CampaignEmailMessage (Maybe Text) Source #
The subject line, or title, of the email.
CampaignEventFilter
data CampaignEventFilter Source #
Specifies the settings for events that cause a campaign to be sent.
See: newCampaignEventFilter smart constructor.
Constructors
| CampaignEventFilter' | |
Fields
| |
Instances
newCampaignEventFilter Source #
Arguments
| :: FilterType | |
| -> EventDimensions | |
| -> CampaignEventFilter |
Create a value of CampaignEventFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filterType:CampaignEventFilter', campaignEventFilter_filterType - The type of event that causes the campaign to be sent. Valid values are:
SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT,
sends the campaign when an endpoint event (Events resource) occurs.
$sel:dimensions:CampaignEventFilter', campaignEventFilter_dimensions - The dimension settings of the event filter for the campaign.
campaignEventFilter_filterType :: Lens' CampaignEventFilter FilterType Source #
The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.
campaignEventFilter_dimensions :: Lens' CampaignEventFilter EventDimensions Source #
The dimension settings of the event filter for the campaign.
CampaignHook
data CampaignHook Source #
Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.
See: newCampaignHook smart constructor.
Constructors
| CampaignHook' | |
Fields
| |
Instances
newCampaignHook :: CampaignHook Source #
Create a value of CampaignHook with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lambdaFunctionName:CampaignHook', campaignHook_lambdaFunctionName - The name or Amazon Resource Name (ARN) of the AWS Lambda function that
Amazon Pinpoint invokes to customize a segment for a campaign.
$sel:mode:CampaignHook', campaignHook_mode - The mode that Amazon Pinpoint uses to invoke the AWS Lambda function.
Possible values are:
- FILTER - Invoke the function to customize the segment that's used by a campaign.
- DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
$sel:webUrl:CampaignHook', campaignHook_webUrl - The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function
over HTTPS.
campaignHook_lambdaFunctionName :: Lens' CampaignHook (Maybe Text) Source #
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
campaignHook_mode :: Lens' CampaignHook (Maybe Mode) Source #
The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
- FILTER - Invoke the function to customize the segment that's used by a campaign.
- DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
campaignHook_webUrl :: Lens' CampaignHook (Maybe Text) Source #
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
CampaignInAppMessage
data CampaignInAppMessage Source #
In-app message configuration.
See: newCampaignInAppMessage smart constructor.
Constructors
| CampaignInAppMessage' | |
Instances
newCampaignInAppMessage :: CampaignInAppMessage Source #
Create a value of CampaignInAppMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:body:CampaignInAppMessage', campaignInAppMessage_body - The message body of the notification, the email body or the text
message.
$sel:content:CampaignInAppMessage', campaignInAppMessage_content - In-app message content.
$sel:customConfig:CampaignInAppMessage', campaignInAppMessage_customConfig - Custom config to be sent to client.
$sel:layout:CampaignInAppMessage', campaignInAppMessage_layout - In-app message layout.
campaignInAppMessage_body :: Lens' CampaignInAppMessage (Maybe Text) Source #
The message body of the notification, the email body or the text message.
campaignInAppMessage_content :: Lens' CampaignInAppMessage (Maybe [InAppMessageContent]) Source #
In-app message content.
campaignInAppMessage_customConfig :: Lens' CampaignInAppMessage (Maybe (HashMap Text Text)) Source #
Custom config to be sent to client.
campaignInAppMessage_layout :: Lens' CampaignInAppMessage (Maybe Layout) Source #
In-app message layout.
CampaignLimits
data CampaignLimits Source #
For a campaign, specifies limits on the messages that the campaign can send. For an application, specifies the default limits for messages that campaigns in the application can send.
See: newCampaignLimits smart constructor.
Constructors
| CampaignLimits' | |
Fields
| |
Instances
newCampaignLimits :: CampaignLimits Source #
Create a value of CampaignLimits with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:daily:CampaignLimits', campaignLimits_daily - The maximum number of messages that a campaign can send to a single
endpoint during a 24-hour period. For an application, this value
specifies the default limit for the number of messages that campaigns
and journeys can send to a single endpoint during a 24-hour period. The
maximum value is 100.
$sel:maximumDuration:CampaignLimits', campaignLimits_maximumDuration - The maximum amount of time, in seconds, that a campaign can attempt to
deliver a message after the scheduled start time for the campaign. The
minimum value is 60 seconds.
$sel:messagesPerSecond:CampaignLimits', campaignLimits_messagesPerSecond - The maximum number of messages that a campaign can send each second. For
an application, this value specifies the default limit for the number of
messages that campaigns can send each second. The minimum value is 50.
The maximum value is 20,000.
$sel:session:CampaignLimits', campaignLimits_session - The maximum total number of messages that the campaign can send per user
session.
$sel:total:CampaignLimits', campaignLimits_total - The maximum number of messages that a campaign can send to a single
endpoint during the course of the campaign. If a campaign recurs, this
setting applies to all runs of the campaign. The maximum value is 100.
campaignLimits_daily :: Lens' CampaignLimits (Maybe Int) Source #
The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
campaignLimits_maximumDuration :: Lens' CampaignLimits (Maybe Int) Source #
The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
campaignLimits_messagesPerSecond :: Lens' CampaignLimits (Maybe Int) Source #
The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.
campaignLimits_session :: Lens' CampaignLimits (Maybe Int) Source #
The maximum total number of messages that the campaign can send per user session.
campaignLimits_total :: Lens' CampaignLimits (Maybe Int) Source #
The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
CampaignResponse
data CampaignResponse Source #
Provides information about the status, configuration, and other settings for a campaign.
See: newCampaignResponse smart constructor.
Constructors
| CampaignResponse' | |
Fields
| |
Instances
Create a value of CampaignResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:additionalTreatments:CampaignResponse', campaignResponse_additionalTreatments - An array of responses, one for each treatment that you defined for the
campaign, in addition to the default treatment.
CampaignResponse, campaignResponse_customDeliveryConfiguration - The delivery configuration settings for sending the campaign through a
custom channel.
$sel:defaultState:CampaignResponse', campaignResponse_defaultState - The current status of the campaign's default treatment. This value
exists only for campaigns that have more than one treatment.
$sel:description:CampaignResponse', campaignResponse_description - The custom description of the campaign.
$sel:holdoutPercent:CampaignResponse', campaignResponse_holdoutPercent - The allocated percentage of users (segment members) who shouldn't
receive messages from the campaign.
$sel:hook:CampaignResponse', campaignResponse_hook - The settings for the AWS Lambda function to use as a code hook for the
campaign. You can use this hook to customize the segment that's used by
the campaign.
$sel:isPaused:CampaignResponse', campaignResponse_isPaused - Specifies whether the campaign is paused. A paused campaign doesn't run
unless you resume it by changing this value to false.
$sel:limits:CampaignResponse', campaignResponse_limits - The messaging limits for the campaign.
CampaignResponse, campaignResponse_messageConfiguration - The message configuration settings for the campaign.
$sel:name:CampaignResponse', campaignResponse_name - The name of the campaign.
$sel:priority:CampaignResponse', campaignResponse_priority - Defines the priority of the campaign, used to decide the order of
messages displayed to user if there are multiple messages scheduled to
be displayed at the same moment.
CampaignResponse, campaignResponse_schedule - The schedule settings for the campaign.
CampaignResponse, campaignResponse_state - The current status of the campaign.
CampaignResponse, campaignResponse_templateConfiguration - The message template that’s used for the campaign.
CampaignResponse, campaignResponse_treatmentDescription - The custom description of the default treatment for the campaign.
CampaignResponse, campaignResponse_treatmentName - The custom name of the default treatment for the campaign, if the
campaign has multiple treatments. A treatment is a variation of a
campaign that's used for A/B testing.
$sel:version:CampaignResponse', campaignResponse_version - The version number of the campaign.
$sel:tags:CampaignResponse', campaignResponse_tags - A string-to-string map of key-value pairs that identifies the tags that
are associated with the campaign. Each tag consists of a required tag
key and an associated tag value.
$sel:lastModifiedDate:CampaignResponse', campaignResponse_lastModifiedDate - The date, in ISO 8601 format, when the campaign was last modified.
$sel:creationDate:CampaignResponse', campaignResponse_creationDate - The date, in ISO 8601 format, when the campaign was created.
$sel:segmentId:CampaignResponse', campaignResponse_segmentId - The unique identifier for the segment that's associated with the
campaign.
$sel:segmentVersion:CampaignResponse', campaignResponse_segmentVersion - The version number of the segment that's associated with the campaign.
CampaignResponse, campaignResponse_id - The unique identifier for the campaign.
$sel:arn:CampaignResponse', campaignResponse_arn - The Amazon Resource Name (ARN) of the campaign.
$sel:applicationId:CampaignResponse', campaignResponse_applicationId - The unique identifier for the application that the campaign applies to.
campaignResponse_additionalTreatments :: Lens' CampaignResponse (Maybe [TreatmentResource]) Source #
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
campaignResponse_customDeliveryConfiguration :: Lens' CampaignResponse (Maybe CustomDeliveryConfiguration) Source #
The delivery configuration settings for sending the campaign through a custom channel.
campaignResponse_defaultState :: Lens' CampaignResponse (Maybe CampaignState) Source #
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
campaignResponse_description :: Lens' CampaignResponse (Maybe Text) Source #
The custom description of the campaign.
campaignResponse_holdoutPercent :: Lens' CampaignResponse (Maybe Int) Source #
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
campaignResponse_hook :: Lens' CampaignResponse (Maybe CampaignHook) Source #
The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
campaignResponse_isPaused :: Lens' CampaignResponse (Maybe Bool) Source #
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
campaignResponse_limits :: Lens' CampaignResponse (Maybe CampaignLimits) Source #
The messaging limits for the campaign.
campaignResponse_messageConfiguration :: Lens' CampaignResponse (Maybe MessageConfiguration) Source #
The message configuration settings for the campaign.
campaignResponse_name :: Lens' CampaignResponse (Maybe Text) Source #
The name of the campaign.
campaignResponse_priority :: Lens' CampaignResponse (Maybe Int) Source #
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
campaignResponse_schedule :: Lens' CampaignResponse (Maybe Schedule) Source #
The schedule settings for the campaign.
campaignResponse_state :: Lens' CampaignResponse (Maybe CampaignState) Source #
The current status of the campaign.
campaignResponse_templateConfiguration :: Lens' CampaignResponse (Maybe TemplateConfiguration) Source #
The message template that’s used for the campaign.
campaignResponse_treatmentDescription :: Lens' CampaignResponse (Maybe Text) Source #
The custom description of the default treatment for the campaign.
campaignResponse_treatmentName :: Lens' CampaignResponse (Maybe Text) Source #
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
campaignResponse_version :: Lens' CampaignResponse (Maybe Int) Source #
The version number of the campaign.
campaignResponse_tags :: Lens' CampaignResponse (Maybe (HashMap Text Text)) Source #
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
campaignResponse_lastModifiedDate :: Lens' CampaignResponse Text Source #
The date, in ISO 8601 format, when the campaign was last modified.
campaignResponse_creationDate :: Lens' CampaignResponse Text Source #
The date, in ISO 8601 format, when the campaign was created.
campaignResponse_segmentId :: Lens' CampaignResponse Text Source #
The unique identifier for the segment that's associated with the campaign.
campaignResponse_segmentVersion :: Lens' CampaignResponse Int Source #
The version number of the segment that's associated with the campaign.
campaignResponse_id :: Lens' CampaignResponse Text Source #
The unique identifier for the campaign.
campaignResponse_arn :: Lens' CampaignResponse Text Source #
The Amazon Resource Name (ARN) of the campaign.
campaignResponse_applicationId :: Lens' CampaignResponse Text Source #
The unique identifier for the application that the campaign applies to.
CampaignSmsMessage
data CampaignSmsMessage Source #
Specifies the content and settings for an SMS message that's sent to recipients of a campaign.
See: newCampaignSmsMessage smart constructor.
Constructors
| CampaignSmsMessage' | |
Fields
| |
Instances
newCampaignSmsMessage :: CampaignSmsMessage Source #
Create a value of CampaignSmsMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:body:CampaignSmsMessage', campaignSmsMessage_body - The body of the SMS message.
$sel:entityId:CampaignSmsMessage', campaignSmsMessage_entityId - The entity ID or Principal Entity (PE) id received from the regulatory
body for sending SMS in your country.
$sel:messageType:CampaignSmsMessage', campaignSmsMessage_messageType - The SMS message type. Valid values are TRANSACTIONAL (for messages that
are critical or time-sensitive, such as a one-time passwords) and
PROMOTIONAL (for messsages that aren't critical or time-sensitive, such
as marketing messages).
$sel:originationNumber:CampaignSmsMessage', campaignSmsMessage_originationNumber - The long code to send the SMS message from. This value should be one of
the dedicated long codes that's assigned to your AWS account. Although
it isn't required, we recommend that you specify the long code using an
E.164 format to ensure prompt and accurate delivery of the message. For
example, +12065550100.
$sel:senderId:CampaignSmsMessage', campaignSmsMessage_senderId - The sender ID to display on recipients' devices when they receive the
SMS message.
$sel:templateId:CampaignSmsMessage', campaignSmsMessage_templateId - The template ID received from the regulatory body for sending SMS in
your country.
campaignSmsMessage_body :: Lens' CampaignSmsMessage (Maybe Text) Source #
The body of the SMS message.
campaignSmsMessage_entityId :: Lens' CampaignSmsMessage (Maybe Text) Source #
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
campaignSmsMessage_messageType :: Lens' CampaignSmsMessage (Maybe MessageType) Source #
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
campaignSmsMessage_originationNumber :: Lens' CampaignSmsMessage (Maybe Text) Source #
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
campaignSmsMessage_senderId :: Lens' CampaignSmsMessage (Maybe Text) Source #
The sender ID to display on recipients' devices when they receive the SMS message.
campaignSmsMessage_templateId :: Lens' CampaignSmsMessage (Maybe Text) Source #
The template ID received from the regulatory body for sending SMS in your country.
CampaignState
data CampaignState Source #
Provides information about the status of a campaign.
See: newCampaignState smart constructor.
Constructors
| CampaignState' | |
Fields
| |
Instances
newCampaignState :: CampaignState Source #
Create a value of CampaignState with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:campaignStatus:CampaignState', campaignState_campaignStatus - The current status of the campaign, or the current status of a treatment
that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
campaignState_campaignStatus :: Lens' CampaignState (Maybe CampaignStatus) Source #
The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
CampaignsResponse
data CampaignsResponse Source #
Provides information about the configuration and other settings for all the campaigns that are associated with an application.
See: newCampaignsResponse smart constructor.
Constructors
| CampaignsResponse' | |
Fields
| |
Instances
newCampaignsResponse :: CampaignsResponse Source #
Create a value of CampaignsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:CampaignsResponse', campaignsResponse_nextToken - The string to use in a subsequent request to get the next page of
results in a paginated response. This value is null if there are no
additional pages.
$sel:item:CampaignsResponse', campaignsResponse_item - An array of responses, one for each campaign that's associated with the
application.
campaignsResponse_nextToken :: Lens' CampaignsResponse (Maybe Text) Source #
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
campaignsResponse_item :: Lens' CampaignsResponse [CampaignResponse] Source #
An array of responses, one for each campaign that's associated with the application.
ChannelResponse
data ChannelResponse Source #
Provides information about the general settings and status of a channel for an application.
See: newChannelResponse smart constructor.
Constructors
| ChannelResponse' | |
Fields
| |
Instances
newChannelResponse :: ChannelResponse Source #
Create a value of ChannelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:ChannelResponse', channelResponse_applicationId - The unique identifier for the application.
$sel:creationDate:ChannelResponse', channelResponse_creationDate - The date and time, in ISO 8601 format, when the channel was enabled.
$sel:enabled:ChannelResponse', channelResponse_enabled - Specifies whether the channel is enabled for the application.
$sel:hasCredential:ChannelResponse', channelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.
$sel:id:ChannelResponse', channelResponse_id - (Deprecated) An identifier for the channel. This property is retained
only for backward compatibility.
$sel:isArchived:ChannelResponse', channelResponse_isArchived - Specifies whether the channel is archived.
$sel:lastModifiedBy:ChannelResponse', channelResponse_lastModifiedBy - The user who last modified the channel.
$sel:lastModifiedDate:ChannelResponse', channelResponse_lastModifiedDate - The date and time, in ISO 8601 format, when the channel was last
modified.
$sel:version:ChannelResponse', channelResponse_version - The current version of the channel.
channelResponse_applicationId :: Lens' ChannelResponse (Maybe Text) Source #
The unique identifier for the application.
channelResponse_creationDate :: Lens' ChannelResponse (Maybe Text) Source #
The date and time, in ISO 8601 format, when the channel was enabled.
channelResponse_enabled :: Lens' ChannelResponse (Maybe Bool) Source #
Specifies whether the channel is enabled for the application.
channelResponse_hasCredential :: Lens' ChannelResponse (Maybe Bool) Source #
(Not used) This property is retained only for backward compatibility.
channelResponse_id :: Lens' ChannelResponse (Maybe Text) Source #
(Deprecated) An identifier for the channel. This property is retained only for backward compatibility.
channelResponse_isArchived :: Lens' ChannelResponse (Maybe Bool) Source #
Specifies whether the channel is archived.
channelResponse_lastModifiedBy :: Lens' ChannelResponse (Maybe Text) Source #
The user who last modified the channel.
channelResponse_lastModifiedDate :: Lens' ChannelResponse (Maybe Text) Source #
The date and time, in ISO 8601 format, when the channel was last modified.
channelResponse_version :: Lens' ChannelResponse (Maybe Int) Source #
The current version of the channel.
ChannelsResponse
data ChannelsResponse Source #
Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.
See: newChannelsResponse smart constructor.
Constructors
| ChannelsResponse' | |
Fields
| |
Instances
newChannelsResponse :: ChannelsResponse Source #
Create a value of ChannelsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channels:ChannelsResponse', channelsResponse_channels - A map that contains a multipart response for each channel. For each item
in this object, the ChannelType is the key and the Channel is the value.
channelsResponse_channels :: Lens' ChannelsResponse (HashMap Text ChannelResponse) Source #
A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value.
ClosedDays
data ClosedDays Source #
The time when journey will stop sending messages.
See: newClosedDays smart constructor.
Constructors
| ClosedDays' | |
Fields
| |
Instances
newClosedDays :: ClosedDays Source #
Create a value of ClosedDays with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:custom:ClosedDays', closedDays_custom - Rules for Custom Channel.
$sel:email:ClosedDays', closedDays_email - Rules for Email Channel.
$sel:push:ClosedDays', closedDays_push - Rules for Push Channel.
$sel:sms:ClosedDays', closedDays_sms - Rules for SMS Channel.
$sel:voice:ClosedDays', closedDays_voice - Rules for Voice Channel.
closedDays_custom :: Lens' ClosedDays (Maybe [ClosedDaysRule]) Source #
Rules for Custom Channel.
closedDays_email :: Lens' ClosedDays (Maybe [ClosedDaysRule]) Source #
Rules for Email Channel.
closedDays_push :: Lens' ClosedDays (Maybe [ClosedDaysRule]) Source #
Rules for Push Channel.
closedDays_sms :: Lens' ClosedDays (Maybe [ClosedDaysRule]) Source #
Rules for SMS Channel.
closedDays_voice :: Lens' ClosedDays (Maybe [ClosedDaysRule]) Source #
Rules for Voice Channel.
ClosedDaysRule
data ClosedDaysRule Source #
Closed Days Rule. Part of Journey sending schedule.
See: newClosedDaysRule smart constructor.
Constructors
| ClosedDaysRule' | |
Fields
| |
Instances
newClosedDaysRule :: ClosedDaysRule Source #
Create a value of ClosedDaysRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endDateTime:ClosedDaysRule', closedDaysRule_endDateTime - End Datetime in ISO 8601 format.
$sel:name:ClosedDaysRule', closedDaysRule_name - Name of the rule.
$sel:startDateTime:ClosedDaysRule', closedDaysRule_startDateTime - Start Datetime in ISO 8601 format.
closedDaysRule_endDateTime :: Lens' ClosedDaysRule (Maybe Text) Source #
End Datetime in ISO 8601 format.
closedDaysRule_name :: Lens' ClosedDaysRule (Maybe Text) Source #
Name of the rule.
closedDaysRule_startDateTime :: Lens' ClosedDaysRule (Maybe Text) Source #
Start Datetime in ISO 8601 format.
Condition
Specifies the conditions to evaluate for an activity in a journey, and how to evaluate those conditions.
See: newCondition smart constructor.
Constructors
| Condition' | |
Fields
| |
Instances
| FromJSON Condition Source # | |
| ToJSON Condition Source # | |
Defined in Amazonka.Pinpoint.Types.Condition | |
| Generic Condition Source # | |
| Read Condition Source # | |
| Show Condition Source # | |
| NFData Condition Source # | |
Defined in Amazonka.Pinpoint.Types.Condition | |
| Eq Condition Source # | |
| Hashable Condition Source # | |
Defined in Amazonka.Pinpoint.Types.Condition | |
| type Rep Condition Source # | |
Defined in Amazonka.Pinpoint.Types.Condition type Rep Condition = D1 ('MetaData "Condition" "Amazonka.Pinpoint.Types.Condition" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "Condition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "conditions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SimpleCondition])) :*: S1 ('MetaSel ('Just "operator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Operator)))) | |
newCondition :: Condition Source #
Create a value of Condition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:conditions:Condition', condition_conditions - The conditions to evaluate for the activity.
$sel:operator:Condition', condition_operator - Specifies how to handle multiple conditions for the activity. For
example, if you specify two conditions for an activity, whether both or
only one of the conditions must be met for the activity to be performed.
condition_conditions :: Lens' Condition (Maybe [SimpleCondition]) Source #
The conditions to evaluate for the activity.
condition_operator :: Lens' Condition (Maybe Operator) Source #
Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
ConditionalSplitActivity
data ConditionalSplitActivity Source #
Specifies the settings for a yes/no split activity in a journey. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
To create yes/no split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.
See: newConditionalSplitActivity smart constructor.
Constructors
| ConditionalSplitActivity' | |
Fields
| |
Instances
newConditionalSplitActivity :: ConditionalSplitActivity Source #
Create a value of ConditionalSplitActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:condition:ConditionalSplitActivity', conditionalSplitActivity_condition - The conditions that define the paths for the activity, and the
relationship between the conditions.
$sel:evaluationWaitTime:ConditionalSplitActivity', conditionalSplitActivity_evaluationWaitTime - The amount of time to wait before determining whether the conditions are
met, or the date and time when Amazon Pinpoint determines whether the
conditions are met.
$sel:falseActivity:ConditionalSplitActivity', conditionalSplitActivity_falseActivity - The unique identifier for the activity to perform if the conditions
aren't met.
$sel:trueActivity:ConditionalSplitActivity', conditionalSplitActivity_trueActivity - The unique identifier for the activity to perform if the conditions are
met.
conditionalSplitActivity_condition :: Lens' ConditionalSplitActivity (Maybe Condition) Source #
The conditions that define the paths for the activity, and the relationship between the conditions.
conditionalSplitActivity_evaluationWaitTime :: Lens' ConditionalSplitActivity (Maybe WaitTime) Source #
The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
conditionalSplitActivity_falseActivity :: Lens' ConditionalSplitActivity (Maybe Text) Source #
The unique identifier for the activity to perform if the conditions aren't met.
conditionalSplitActivity_trueActivity :: Lens' ConditionalSplitActivity (Maybe Text) Source #
The unique identifier for the activity to perform if the conditions are met.
ContactCenterActivity
data ContactCenterActivity Source #
See: newContactCenterActivity smart constructor.
Constructors
| ContactCenterActivity' | |
Fields
| |
Instances
newContactCenterActivity :: ContactCenterActivity Source #
Create a value of ContactCenterActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextActivity:ContactCenterActivity', contactCenterActivity_nextActivity - The unique identifier for the next activity to perform after the this
activity.
contactCenterActivity_nextActivity :: Lens' ContactCenterActivity (Maybe Text) Source #
The unique identifier for the next activity to perform after the this activity.
CreateApplicationRequest
data CreateApplicationRequest Source #
Specifies the display name of an application and the tags to associate with the application.
See: newCreateApplicationRequest smart constructor.
Constructors
| CreateApplicationRequest' | |
Fields
| |
Instances
newCreateApplicationRequest Source #
Create a value of CreateApplicationRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateApplicationRequest', createApplicationRequest_tags - A string-to-string map of key-value pairs that defines the tags to
associate with the application. Each tag consists of a required tag key
and an associated tag value.
$sel:name:CreateApplicationRequest', createApplicationRequest_name - The display name of the application. This name is displayed as the
Project name on the Amazon Pinpoint console.
createApplicationRequest_tags :: Lens' CreateApplicationRequest (Maybe (HashMap Text Text)) Source #
A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.
createApplicationRequest_name :: Lens' CreateApplicationRequest Text Source #
The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
CreateRecommenderConfiguration
data CreateRecommenderConfiguration Source #
Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
See: newCreateRecommenderConfiguration smart constructor.
Constructors
| CreateRecommenderConfiguration' | |
Fields
| |
Instances
newCreateRecommenderConfiguration Source #
Arguments
| :: Text |
|
| -> Text |
|
| -> CreateRecommenderConfiguration |
Create a value of CreateRecommenderConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:CreateRecommenderConfiguration', createRecommenderConfiguration_attributes - A map of key-value pairs that defines 1-10 custom endpoint or user
attributes, depending on the value for the RecommendationProviderIdType
property. Each of these attributes temporarily stores a recommended item
that's retrieved from the recommender model and sent to an AWS Lambda
function for additional processing. Each attribute can be used as a
message variable in a message template.
In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:
- An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
- An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.
$sel:description:CreateRecommenderConfiguration', createRecommenderConfiguration_description - A custom description of the configuration for the recommender model. The
description can contain up to 128 characters. The characters can be
letters, numbers, spaces, or the following symbols: _ ; () , ‐.
$sel:name:CreateRecommenderConfiguration', createRecommenderConfiguration_name - A custom name of the configuration for the recommender model. The name
must start with a letter or number and it can contain up to 128
characters. The characters can be letters, numbers, spaces, underscores
(_), or hyphens (-).
$sel:recommendationProviderIdType:CreateRecommenderConfiguration', createRecommenderConfiguration_recommendationProviderIdType - The type of Amazon Pinpoint ID to associate with unique user IDs in the
recommender model. This value enables the model to use attribute and
event data that’s specific to a particular endpoint or user in an Amazon
Pinpoint application. Valid values are:
- PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
- PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
$sel:recommendationTransformerUri:CreateRecommenderConfiguration', createRecommenderConfiguration_recommendationTransformerUri - The name or Amazon Resource Name (ARN) of the AWS Lambda function to
invoke for additional processing of recommendation data that's
retrieved from the recommender model.
$sel:recommendationsDisplayName:CreateRecommenderConfiguration', createRecommenderConfiguration_recommendationsDisplayName - A custom display name for the standard endpoint or user attribute
(RecommendationItems) that temporarily stores recommended items for each
endpoint or user, depending on the value for the
RecommendationProviderIdType property. This value is required if the
configuration doesn't invoke an AWS Lambda function
(RecommendationTransformerUri) to perform additional processing of
recommendation data.
This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.
$sel:recommendationsPerMessage:CreateRecommenderConfiguration', createRecommenderConfiguration_recommendationsPerMessage - The number of recommended items to retrieve from the model for each
endpoint or user, depending on the value for the
RecommendationProviderIdType property. This number determines how many
recommended items are available for use in message variables. The
minimum value is 1. The maximum value is 5. The default value is 5.
To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
$sel:recommendationProviderUri:CreateRecommenderConfiguration', createRecommenderConfiguration_recommendationProviderUri - The Amazon Resource Name (ARN) of the recommender model to retrieve
recommendation data from. This value must match the ARN of an Amazon
Personalize campaign.
$sel:recommendationProviderRoleArn:CreateRecommenderConfiguration', createRecommenderConfiguration_recommendationProviderRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that authorizes Amazon Pinpoint to retrieve recommendation
data from the recommender model.
createRecommenderConfiguration_attributes :: Lens' CreateRecommenderConfiguration (Maybe (HashMap Text Text)) Source #
A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:
- An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
- An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.
createRecommenderConfiguration_description :: Lens' CreateRecommenderConfiguration (Maybe Text) Source #
A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.
createRecommenderConfiguration_name :: Lens' CreateRecommenderConfiguration (Maybe Text) Source #
A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
createRecommenderConfiguration_recommendationProviderIdType :: Lens' CreateRecommenderConfiguration (Maybe Text) Source #
The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:
- PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
- PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
createRecommenderConfiguration_recommendationTransformerUri :: Lens' CreateRecommenderConfiguration (Maybe Text) Source #
The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.
createRecommenderConfiguration_recommendationsDisplayName :: Lens' CreateRecommenderConfiguration (Maybe Text) Source #
A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.
createRecommenderConfiguration_recommendationsPerMessage :: Lens' CreateRecommenderConfiguration (Maybe Int) Source #
The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.
To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
createRecommenderConfiguration_recommendationProviderUri :: Lens' CreateRecommenderConfiguration Text Source #
The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.
createRecommenderConfiguration_recommendationProviderRoleArn :: Lens' CreateRecommenderConfiguration Text Source #
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
CreateTemplateMessageBody
data CreateTemplateMessageBody Source #
Provides information about a request to create a message template.
See: newCreateTemplateMessageBody smart constructor.
Constructors
| CreateTemplateMessageBody' | |
Instances
newCreateTemplateMessageBody :: CreateTemplateMessageBody Source #
Create a value of CreateTemplateMessageBody with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:CreateTemplateMessageBody', createTemplateMessageBody_arn - The Amazon Resource Name (ARN) of the message template that was created.
$sel:message:CreateTemplateMessageBody', createTemplateMessageBody_message - The message that's returned from the API for the request to create the
message template.
$sel:requestID:CreateTemplateMessageBody', createTemplateMessageBody_requestID - The unique identifier for the request to create the message template.
createTemplateMessageBody_arn :: Lens' CreateTemplateMessageBody (Maybe Text) Source #
The Amazon Resource Name (ARN) of the message template that was created.
createTemplateMessageBody_message :: Lens' CreateTemplateMessageBody (Maybe Text) Source #
The message that's returned from the API for the request to create the message template.
createTemplateMessageBody_requestID :: Lens' CreateTemplateMessageBody (Maybe Text) Source #
The unique identifier for the request to create the message template.
CustomDeliveryConfiguration
data CustomDeliveryConfiguration Source #
Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. This object is required if you use the CampaignCustomMessage object to define the message to send for the campaign or campaign treatment.
See: newCustomDeliveryConfiguration smart constructor.
Constructors
| CustomDeliveryConfiguration' | |
Fields
| |
Instances
newCustomDeliveryConfiguration Source #
Create a value of CustomDeliveryConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointTypes:CustomDeliveryConfiguration', customDeliveryConfiguration_endpointTypes - The types of endpoints to send the campaign or treatment to. Each valid
value maps to a type of channel that you can associate with an endpoint
by using the ChannelType property of an endpoint.
$sel:deliveryUri:CustomDeliveryConfiguration', customDeliveryConfiguration_deliveryUri - The destination to send the campaign or treatment to. This value can be
one of the following:
- The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
- The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
customDeliveryConfiguration_endpointTypes :: Lens' CustomDeliveryConfiguration (Maybe [EndpointTypesElement]) Source #
The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
customDeliveryConfiguration_deliveryUri :: Lens' CustomDeliveryConfiguration Text Source #
The destination to send the campaign or treatment to. This value can be one of the following:
- The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
- The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
CustomMessageActivity
data CustomMessageActivity Source #
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
See: newCustomMessageActivity smart constructor.
Constructors
| CustomMessageActivity' | |
Fields
| |
Instances
newCustomMessageActivity :: CustomMessageActivity Source #
Create a value of CustomMessageActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deliveryUri:CustomMessageActivity', customMessageActivity_deliveryUri - The destination to send the campaign or treatment to. This value can be
one of the following:
- The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
- The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
$sel:endpointTypes:CustomMessageActivity', customMessageActivity_endpointTypes - The types of endpoints to send the custom message to. Each valid value
maps to a type of channel that you can associate with an endpoint by
using the ChannelType property of an endpoint.
$sel:messageConfig:CustomMessageActivity', customMessageActivity_messageConfig - Specifies the message data included in a custom channel message that's
sent to participants in a journey.
$sel:nextActivity:CustomMessageActivity', customMessageActivity_nextActivity - The unique identifier for the next activity to perform, after Amazon
Pinpoint calls the AWS Lambda function or web hook.
$sel:templateName:CustomMessageActivity', customMessageActivity_templateName - The name of the custom message template to use for the message. If
specified, this value must match the name of an existing message
template.
$sel:templateVersion:CustomMessageActivity', customMessageActivity_templateVersion - The unique identifier for the version of the message template to use for
the message. If specified, this value must match the identifier for an
existing template version. To retrieve a list of versions and version
identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
customMessageActivity_deliveryUri :: Lens' CustomMessageActivity (Maybe Text) Source #
The destination to send the campaign or treatment to. This value can be one of the following:
- The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
- The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
customMessageActivity_endpointTypes :: Lens' CustomMessageActivity (Maybe [EndpointTypesElement]) Source #
The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
customMessageActivity_messageConfig :: Lens' CustomMessageActivity (Maybe JourneyCustomMessage) Source #
Specifies the message data included in a custom channel message that's sent to participants in a journey.
customMessageActivity_nextActivity :: Lens' CustomMessageActivity (Maybe Text) Source #
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
customMessageActivity_templateName :: Lens' CustomMessageActivity (Maybe Text) Source #
The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
customMessageActivity_templateVersion :: Lens' CustomMessageActivity (Maybe Text) Source #
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
DefaultButtonConfiguration
data DefaultButtonConfiguration Source #
Default button configuration.
See: newDefaultButtonConfiguration smart constructor.
Constructors
| DefaultButtonConfiguration' | |
Fields
| |
Instances
newDefaultButtonConfiguration Source #
Arguments
| :: ButtonAction | |
| -> Text | |
| -> DefaultButtonConfiguration |
Create a value of DefaultButtonConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backgroundColor:DefaultButtonConfiguration', defaultButtonConfiguration_backgroundColor - The background color of the button.
$sel:borderRadius:DefaultButtonConfiguration', defaultButtonConfiguration_borderRadius - The border radius of the button.
$sel:link:DefaultButtonConfiguration', defaultButtonConfiguration_link - Button destination.
$sel:textColor:DefaultButtonConfiguration', defaultButtonConfiguration_textColor - The text color of the button.
$sel:buttonAction:DefaultButtonConfiguration', defaultButtonConfiguration_buttonAction - Action triggered by the button.
$sel:text:DefaultButtonConfiguration', defaultButtonConfiguration_text - Button text.
defaultButtonConfiguration_backgroundColor :: Lens' DefaultButtonConfiguration (Maybe Text) Source #
The background color of the button.
defaultButtonConfiguration_borderRadius :: Lens' DefaultButtonConfiguration (Maybe Int) Source #
The border radius of the button.
defaultButtonConfiguration_link :: Lens' DefaultButtonConfiguration (Maybe Text) Source #
Button destination.
defaultButtonConfiguration_textColor :: Lens' DefaultButtonConfiguration (Maybe Text) Source #
The text color of the button.
defaultButtonConfiguration_buttonAction :: Lens' DefaultButtonConfiguration ButtonAction Source #
Action triggered by the button.
defaultButtonConfiguration_text :: Lens' DefaultButtonConfiguration Text Source #
Button text.
DefaultMessage
data DefaultMessage Source #
Specifies the default message for all channels.
See: newDefaultMessage smart constructor.
Constructors
| DefaultMessage' | |
Instances
newDefaultMessage :: DefaultMessage Source #
Create a value of DefaultMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:body:DefaultMessage', defaultMessage_body - The default body of the message.
$sel:substitutions:DefaultMessage', defaultMessage_substitutions - The default message variables to use in the message. You can override
these default variables with individual address variables.
defaultMessage_body :: Lens' DefaultMessage (Maybe Text) Source #
The default body of the message.
defaultMessage_substitutions :: Lens' DefaultMessage (Maybe (HashMap Text [Text])) Source #
The default message variables to use in the message. You can override these default variables with individual address variables.
DefaultPushNotificationMessage
data DefaultPushNotificationMessage Source #
Specifies the default settings and content for a push notification that's sent directly to an endpoint.
See: newDefaultPushNotificationMessage smart constructor.
Constructors
| DefaultPushNotificationMessage' | |
Fields
| |
Instances
newDefaultPushNotificationMessage :: DefaultPushNotificationMessage Source #
Create a value of DefaultPushNotificationMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:DefaultPushNotificationMessage', defaultPushNotificationMessage_action - The default action to occur if a recipient taps the push notification.
Valid values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
$sel:body:DefaultPushNotificationMessage', defaultPushNotificationMessage_body - The default body of the notification message.
$sel:data':DefaultPushNotificationMessage', defaultPushNotificationMessage_data - The JSON data payload to use for the default push notification, if the
notification is a silent push notification. This payload is added to the
data.pinpoint.jsonBody object of the notification.
$sel:silentPush:DefaultPushNotificationMessage', defaultPushNotificationMessage_silentPush - Specifies whether the default notification is a silent push
notification, which is a push notification that doesn't display on a
recipient's device. Silent push notifications can be used for cases
such as updating an app's configuration or delivering messages to an
in-app notification center.
$sel:substitutions:DefaultPushNotificationMessage', defaultPushNotificationMessage_substitutions - The default message variables to use in the notification message. You
can override the default variables with individual address variables.
$sel:title:DefaultPushNotificationMessage', defaultPushNotificationMessage_title - The default title to display above the notification message on a
recipient's device.
$sel:url:DefaultPushNotificationMessage', defaultPushNotificationMessage_url - The default URL to open in a recipient's default mobile browser, if a
recipient taps the push notification and the value of the Action
property is URL.
defaultPushNotificationMessage_action :: Lens' DefaultPushNotificationMessage (Maybe Action) Source #
The default action to occur if a recipient taps the push notification. Valid values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
defaultPushNotificationMessage_body :: Lens' DefaultPushNotificationMessage (Maybe Text) Source #
The default body of the notification message.
defaultPushNotificationMessage_data :: Lens' DefaultPushNotificationMessage (Maybe (HashMap Text Text)) Source #
The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
defaultPushNotificationMessage_silentPush :: Lens' DefaultPushNotificationMessage (Maybe Bool) Source #
Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
defaultPushNotificationMessage_substitutions :: Lens' DefaultPushNotificationMessage (Maybe (HashMap Text [Text])) Source #
The default message variables to use in the notification message. You can override the default variables with individual address variables.
defaultPushNotificationMessage_title :: Lens' DefaultPushNotificationMessage (Maybe Text) Source #
The default title to display above the notification message on a recipient's device.
defaultPushNotificationMessage_url :: Lens' DefaultPushNotificationMessage (Maybe Text) Source #
The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
DefaultPushNotificationTemplate
data DefaultPushNotificationTemplate Source #
Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.
See: newDefaultPushNotificationTemplate smart constructor.
Constructors
| DefaultPushNotificationTemplate' | |
Fields
| |
Instances
newDefaultPushNotificationTemplate :: DefaultPushNotificationTemplate Source #
Create a value of DefaultPushNotificationTemplate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:DefaultPushNotificationTemplate', defaultPushNotificationTemplate_action - The action to occur if a recipient taps a push notification that's
based on the message template. Valid values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
$sel:body:DefaultPushNotificationTemplate', defaultPushNotificationTemplate_body - The message body to use in push notifications that are based on the
message template.
$sel:sound:DefaultPushNotificationTemplate', defaultPushNotificationTemplate_sound - The sound to play when a recipient receives a push notification that's
based on the message template. You can use the default stream or specify
the file name of a sound resource that's bundled in your app. On an
Android platform, the sound file must reside in /res/raw/.
For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
$sel:title:DefaultPushNotificationTemplate', defaultPushNotificationTemplate_title - The title to use in push notifications that are based on the message
template. This title appears above the notification message on a
recipient's device.
$sel:url:DefaultPushNotificationTemplate', defaultPushNotificationTemplate_url - The URL to open in a recipient's default mobile browser, if a recipient
taps a push notification that's based on the message template and the
value of the Action property is URL.
defaultPushNotificationTemplate_action :: Lens' DefaultPushNotificationTemplate (Maybe Action) Source #
The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
defaultPushNotificationTemplate_body :: Lens' DefaultPushNotificationTemplate (Maybe Text) Source #
The message body to use in push notifications that are based on the message template.
defaultPushNotificationTemplate_sound :: Lens' DefaultPushNotificationTemplate (Maybe Text) Source #
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
defaultPushNotificationTemplate_title :: Lens' DefaultPushNotificationTemplate (Maybe Text) Source #
The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
defaultPushNotificationTemplate_url :: Lens' DefaultPushNotificationTemplate (Maybe Text) Source #
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
DirectMessageConfiguration
data DirectMessageConfiguration Source #
Specifies the settings and content for the default message and any default messages that you tailored for specific channels.
See: newDirectMessageConfiguration smart constructor.
Constructors
| DirectMessageConfiguration' | |
Fields
| |
Instances
newDirectMessageConfiguration :: DirectMessageConfiguration Source #
Create a value of DirectMessageConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aDMMessage:DirectMessageConfiguration', directMessageConfiguration_aDMMessage - The default push notification message for the ADM (Amazon Device
Messaging) channel. This message overrides the default push notification
message (DefaultPushNotificationMessage).
$sel:aPNSMessage:DirectMessageConfiguration', directMessageConfiguration_aPNSMessage - The default push notification message for the APNs (Apple Push
Notification service) channel. This message overrides the default push
notification message (DefaultPushNotificationMessage).
$sel:baiduMessage:DirectMessageConfiguration', directMessageConfiguration_baiduMessage - The default push notification message for the Baidu (Baidu Cloud Push)
channel. This message overrides the default push notification message
(DefaultPushNotificationMessage).
$sel:defaultMessage:DirectMessageConfiguration', directMessageConfiguration_defaultMessage - The default message for all channels.
$sel:defaultPushNotificationMessage:DirectMessageConfiguration', directMessageConfiguration_defaultPushNotificationMessage - The default push notification message for all push notification
channels.
$sel:emailMessage:DirectMessageConfiguration', directMessageConfiguration_emailMessage - The default message for the email channel. This message overrides the
default message (DefaultMessage).
$sel:gCMMessage:DirectMessageConfiguration', directMessageConfiguration_gCMMessage - The default push notification message for the GCM channel, which is used
to send notifications through the Firebase Cloud Messaging (FCM),
formerly Google Cloud Messaging (GCM), service. This message overrides
the default push notification message (DefaultPushNotificationMessage).
$sel:sMSMessage:DirectMessageConfiguration', directMessageConfiguration_sMSMessage - The default message for the SMS channel. This message overrides the
default message (DefaultMessage).
$sel:voiceMessage:DirectMessageConfiguration', directMessageConfiguration_voiceMessage - The default message for the voice channel. This message overrides the
default message (DefaultMessage).
directMessageConfiguration_aDMMessage :: Lens' DirectMessageConfiguration (Maybe ADMMessage) Source #
The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
directMessageConfiguration_aPNSMessage :: Lens' DirectMessageConfiguration (Maybe APNSMessage) Source #
The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
directMessageConfiguration_baiduMessage :: Lens' DirectMessageConfiguration (Maybe BaiduMessage) Source #
The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
directMessageConfiguration_defaultMessage :: Lens' DirectMessageConfiguration (Maybe DefaultMessage) Source #
The default message for all channels.
directMessageConfiguration_defaultPushNotificationMessage :: Lens' DirectMessageConfiguration (Maybe DefaultPushNotificationMessage) Source #
The default push notification message for all push notification channels.
directMessageConfiguration_emailMessage :: Lens' DirectMessageConfiguration (Maybe EmailMessage) Source #
The default message for the email channel. This message overrides the default message (DefaultMessage).
directMessageConfiguration_gCMMessage :: Lens' DirectMessageConfiguration (Maybe GCMMessage) Source #
The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage).
directMessageConfiguration_sMSMessage :: Lens' DirectMessageConfiguration (Maybe SMSMessage) Source #
The default message for the SMS channel. This message overrides the default message (DefaultMessage).
directMessageConfiguration_voiceMessage :: Lens' DirectMessageConfiguration (Maybe VoiceMessage) Source #
The default message for the voice channel. This message overrides the default message (DefaultMessage).
EmailChannelRequest
data EmailChannelRequest Source #
Specifies the status and settings of the email channel for an application.
See: newEmailChannelRequest smart constructor.
Constructors
| EmailChannelRequest' | |
Fields
| |
Instances
newEmailChannelRequest Source #
Arguments
| :: Text | |
| -> Text | |
| -> EmailChannelRequest |
Create a value of EmailChannelRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurationSet:EmailChannelRequest', emailChannelRequest_configurationSet - The
Amazon SES configuration set
that you want to apply to messages that you send through the channel.
$sel:enabled:EmailChannelRequest', emailChannelRequest_enabled - Specifies whether to enable the email channel for the application.
$sel:roleArn:EmailChannelRequest', emailChannelRequest_roleArn - The ARN of the AWS Identity and Access Management (IAM) role that you
want Amazon Pinpoint to use when it submits email-related event data for
the channel.
$sel:fromAddress:EmailChannelRequest', emailChannelRequest_fromAddress - The verified email address that you want to send email from when you
send email through the channel.
$sel:identity:EmailChannelRequest', emailChannelRequest_identity - The Amazon Resource Name (ARN) of the identity, verified with Amazon
Simple Email Service (Amazon SES), that you want to use when you send
email through the channel.
emailChannelRequest_configurationSet :: Lens' EmailChannelRequest (Maybe Text) Source #
The Amazon SES configuration set that you want to apply to messages that you send through the channel.
emailChannelRequest_enabled :: Lens' EmailChannelRequest (Maybe Bool) Source #
Specifies whether to enable the email channel for the application.
emailChannelRequest_roleArn :: Lens' EmailChannelRequest (Maybe Text) Source #
The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.
emailChannelRequest_fromAddress :: Lens' EmailChannelRequest Text Source #
The verified email address that you want to send email from when you send email through the channel.
emailChannelRequest_identity :: Lens' EmailChannelRequest Text Source #
The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.
EmailChannelResponse
data EmailChannelResponse Source #
Provides information about the status and settings of the email channel for an application.
See: newEmailChannelResponse smart constructor.
Constructors
| EmailChannelResponse' | |
Fields
| |
Instances
newEmailChannelResponse Source #
Arguments
| :: Text | |
| -> EmailChannelResponse |
Create a value of EmailChannelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:EmailChannelResponse', emailChannelResponse_applicationId - The unique identifier for the application that the email channel applies
to.
$sel:configurationSet:EmailChannelResponse', emailChannelResponse_configurationSet - The
Amazon SES configuration set
that's applied to messages that are sent through the channel.
$sel:creationDate:EmailChannelResponse', emailChannelResponse_creationDate - The date and time, in ISO 8601 format, when the email channel was
enabled.
$sel:enabled:EmailChannelResponse', emailChannelResponse_enabled - Specifies whether the email channel is enabled for the application.
$sel:fromAddress:EmailChannelResponse', emailChannelResponse_fromAddress - The verified email address that email is sent from when you send email
through the channel.
$sel:hasCredential:EmailChannelResponse', emailChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.
$sel:id:EmailChannelResponse', emailChannelResponse_id - (Deprecated) An identifier for the email channel. This property is
retained only for backward compatibility.
$sel:identity:EmailChannelResponse', emailChannelResponse_identity - The Amazon Resource Name (ARN) of the identity, verified with Amazon
Simple Email Service (Amazon SES), that's used when you send email
through the channel.
$sel:isArchived:EmailChannelResponse', emailChannelResponse_isArchived - Specifies whether the email channel is archived.
$sel:lastModifiedBy:EmailChannelResponse', emailChannelResponse_lastModifiedBy - The user who last modified the email channel.
$sel:lastModifiedDate:EmailChannelResponse', emailChannelResponse_lastModifiedDate - The date and time, in ISO 8601 format, when the email channel was last
modified.
$sel:messagesPerSecond:EmailChannelResponse', emailChannelResponse_messagesPerSecond - The maximum number of emails that can be sent through the channel each
second.
$sel:roleArn:EmailChannelResponse', emailChannelResponse_roleArn - The ARN of the AWS Identity and Access Management (IAM) role that Amazon
Pinpoint uses to submit email-related event data for the channel.
$sel:version:EmailChannelResponse', emailChannelResponse_version - The current version of the email channel.
$sel:platform:EmailChannelResponse', emailChannelResponse_platform - The type of messaging or notification platform for the channel. For the
email channel, this value is EMAIL.
emailChannelResponse_applicationId :: Lens' EmailChannelResponse (Maybe Text) Source #
The unique identifier for the application that the email channel applies to.
emailChannelResponse_configurationSet :: Lens' EmailChannelResponse (Maybe Text) Source #
The Amazon SES configuration set that's applied to messages that are sent through the channel.
emailChannelResponse_creationDate :: Lens' EmailChannelResponse (Maybe Text) Source #
The date and time, in ISO 8601 format, when the email channel was enabled.
emailChannelResponse_enabled :: Lens' EmailChannelResponse (Maybe Bool) Source #
Specifies whether the email channel is enabled for the application.
emailChannelResponse_fromAddress :: Lens' EmailChannelResponse (Maybe Text) Source #
The verified email address that email is sent from when you send email through the channel.
emailChannelResponse_hasCredential :: Lens' EmailChannelResponse (Maybe Bool) Source #
(Not used) This property is retained only for backward compatibility.
emailChannelResponse_id :: Lens' EmailChannelResponse (Maybe Text) Source #
(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
emailChannelResponse_identity :: Lens' EmailChannelResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.
emailChannelResponse_isArchived :: Lens' EmailChannelResponse (Maybe Bool) Source #
Specifies whether the email channel is archived.
emailChannelResponse_lastModifiedBy :: Lens' EmailChannelResponse (Maybe Text) Source #
The user who last modified the email channel.
emailChannelResponse_lastModifiedDate :: Lens' EmailChannelResponse (Maybe Text) Source #
The date and time, in ISO 8601 format, when the email channel was last modified.
emailChannelResponse_messagesPerSecond :: Lens' EmailChannelResponse (Maybe Int) Source #
The maximum number of emails that can be sent through the channel each second.
emailChannelResponse_roleArn :: Lens' EmailChannelResponse (Maybe Text) Source #
The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
emailChannelResponse_version :: Lens' EmailChannelResponse (Maybe Int) Source #
The current version of the email channel.
emailChannelResponse_platform :: Lens' EmailChannelResponse Text Source #
The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
EmailMessage
data EmailMessage Source #
Specifies the default settings and content for a one-time email message that's sent directly to an endpoint.
See: newEmailMessage smart constructor.
Constructors
| EmailMessage' | |
Fields
| |
Instances
newEmailMessage :: EmailMessage Source #
Create a value of EmailMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:body:EmailMessage', emailMessage_body - The body of the email message.
$sel:feedbackForwardingAddress:EmailMessage', emailMessage_feedbackForwardingAddress - The email address to forward bounces and complaints to, if feedback
forwarding is enabled.
$sel:fromAddress:EmailMessage', emailMessage_fromAddress - The verified email address to send the email message from. The default
value is the FromAddress specified for the email channel.
$sel:rawEmail:EmailMessage', emailMessage_rawEmail - The email message, represented as a raw MIME message.
$sel:replyToAddresses:EmailMessage', emailMessage_replyToAddresses - The reply-to email address(es) for the email message. If a recipient
replies to the email, each reply-to address receives the reply.
$sel:simpleEmail:EmailMessage', emailMessage_simpleEmail - The email message, composed of a subject, a text part, and an HTML part.
$sel:substitutions:EmailMessage', emailMessage_substitutions - The default message variables to use in the email message. You can
override the default variables with individual address variables.
emailMessage_body :: Lens' EmailMessage (Maybe Text) Source #
The body of the email message.
emailMessage_feedbackForwardingAddress :: Lens' EmailMessage (Maybe Text) Source #
The email address to forward bounces and complaints to, if feedback forwarding is enabled.
emailMessage_fromAddress :: Lens' EmailMessage (Maybe Text) Source #
The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.
emailMessage_rawEmail :: Lens' EmailMessage (Maybe RawEmail) Source #
The email message, represented as a raw MIME message.
emailMessage_replyToAddresses :: Lens' EmailMessage (Maybe [Text]) Source #
The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.
emailMessage_simpleEmail :: Lens' EmailMessage (Maybe SimpleEmail) Source #
The email message, composed of a subject, a text part, and an HTML part.
emailMessage_substitutions :: Lens' EmailMessage (Maybe (HashMap Text [Text])) Source #
The default message variables to use in the email message. You can override the default variables with individual address variables.
EmailMessageActivity
data EmailMessageActivity Source #
Specifies the settings for an email activity in a journey. This type of activity sends an email message to participants.
See: newEmailMessageActivity smart constructor.
Constructors
| EmailMessageActivity' | |
Fields
| |
Instances
newEmailMessageActivity :: EmailMessageActivity Source #
Create a value of EmailMessageActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:messageConfig:EmailMessageActivity', emailMessageActivity_messageConfig - Specifies the sender address for an email message that's sent to
participants in the journey.
$sel:nextActivity:EmailMessageActivity', emailMessageActivity_nextActivity - The unique identifier for the next activity to perform, after the
message is sent.
$sel:templateName:EmailMessageActivity', emailMessageActivity_templateName - The name of the email message template to use for the message. If
specified, this value must match the name of an existing message
template.
$sel:templateVersion:EmailMessageActivity', emailMessageActivity_templateVersion - The unique identifier for the version of the email template to use for
the message. If specified, this value must match the identifier for an
existing template version. To retrieve a list of versions and version
identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
emailMessageActivity_messageConfig :: Lens' EmailMessageActivity (Maybe JourneyEmailMessage) Source #
Specifies the sender address for an email message that's sent to participants in the journey.
emailMessageActivity_nextActivity :: Lens' EmailMessageActivity (Maybe Text) Source #
The unique identifier for the next activity to perform, after the message is sent.
emailMessageActivity_templateName :: Lens' EmailMessageActivity (Maybe Text) Source #
The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
emailMessageActivity_templateVersion :: Lens' EmailMessageActivity (Maybe Text) Source #
The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
EmailTemplateRequest
data EmailTemplateRequest Source #
Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.
See: newEmailTemplateRequest smart constructor.
Constructors
| EmailTemplateRequest' | |
Fields
| |
Instances
newEmailTemplateRequest :: EmailTemplateRequest Source #
Create a value of EmailTemplateRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultSubstitutions:EmailTemplateRequest', emailTemplateRequest_defaultSubstitutions - A JSON object that specifies the default values to use for message
variables in the message template. This object is a set of key-value
pairs. Each key defines a message variable in the template. The
corresponding value defines the default value for that variable. When
you create a message that's based on the template, you can override
these defaults with message-specific and address-specific variables and
values.
$sel:htmlPart:EmailTemplateRequest', emailTemplateRequest_htmlPart - The message body, in HTML format, to use in email messages that are
based on the message template. We recommend using HTML format for email
clients that render HTML content. You can include links, formatted text,
and more in an HTML message.
$sel:recommenderId:EmailTemplateRequest', emailTemplateRequest_recommenderId - The unique identifier for the recommender model to use for the message
template. Amazon Pinpoint uses this value to determine how to retrieve
and process data from a recommender model when it sends messages that
use the template, if the template contains message variables for
recommendation data.
$sel:subject:EmailTemplateRequest', emailTemplateRequest_subject - The subject line, or title, to use in email messages that are based on
the message template.
$sel:templateDescription:EmailTemplateRequest', emailTemplateRequest_templateDescription - A custom description of the message template.
$sel:textPart:EmailTemplateRequest', emailTemplateRequest_textPart - The message body, in plain text format, to use in email messages that
are based on the message template. We recommend using plain text format
for email clients that don't render HTML content and clients that are
connected to high-latency networks, such as mobile devices.
$sel:tags:EmailTemplateRequest', emailTemplateRequest_tags - A string-to-string map of key-value pairs that defines the tags to
associate with the message template. Each tag consists of a required tag
key and an associated tag value.
emailTemplateRequest_defaultSubstitutions :: Lens' EmailTemplateRequest (Maybe Text) Source #
A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
emailTemplateRequest_htmlPart :: Lens' EmailTemplateRequest (Maybe Text) Source #
The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
emailTemplateRequest_recommenderId :: Lens' EmailTemplateRequest (Maybe Text) Source #
The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
emailTemplateRequest_subject :: Lens' EmailTemplateRequest (Maybe Text) Source #
The subject line, or title, to use in email messages that are based on the message template.
emailTemplateRequest_templateDescription :: Lens' EmailTemplateRequest (Maybe Text) Source #
A custom description of the message template.
emailTemplateRequest_textPart :: Lens' EmailTemplateRequest (Maybe Text) Source #
The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
emailTemplateRequest_tags :: Lens' EmailTemplateRequest (Maybe (HashMap Text Text)) Source #
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
EmailTemplateResponse
data EmailTemplateResponse Source #
Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.
See: newEmailTemplateResponse smart constructor.
Constructors
| EmailTemplateResponse' | |
Fields
| |
Instances
newEmailTemplateResponse Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> TemplateType | |
| -> EmailTemplateResponse |
Create a value of EmailTemplateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:EmailTemplateResponse', emailTemplateResponse_arn - The Amazon Resource Name (ARN) of the message template.
$sel:defaultSubstitutions:EmailTemplateResponse', emailTemplateResponse_defaultSubstitutions - The JSON object that specifies the default values that are used for
message variables in the message template. This object is a set of
key-value pairs. Each key defines a message variable in the template.
The corresponding value defines the default value for that variable.
$sel:htmlPart:EmailTemplateResponse', emailTemplateResponse_htmlPart - The message body, in HTML format, that's used in email messages that
are based on the message template.
$sel:recommenderId:EmailTemplateResponse', emailTemplateResponse_recommenderId - The unique identifier for the recommender model that's used by the
message template.
$sel:subject:EmailTemplateResponse', emailTemplateResponse_subject - The subject line, or title, that's used in email messages that are
based on the message template.
$sel:templateDescription:EmailTemplateResponse', emailTemplateResponse_templateDescription - The custom description of the message template.
$sel:textPart:EmailTemplateResponse', emailTemplateResponse_textPart - The message body, in plain text format, that's used in email messages
that are based on the message template.
$sel:version:EmailTemplateResponse', emailTemplateResponse_version - The unique identifier, as an integer, for the active version of the
message template, or the version of the template that you specified by
using the version parameter in your request.
$sel:tags:EmailTemplateResponse', emailTemplateResponse_tags - A string-to-string map of key-value pairs that identifies the tags that
are associated with the message template. Each tag consists of a
required tag key and an associated tag value.
$sel:lastModifiedDate:EmailTemplateResponse', emailTemplateResponse_lastModifiedDate - The date, in ISO 8601 format, when the message template was last
modified.
$sel:creationDate:EmailTemplateResponse', emailTemplateResponse_creationDate - The date, in ISO 8601 format, when the message template was created.
$sel:templateName:EmailTemplateResponse', emailTemplateResponse_templateName - The name of the message template.
$sel:templateType:EmailTemplateResponse', emailTemplateResponse_templateType - The type of channel that the message template is designed for. For an
email template, this value is EMAIL.
emailTemplateResponse_arn :: Lens' EmailTemplateResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the message template.
emailTemplateResponse_defaultSubstitutions :: Lens' EmailTemplateResponse (Maybe Text) Source #
The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
emailTemplateResponse_htmlPart :: Lens' EmailTemplateResponse (Maybe Text) Source #
The message body, in HTML format, that's used in email messages that are based on the message template.
emailTemplateResponse_recommenderId :: Lens' EmailTemplateResponse (Maybe Text) Source #
The unique identifier for the recommender model that's used by the message template.
emailTemplateResponse_subject :: Lens' EmailTemplateResponse (Maybe Text) Source #
The subject line, or title, that's used in email messages that are based on the message template.
emailTemplateResponse_templateDescription :: Lens' EmailTemplateResponse (Maybe Text) Source #
The custom description of the message template.
emailTemplateResponse_textPart :: Lens' EmailTemplateResponse (Maybe Text) Source #
The message body, in plain text format, that's used in email messages that are based on the message template.
emailTemplateResponse_version :: Lens' EmailTemplateResponse (Maybe Text) Source #
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
emailTemplateResponse_tags :: Lens' EmailTemplateResponse (Maybe (HashMap Text Text)) Source #
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
emailTemplateResponse_lastModifiedDate :: Lens' EmailTemplateResponse Text Source #
The date, in ISO 8601 format, when the message template was last modified.
emailTemplateResponse_creationDate :: Lens' EmailTemplateResponse Text Source #
The date, in ISO 8601 format, when the message template was created.
emailTemplateResponse_templateName :: Lens' EmailTemplateResponse Text Source #
The name of the message template.
emailTemplateResponse_templateType :: Lens' EmailTemplateResponse TemplateType Source #
The type of channel that the message template is designed for. For an email template, this value is EMAIL.
EndpointBatchItem
data EndpointBatchItem Source #
Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.
See: newEndpointBatchItem smart constructor.
Constructors
| EndpointBatchItem' | |
Fields
| |
Instances
newEndpointBatchItem :: EndpointBatchItem Source #
Create a value of EndpointBatchItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:address:EndpointBatchItem', endpointBatchItem_address - The destination address for messages or push notifications that you send
to the endpoint. The address varies by channel. For a push-notification
channel, use the token provided by the push notification service, such
as an Apple Push Notification service (APNs) device token or a Firebase
Cloud Messaging (FCM) registration token. For the SMS channel, use a
phone number in E.164 format, such as +12065550100. For the email
channel, use an email address.
$sel:attributes:EndpointBatchItem', endpointBatchItem_attributes - One or more custom attributes that describe the endpoint by associating
a name with an array of values. For example, the value of a custom
attribute named Interests might be: ["Science", "Music",
"Travel"]. You can use these attributes as filter criteria when you
create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
$sel:channelType:EndpointBatchItem', endpointBatchItem_channelType - The channel to use when sending messages or push notifications to the
endpoint.
$sel:demographic:EndpointBatchItem', endpointBatchItem_demographic - The demographic information for the endpoint, such as the time zone and
platform.
$sel:effectiveDate:EndpointBatchItem', endpointBatchItem_effectiveDate - The date and time, in ISO 8601 format, when the endpoint was created or
updated.
$sel:endpointStatus:EndpointBatchItem', endpointBatchItem_endpointStatus - Specifies whether to send messages or push notifications to the
endpoint. Valid values are: ACTIVE, messages are sent to the endpoint;
and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
$sel:id:EndpointBatchItem', endpointBatchItem_id - The unique identifier for the endpoint in the context of the batch.
$sel:location:EndpointBatchItem', endpointBatchItem_location - The geographic information for the endpoint.
$sel:metrics:EndpointBatchItem', endpointBatchItem_metrics - One or more custom metrics that your app reports to Amazon Pinpoint for
the endpoint.
$sel:optOut:EndpointBatchItem', endpointBatchItem_optOut - Specifies whether the user who's associated with the endpoint has opted
out of receiving messages and push notifications from you. Possible
values are: ALL, the user has opted out and doesn't want to receive any
messages or push notifications; and, NONE, the user hasn't opted out
and wants to receive all messages and push notifications.
$sel:requestId:EndpointBatchItem', endpointBatchItem_requestId - The unique identifier for the request to create or update the endpoint.
$sel:user:EndpointBatchItem', endpointBatchItem_user - One or more custom attributes that describe the user who's associated
with the endpoint.
endpointBatchItem_address :: Lens' EndpointBatchItem (Maybe Text) Source #
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
endpointBatchItem_attributes :: Lens' EndpointBatchItem (Maybe (HashMap Text [Text])) Source #
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
endpointBatchItem_channelType :: Lens' EndpointBatchItem (Maybe ChannelType) Source #
The channel to use when sending messages or push notifications to the endpoint.
endpointBatchItem_demographic :: Lens' EndpointBatchItem (Maybe EndpointDemographic) Source #
The demographic information for the endpoint, such as the time zone and platform.
endpointBatchItem_effectiveDate :: Lens' EndpointBatchItem (Maybe Text) Source #
The date and time, in ISO 8601 format, when the endpoint was created or updated.
endpointBatchItem_endpointStatus :: Lens' EndpointBatchItem (Maybe Text) Source #
Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
endpointBatchItem_id :: Lens' EndpointBatchItem (Maybe Text) Source #
The unique identifier for the endpoint in the context of the batch.
endpointBatchItem_location :: Lens' EndpointBatchItem (Maybe EndpointLocation) Source #
The geographic information for the endpoint.
endpointBatchItem_metrics :: Lens' EndpointBatchItem (Maybe (HashMap Text Double)) Source #
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
endpointBatchItem_optOut :: Lens' EndpointBatchItem (Maybe Text) Source #
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
endpointBatchItem_requestId :: Lens' EndpointBatchItem (Maybe Text) Source #
The unique identifier for the request to create or update the endpoint.
endpointBatchItem_user :: Lens' EndpointBatchItem (Maybe EndpointUser) Source #
One or more custom attributes that describe the user who's associated with the endpoint.
EndpointBatchRequest
data EndpointBatchRequest Source #
Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.
See: newEndpointBatchRequest smart constructor.
Constructors
| EndpointBatchRequest' | |
Fields
| |
Instances
newEndpointBatchRequest :: EndpointBatchRequest Source #
Create a value of EndpointBatchRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:item:EndpointBatchRequest', endpointBatchRequest_item - An array that defines the endpoints to create or update and, for each
endpoint, the property values to set or change. An array can contain a
maximum of 100 items.
endpointBatchRequest_item :: Lens' EndpointBatchRequest [EndpointBatchItem] Source #
An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change. An array can contain a maximum of 100 items.
EndpointDemographic
data EndpointDemographic Source #
Specifies demographic information about an endpoint, such as the applicable time zone and platform.
See: newEndpointDemographic smart constructor.
Constructors
| EndpointDemographic' | |
Fields
| |
Instances
newEndpointDemographic :: EndpointDemographic Source #
Create a value of EndpointDemographic with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appVersion:EndpointDemographic', endpointDemographic_appVersion - The version of the app that's associated with the endpoint.
$sel:locale:EndpointDemographic', endpointDemographic_locale - The locale of the endpoint, in the following format: the ISO 639-1
alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1
alpha-2 value.
$sel:make:EndpointDemographic', endpointDemographic_make - The manufacturer of the endpoint device, such as apple or samsung.
$sel:model:EndpointDemographic', endpointDemographic_model - The model name or number of the endpoint device, such as iPhone or
SM-G900F.
$sel:modelVersion:EndpointDemographic', endpointDemographic_modelVersion - The model version of the endpoint device.
$sel:platform:EndpointDemographic', endpointDemographic_platform - The platform of the endpoint device, such as ios.
$sel:platformVersion:EndpointDemographic', endpointDemographic_platformVersion - The platform version of the endpoint device.
$sel:timezone:EndpointDemographic', endpointDemographic_timezone - The time zone of the endpoint, specified as a tz database name value,
such as America/Los_Angeles.
endpointDemographic_appVersion :: Lens' EndpointDemographic (Maybe Text) Source #
The version of the app that's associated with the endpoint.
endpointDemographic_locale :: Lens' EndpointDemographic (Maybe Text) Source #
The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
endpointDemographic_make :: Lens' EndpointDemographic (Maybe Text) Source #
The manufacturer of the endpoint device, such as apple or samsung.
endpointDemographic_model :: Lens' EndpointDemographic (Maybe Text) Source #
The model name or number of the endpoint device, such as iPhone or SM-G900F.
endpointDemographic_modelVersion :: Lens' EndpointDemographic (Maybe Text) Source #
The model version of the endpoint device.
endpointDemographic_platform :: Lens' EndpointDemographic (Maybe Text) Source #
The platform of the endpoint device, such as ios.
endpointDemographic_platformVersion :: Lens' EndpointDemographic (Maybe Text) Source #
The platform version of the endpoint device.
endpointDemographic_timezone :: Lens' EndpointDemographic (Maybe Text) Source #
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
EndpointItemResponse
data EndpointItemResponse Source #
Provides the status code and message that result from processing data for an endpoint.
See: newEndpointItemResponse smart constructor.
Constructors
| EndpointItemResponse' | |
Instances
newEndpointItemResponse :: EndpointItemResponse Source #
Create a value of EndpointItemResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:EndpointItemResponse', endpointItemResponse_message - The custom message that's returned in the response as a result of
processing the endpoint data.
$sel:statusCode:EndpointItemResponse', endpointItemResponse_statusCode - The status code that's returned in the response as a result of
processing the endpoint data.
endpointItemResponse_message :: Lens' EndpointItemResponse (Maybe Text) Source #
The custom message that's returned in the response as a result of processing the endpoint data.
endpointItemResponse_statusCode :: Lens' EndpointItemResponse (Maybe Int) Source #
The status code that's returned in the response as a result of processing the endpoint data.
EndpointLocation
data EndpointLocation Source #
Specifies geographic information about an endpoint.
See: newEndpointLocation smart constructor.
Constructors
| EndpointLocation' | |
Fields
| |
Instances
newEndpointLocation :: EndpointLocation Source #
Create a value of EndpointLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:city:EndpointLocation', endpointLocation_city - The name of the city where the endpoint is located.
$sel:country:EndpointLocation', endpointLocation_country - The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region where the endpoint is located. For example, US for the United
States.
$sel:latitude:EndpointLocation', endpointLocation_latitude - The latitude coordinate of the endpoint location, rounded to one decimal
place.
$sel:longitude:EndpointLocation', endpointLocation_longitude - The longitude coordinate of the endpoint location, rounded to one
decimal place.
$sel:postalCode:EndpointLocation', endpointLocation_postalCode - The postal or ZIP code for the area where the endpoint is located.
$sel:region:EndpointLocation', endpointLocation_region - The name of the region where the endpoint is located. For locations in
the United States, this value is the name of a state.
endpointLocation_city :: Lens' EndpointLocation (Maybe Text) Source #
The name of the city where the endpoint is located.
endpointLocation_country :: Lens' EndpointLocation (Maybe Text) Source #
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
endpointLocation_latitude :: Lens' EndpointLocation (Maybe Double) Source #
The latitude coordinate of the endpoint location, rounded to one decimal place.
endpointLocation_longitude :: Lens' EndpointLocation (Maybe Double) Source #
The longitude coordinate of the endpoint location, rounded to one decimal place.
endpointLocation_postalCode :: Lens' EndpointLocation (Maybe Text) Source #
The postal or ZIP code for the area where the endpoint is located.
endpointLocation_region :: Lens' EndpointLocation (Maybe Text) Source #
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
EndpointMessageResult
data EndpointMessageResult Source #
Provides information about the delivery status and results of sending a message directly to an endpoint.
See: newEndpointMessageResult smart constructor.
Constructors
| EndpointMessageResult' | |
Fields
| |
Instances
newEndpointMessageResult Source #
Arguments
| :: DeliveryStatus | |
| -> Int | |
| -> EndpointMessageResult |
Create a value of EndpointMessageResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:address:EndpointMessageResult', endpointMessageResult_address - The endpoint address that the message was delivered to.
$sel:messageId:EndpointMessageResult', endpointMessageResult_messageId - The unique identifier for the message that was sent.
$sel:statusMessage:EndpointMessageResult', endpointMessageResult_statusMessage - The status message for delivering the message.
$sel:updatedToken:EndpointMessageResult', endpointMessageResult_updatedToken - For push notifications that are sent through the GCM channel, specifies
whether the endpoint's device registration token was updated as part of
delivering the message.
$sel:deliveryStatus:EndpointMessageResult', endpointMessageResult_deliveryStatus - The delivery status of the message. Possible values are:
- DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
- OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
- PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
- SUCCESSFUL - The message was successfully delivered to the endpoint.
- TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
- THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.
- TIMEOUT - The message couldn't be sent within the timeout period.
- UNKNOWN_FAILURE - An unknown error occurred.
$sel:statusCode:EndpointMessageResult', endpointMessageResult_statusCode - The downstream service status code for delivering the message.
endpointMessageResult_address :: Lens' EndpointMessageResult (Maybe Text) Source #
The endpoint address that the message was delivered to.
endpointMessageResult_messageId :: Lens' EndpointMessageResult (Maybe Text) Source #
The unique identifier for the message that was sent.
endpointMessageResult_statusMessage :: Lens' EndpointMessageResult (Maybe Text) Source #
The status message for delivering the message.
endpointMessageResult_updatedToken :: Lens' EndpointMessageResult (Maybe Text) Source #
For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
endpointMessageResult_deliveryStatus :: Lens' EndpointMessageResult DeliveryStatus Source #
The delivery status of the message. Possible values are:
- DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
- OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
- PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
- SUCCESSFUL - The message was successfully delivered to the endpoint.
- TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
- THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.
- TIMEOUT - The message couldn't be sent within the timeout period.
- UNKNOWN_FAILURE - An unknown error occurred.
endpointMessageResult_statusCode :: Lens' EndpointMessageResult Int Source #
The downstream service status code for delivering the message.
EndpointRequest
data EndpointRequest Source #
Specifies the channel type and other settings for an endpoint.
See: newEndpointRequest smart constructor.
Constructors
| EndpointRequest' | |
Fields
| |
Instances
newEndpointRequest :: EndpointRequest Source #
Create a value of EndpointRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:address:EndpointRequest', endpointRequest_address - The destination address for messages or push notifications that you send
to the endpoint. The address varies by channel. For a push-notification
channel, use the token provided by the push notification service, such
as an Apple Push Notification service (APNs) device token or a Firebase
Cloud Messaging (FCM) registration token. For the SMS channel, use a
phone number in E.164 format, such as +12065550100. For the email
channel, use an email address.
$sel:attributes:EndpointRequest', endpointRequest_attributes - One or more custom attributes that describe the endpoint by associating
a name with an array of values. For example, the value of a custom
attribute named Interests might be: ["Science", "Music",
"Travel"]. You can use these attributes as filter criteria when you
create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
$sel:channelType:EndpointRequest', endpointRequest_channelType - The channel to use when sending messages or push notifications to the
endpoint.
$sel:demographic:EndpointRequest', endpointRequest_demographic - The demographic information for the endpoint, such as the time zone and
platform.
$sel:effectiveDate:EndpointRequest', endpointRequest_effectiveDate - The date and time, in ISO 8601 format, when the endpoint is updated.
$sel:endpointStatus:EndpointRequest', endpointRequest_endpointStatus - Specifies whether to send messages or push notifications to the
endpoint. Valid values are: ACTIVE, messages are sent to the endpoint;
and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
$sel:location:EndpointRequest', endpointRequest_location - The geographic information for the endpoint.
$sel:metrics:EndpointRequest', endpointRequest_metrics - One or more custom metrics that your app reports to Amazon Pinpoint for
the endpoint.
$sel:optOut:EndpointRequest', endpointRequest_optOut - Specifies whether the user who's associated with the endpoint has opted
out of receiving messages and push notifications from you. Possible
values are: ALL, the user has opted out and doesn't want to receive any
messages or push notifications; and, NONE, the user hasn't opted out
and wants to receive all messages and push notifications.
$sel:requestId:EndpointRequest', endpointRequest_requestId - The unique identifier for the most recent request to update the
endpoint.
$sel:user:EndpointRequest', endpointRequest_user - One or more custom attributes that describe the user who's associated
with the endpoint.
endpointRequest_address :: Lens' EndpointRequest (Maybe Text) Source #
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
endpointRequest_attributes :: Lens' EndpointRequest (Maybe (HashMap Text [Text])) Source #
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
endpointRequest_channelType :: Lens' EndpointRequest (Maybe ChannelType) Source #
The channel to use when sending messages or push notifications to the endpoint.
endpointRequest_demographic :: Lens' EndpointRequest (Maybe EndpointDemographic) Source #
The demographic information for the endpoint, such as the time zone and platform.
endpointRequest_effectiveDate :: Lens' EndpointRequest (Maybe Text) Source #
The date and time, in ISO 8601 format, when the endpoint is updated.
endpointRequest_endpointStatus :: Lens' EndpointRequest (Maybe Text) Source #
Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
endpointRequest_location :: Lens' EndpointRequest (Maybe EndpointLocation) Source #
The geographic information for the endpoint.
endpointRequest_metrics :: Lens' EndpointRequest (Maybe (HashMap Text Double)) Source #
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
endpointRequest_optOut :: Lens' EndpointRequest (Maybe Text) Source #
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
endpointRequest_requestId :: Lens' EndpointRequest (Maybe Text) Source #
The unique identifier for the most recent request to update the endpoint.
endpointRequest_user :: Lens' EndpointRequest (Maybe EndpointUser) Source #
One or more custom attributes that describe the user who's associated with the endpoint.
EndpointResponse
data EndpointResponse Source #
Provides information about the channel type and other settings for an endpoint.
See: newEndpointResponse smart constructor.
Constructors
| EndpointResponse' | |
Fields
| |
Instances
newEndpointResponse :: EndpointResponse Source #
Create a value of EndpointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:address:EndpointResponse', endpointResponse_address - The destination address for messages or push notifications that you send
to the endpoint. The address varies by channel. For example, the address
for a push-notification channel is typically the token provided by a
push notification service, such as an Apple Push Notification service
(APNs) device token or a Firebase Cloud Messaging (FCM) registration
token. The address for the SMS channel is a phone number in E.164
format, such as +12065550100. The address for the email channel is an
email address.
$sel:applicationId:EndpointResponse', endpointResponse_applicationId - The unique identifier for the application that's associated with the
endpoint.
$sel:attributes:EndpointResponse', endpointResponse_attributes - One or more custom attributes that describe the endpoint by associating
a name with an array of values. For example, the value of a custom
attribute named Interests might be: ["Science", "Music",
"Travel"]. You can use these attributes as filter criteria when you
create segments.
$sel:channelType:EndpointResponse', endpointResponse_channelType - The channel that's used when sending messages or push notifications to
the endpoint.
$sel:cohortId:EndpointResponse', endpointResponse_cohortId - A number from 0-99 that represents the cohort that the endpoint is
assigned to. Endpoints are grouped into cohorts randomly, and each
cohort contains approximately 1 percent of the endpoints for an
application. Amazon Pinpoint assigns cohorts to the holdout or treatment
allocations for campaigns.
$sel:creationDate:EndpointResponse', endpointResponse_creationDate - The date and time, in ISO 8601 format, when the endpoint was created.
$sel:demographic:EndpointResponse', endpointResponse_demographic - The demographic information for the endpoint, such as the time zone and
platform.
$sel:effectiveDate:EndpointResponse', endpointResponse_effectiveDate - The date and time, in ISO 8601 format, when the endpoint was last
updated.
$sel:endpointStatus:EndpointResponse', endpointResponse_endpointStatus - Specifies whether messages or push notifications are sent to the
endpoint. Possible values are: ACTIVE, messages are sent to the
endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
$sel:id:EndpointResponse', endpointResponse_id - The unique identifier that you assigned to the endpoint. The identifier
should be a globally unique identifier (GUID) to ensure that it doesn't
conflict with other endpoint identifiers that are associated with the
application.
$sel:location:EndpointResponse', endpointResponse_location - The geographic information for the endpoint.
$sel:metrics:EndpointResponse', endpointResponse_metrics - One or more custom metrics that your app reports to Amazon Pinpoint for
the endpoint.
$sel:optOut:EndpointResponse', endpointResponse_optOut - Specifies whether the user who's associated with the endpoint has opted
out of receiving messages and push notifications from you. Possible
values are: ALL, the user has opted out and doesn't want to receive any
messages or push notifications; and, NONE, the user hasn't opted out
and wants to receive all messages and push notifications.
$sel:requestId:EndpointResponse', endpointResponse_requestId - The unique identifier for the most recent request to update the
endpoint.
$sel:user:EndpointResponse', endpointResponse_user - One or more custom user attributes that your app reports to Amazon
Pinpoint for the user who's associated with the endpoint.
endpointResponse_address :: Lens' EndpointResponse (Maybe Text) Source #
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
endpointResponse_applicationId :: Lens' EndpointResponse (Maybe Text) Source #
The unique identifier for the application that's associated with the endpoint.
endpointResponse_attributes :: Lens' EndpointResponse (Maybe (HashMap Text [Text])) Source #
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments.
endpointResponse_channelType :: Lens' EndpointResponse (Maybe ChannelType) Source #
The channel that's used when sending messages or push notifications to the endpoint.
endpointResponse_cohortId :: Lens' EndpointResponse (Maybe Text) Source #
A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
endpointResponse_creationDate :: Lens' EndpointResponse (Maybe Text) Source #
The date and time, in ISO 8601 format, when the endpoint was created.
endpointResponse_demographic :: Lens' EndpointResponse (Maybe EndpointDemographic) Source #
The demographic information for the endpoint, such as the time zone and platform.
endpointResponse_effectiveDate :: Lens' EndpointResponse (Maybe Text) Source #
The date and time, in ISO 8601 format, when the endpoint was last updated.
endpointResponse_endpointStatus :: Lens' EndpointResponse (Maybe Text) Source #
Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
endpointResponse_id :: Lens' EndpointResponse (Maybe Text) Source #
The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
endpointResponse_location :: Lens' EndpointResponse (Maybe EndpointLocation) Source #
The geographic information for the endpoint.
endpointResponse_metrics :: Lens' EndpointResponse (Maybe (HashMap Text Double)) Source #
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
endpointResponse_optOut :: Lens' EndpointResponse (Maybe Text) Source #
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
endpointResponse_requestId :: Lens' EndpointResponse (Maybe Text) Source #
The unique identifier for the most recent request to update the endpoint.
endpointResponse_user :: Lens' EndpointResponse (Maybe EndpointUser) Source #
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
EndpointSendConfiguration
data EndpointSendConfiguration Source #
Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.
See: newEndpointSendConfiguration smart constructor.
Constructors
| EndpointSendConfiguration' | |
Fields
| |
Instances
newEndpointSendConfiguration :: EndpointSendConfiguration Source #
Create a value of EndpointSendConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bodyOverride:EndpointSendConfiguration', endpointSendConfiguration_bodyOverride - The body of the message. If specified, this value overrides the default
message body.
$sel:context:EndpointSendConfiguration', endpointSendConfiguration_context - A map of custom attributes to attach to the message for the address.
Attribute names are case sensitive.
For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
$sel:rawContent:EndpointSendConfiguration', endpointSendConfiguration_rawContent - The raw, JSON-formatted string to use as the payload for the message. If
specified, this value overrides all other values for the message.
$sel:substitutions:EndpointSendConfiguration', endpointSendConfiguration_substitutions - A map of the message variables to merge with the variables specified for
the default message (DefaultMessage.Substitutions). The variables
specified in this map take precedence over all other variables.
$sel:titleOverride:EndpointSendConfiguration', endpointSendConfiguration_titleOverride - The title or subject line of the message. If specified, this value
overrides the default message title or subject line.
endpointSendConfiguration_bodyOverride :: Lens' EndpointSendConfiguration (Maybe Text) Source #
The body of the message. If specified, this value overrides the default message body.
endpointSendConfiguration_context :: Lens' EndpointSendConfiguration (Maybe (HashMap Text Text)) Source #
A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.
For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
endpointSendConfiguration_rawContent :: Lens' EndpointSendConfiguration (Maybe Text) Source #
The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
endpointSendConfiguration_substitutions :: Lens' EndpointSendConfiguration (Maybe (HashMap Text [Text])) Source #
A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.
endpointSendConfiguration_titleOverride :: Lens' EndpointSendConfiguration (Maybe Text) Source #
The title or subject line of the message. If specified, this value overrides the default message title or subject line.
EndpointUser
data EndpointUser Source #
Specifies data for one or more attributes that describe the user who's associated with an endpoint.
See: newEndpointUser smart constructor.
Constructors
| EndpointUser' | |
Fields
| |
Instances
newEndpointUser :: EndpointUser Source #
Create a value of EndpointUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userAttributes:EndpointUser', endpointUser_userAttributes - One or more custom attributes that describe the user by associating a
name with an array of values. For example, the value of an attribute
named Interests might be: ["Science", "Music", "Travel"]. You can
use these attributes as filter criteria when you create segments.
Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
$sel:userId:EndpointUser', endpointUser_userId - The unique identifier for the user.
endpointUser_userAttributes :: Lens' EndpointUser (Maybe (HashMap Text [Text])) Source #
One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.
An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
endpointUser_userId :: Lens' EndpointUser (Maybe Text) Source #
The unique identifier for the user.
EndpointsResponse
data EndpointsResponse Source #
Provides information about all the endpoints that are associated with a user ID.
See: newEndpointsResponse smart constructor.
Constructors
| EndpointsResponse' | |
Fields
| |
Instances
newEndpointsResponse :: EndpointsResponse Source #
Create a value of EndpointsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:item:EndpointsResponse', endpointsResponse_item - An array of responses, one for each endpoint that's associated with the
user ID.
endpointsResponse_item :: Lens' EndpointsResponse [EndpointResponse] Source #
An array of responses, one for each endpoint that's associated with the user ID.
Event
Specifies information about an event that reports data to Amazon Pinpoint.
See: newEvent smart constructor.
Constructors
| Event' | |
Fields
| |
Instances
Create a value of Event with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appPackageName:Event', event_appPackageName - The package name of the app that's recording the event.
$sel:appTitle:Event', event_appTitle - The title of the app that's recording the event.
$sel:appVersionCode:Event', event_appVersionCode - The version number of the app that's recording the event.
$sel:attributes:Event', event_attributes - One or more custom attributes that are associated with the event.
$sel:clientSdkVersion:Event', event_clientSdkVersion - The version of the SDK that's running on the client device.
$sel:metrics:Event', event_metrics - One or more custom metrics that are associated with the event.
$sel:sdkName:Event', event_sdkName - The name of the SDK that's being used to record the event.
$sel:session:Event', event_session - Information about the session in which the event occurred.
$sel:eventType:Event', event_eventType - The name of the event.
$sel:timestamp:Event', event_timestamp - The date and time, in ISO 8601 format, when the event occurred.
event_appPackageName :: Lens' Event (Maybe Text) Source #
The package name of the app that's recording the event.
event_appVersionCode :: Lens' Event (Maybe Text) Source #
The version number of the app that's recording the event.
event_attributes :: Lens' Event (Maybe (HashMap Text Text)) Source #
One or more custom attributes that are associated with the event.
event_clientSdkVersion :: Lens' Event (Maybe Text) Source #
The version of the SDK that's running on the client device.
event_metrics :: Lens' Event (Maybe (HashMap Text Double)) Source #
One or more custom metrics that are associated with the event.
event_sdkName :: Lens' Event (Maybe Text) Source #
The name of the SDK that's being used to record the event.
event_session :: Lens' Event (Maybe Session) Source #
Information about the session in which the event occurred.
event_timestamp :: Lens' Event Text Source #
The date and time, in ISO 8601 format, when the event occurred.
EventCondition
data EventCondition Source #
Specifies the conditions to evaluate for an event that applies to an activity in a journey.
See: newEventCondition smart constructor.
Constructors
| EventCondition' | |
Fields
| |
Instances
newEventCondition :: EventCondition Source #
Create a value of EventCondition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensions:EventCondition', eventCondition_dimensions - The dimensions for the event filter to use for the activity.
$sel:messageActivity:EventCondition', eventCondition_messageActivity - The message identifier (message_id) for the message to use when
determining whether message events meet the condition.
eventCondition_dimensions :: Lens' EventCondition (Maybe EventDimensions) Source #
The dimensions for the event filter to use for the activity.
eventCondition_messageActivity :: Lens' EventCondition (Maybe Text) Source #
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
EventDimensions
data EventDimensions Source #
Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.
See: newEventDimensions smart constructor.
Constructors
| EventDimensions' | |
Fields
| |
Instances
newEventDimensions :: EventDimensions Source #
Create a value of EventDimensions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:EventDimensions', eventDimensions_attributes - One or more custom attributes that your application reports to Amazon
Pinpoint. You can use these attributes as selection criteria when you
create an event filter.
$sel:eventType:EventDimensions', eventDimensions_eventType - The name of the event that causes the campaign to be sent or the journey
activity to be performed. This can be a standard event that Amazon
Pinpoint generates, such as _email.delivered. For campaigns, this can
also be a custom event that's specific to your application. For
information about standard events, see
Streaming Amazon Pinpoint Events
in the Amazon Pinpoint Developer Guide.
$sel:metrics:EventDimensions', eventDimensions_metrics - One or more custom metrics that your application reports to Amazon
Pinpoint. You can use these metrics as selection criteria when you
create an event filter.
eventDimensions_attributes :: Lens' EventDimensions (Maybe (HashMap Text AttributeDimension)) Source #
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
eventDimensions_eventType :: Lens' EventDimensions (Maybe SetDimension) Source #
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide.
eventDimensions_metrics :: Lens' EventDimensions (Maybe (HashMap Text MetricDimension)) Source #
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
EventFilter
data EventFilter Source #
Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.
See: newEventFilter smart constructor.
Constructors
| EventFilter' | |
Fields
| |
Instances
Arguments
| :: FilterType | |
| -> EventDimensions | |
| -> EventFilter |
Create a value of EventFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filterType:EventFilter', eventFilter_filterType - The type of event that causes the campaign to be sent or the journey
activity to be performed. Valid values are: SYSTEM, sends the campaign
or performs the activity when a system event occurs; and, ENDPOINT,
sends the campaign or performs the activity when an endpoint event
(Events resource) occurs.
$sel:dimensions:EventFilter', eventFilter_dimensions - The dimensions for the event filter to use for the campaign or the
journey activity.
eventFilter_filterType :: Lens' EventFilter FilterType Source #
The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
eventFilter_dimensions :: Lens' EventFilter EventDimensions Source #
The dimensions for the event filter to use for the campaign or the journey activity.
EventItemResponse
data EventItemResponse Source #
Provides the status code and message that result from processing an event.
See: newEventItemResponse smart constructor.
Constructors
| EventItemResponse' | |
Fields
| |
Instances
newEventItemResponse :: EventItemResponse Source #
Create a value of EventItemResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:EventItemResponse', eventItemResponse_message - A custom message that's returned in the response as a result of
processing the event.
$sel:statusCode:EventItemResponse', eventItemResponse_statusCode - The status code that's returned in the response as a result of
processing the event. Possible values are: 202, for events that were
accepted; and, 400, for events that weren't valid.
eventItemResponse_message :: Lens' EventItemResponse (Maybe Text) Source #
A custom message that's returned in the response as a result of processing the event.
eventItemResponse_statusCode :: Lens' EventItemResponse (Maybe Int) Source #
The status code that's returned in the response as a result of processing the event. Possible values are: 202, for events that were accepted; and, 400, for events that weren't valid.
EventStartCondition
data EventStartCondition Source #
Specifies the settings for an event that causes a journey activity to start.
See: newEventStartCondition smart constructor.
Constructors
| EventStartCondition' | |
Fields | |
Instances
newEventStartCondition :: EventStartCondition Source #
Create a value of EventStartCondition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventFilter:EventStartCondition', eventStartCondition_eventFilter - Undocumented member.
$sel:segmentId:EventStartCondition', eventStartCondition_segmentId - Undocumented member.
eventStartCondition_eventFilter :: Lens' EventStartCondition (Maybe EventFilter) Source #
Undocumented member.
eventStartCondition_segmentId :: Lens' EventStartCondition (Maybe Text) Source #
Undocumented member.
EventStream
data EventStream Source #
Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.
See: newEventStream smart constructor.
Constructors
| EventStream' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> EventStream |
Create a value of EventStream with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:externalId:EventStream', eventStream_externalId - (Deprecated) Your AWS account ID, which you assigned to an external ID
key in an IAM trust policy. Amazon Pinpoint previously used this value
to assume an IAM role when publishing event data, but we removed this
requirement. We don't recommend use of external IDs for IAM roles that
are assumed by Amazon Pinpoint.
$sel:lastModifiedDate:EventStream', eventStream_lastModifiedDate - The date, in ISO 8601 format, when the event stream was last modified.
$sel:lastUpdatedBy:EventStream', eventStream_lastUpdatedBy - The IAM user who last modified the event stream.
$sel:applicationId:EventStream', eventStream_applicationId - The unique identifier for the application to publish event data for.
$sel:roleArn:EventStream', eventStream_roleArn - The AWS Identity and Access Management (IAM) role that authorizes Amazon
Pinpoint to publish event data to the stream in your AWS account.
$sel:destinationStreamArn:EventStream', eventStream_destinationStreamArn - The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or
Amazon Kinesis Data Firehose delivery stream to publish event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
eventStream_externalId :: Lens' EventStream (Maybe Text) Source #
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
eventStream_lastModifiedDate :: Lens' EventStream (Maybe Text) Source #
The date, in ISO 8601 format, when the event stream was last modified.
eventStream_lastUpdatedBy :: Lens' EventStream (Maybe Text) Source #
The IAM user who last modified the event stream.
eventStream_applicationId :: Lens' EventStream Text Source #
The unique identifier for the application to publish event data for.
eventStream_roleArn :: Lens' EventStream Text Source #
The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
eventStream_destinationStreamArn :: Lens' EventStream Text Source #
The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
EventsBatch
data EventsBatch Source #
Specifies a batch of endpoints and events to process.
See: newEventsBatch smart constructor.
Constructors
| EventsBatch' | |
Instances
Arguments
| :: PublicEndpoint | |
| -> EventsBatch |
Create a value of EventsBatch with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpoint:EventsBatch', eventsBatch_endpoint - A set of properties and attributes that are associated with the
endpoint.
$sel:events:EventsBatch', eventsBatch_events - A set of properties that are associated with the event.
eventsBatch_endpoint :: Lens' EventsBatch PublicEndpoint Source #
A set of properties and attributes that are associated with the endpoint.
eventsBatch_events :: Lens' EventsBatch (HashMap Text Event) Source #
A set of properties that are associated with the event.
EventsRequest
data EventsRequest Source #
Specifies a batch of events to process.
See: newEventsRequest smart constructor.
Constructors
| EventsRequest' | |
Fields
| |
Instances
newEventsRequest :: EventsRequest Source #
Create a value of EventsRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:batchItem:EventsRequest', eventsRequest_batchItem - The batch of events to process. For each item in a batch, the endpoint
ID acts as a key that has an EventsBatch object as its value.
eventsRequest_batchItem :: Lens' EventsRequest (HashMap Text EventsBatch) Source #
The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value.
EventsResponse
data EventsResponse Source #
Provides information about endpoints and the events that they're associated with.
See: newEventsResponse smart constructor.
Constructors
| EventsResponse' | |
Fields
| |
Instances
newEventsResponse :: EventsResponse Source #
Create a value of EventsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:results:EventsResponse', eventsResponse_results - A map that contains a multipart response for each endpoint. For each
item in this object, the endpoint ID is the key and the item response is
the value. If no item response exists, the value can also be one of the
following: 202, the request was processed successfully; or 400, the
payload wasn't valid or required fields were missing.
eventsResponse_results :: Lens' EventsResponse (Maybe (HashMap Text ItemResponse)) Source #
A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn't valid or required fields were missing.
ExportJobRequest
data ExportJobRequest Source #
Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.
See: newExportJobRequest smart constructor.
Constructors
| ExportJobRequest' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ExportJobRequest |
Create a value of ExportJobRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:segmentId:ExportJobRequest', exportJobRequest_segmentId - The identifier for the segment to export endpoint definitions from. If
you don't specify this value, Amazon Pinpoint exports definitions for
all the endpoints that are associated with the application.
$sel:segmentVersion:ExportJobRequest', exportJobRequest_segmentVersion - The version of the segment to export endpoint definitions from, if
specified.
$sel:s3UrlPrefix:ExportJobRequest', exportJobRequest_s3UrlPrefix - The URL of the location in an Amazon Simple Storage Service (Amazon S3)
bucket where you want to export endpoint definitions to. This location
is typically a folder that contains multiple files. The URL should be in
the following format: s3://bucket-name/folder-name/.
$sel:roleArn:ExportJobRequest', exportJobRequest_roleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that authorizes Amazon Pinpoint to access the Amazon S3
location where you want to export endpoint definitions to.
exportJobRequest_segmentId :: Lens' ExportJobRequest (Maybe Text) Source #
The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.
exportJobRequest_segmentVersion :: Lens' ExportJobRequest (Maybe Int) Source #
The version of the segment to export endpoint definitions from, if specified.
exportJobRequest_s3UrlPrefix :: Lens' ExportJobRequest Text Source #
The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
exportJobRequest_roleArn :: Lens' ExportJobRequest Text Source #
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.
ExportJobResource
data ExportJobResource Source #
Provides information about the resource settings for a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.
See: newExportJobResource smart constructor.
Constructors
| ExportJobResource' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ExportJobResource |
Create a value of ExportJobResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:segmentId:ExportJobResource', exportJobResource_segmentId - The identifier for the segment that the endpoint definitions were
exported from. If this value isn't present, Amazon Pinpoint exported
definitions for all the endpoints that are associated with the
application.
$sel:segmentVersion:ExportJobResource', exportJobResource_segmentVersion - The version of the segment that the endpoint definitions were exported
from.
$sel:s3UrlPrefix:ExportJobResource', exportJobResource_s3UrlPrefix - The URL of the location in an Amazon Simple Storage Service (Amazon S3)
bucket where the endpoint definitions were exported to. This location is
typically a folder that contains multiple files. The URL should be in
the following format: s3://bucket-name/folder-name/.
$sel:roleArn:ExportJobResource', exportJobResource_roleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that authorized Amazon Pinpoint to access the Amazon S3
location where the endpoint definitions were exported to.
exportJobResource_segmentId :: Lens' ExportJobResource (Maybe Text) Source #
The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.
exportJobResource_segmentVersion :: Lens' ExportJobResource (Maybe Int) Source #
The version of the segment that the endpoint definitions were exported from.
exportJobResource_s3UrlPrefix :: Lens' ExportJobResource Text Source #
The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
exportJobResource_roleArn :: Lens' ExportJobResource Text Source #
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.
ExportJobResponse
data ExportJobResponse Source #
Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.
See: newExportJobResponse smart constructor.
Constructors
| ExportJobResponse' | |
Fields
| |
Instances
Arguments
| :: JobStatus | |
| -> Text | |
| -> Text | |
| -> ExportJobResource | |
| -> Text | |
| -> Text | |
| -> ExportJobResponse |
Create a value of ExportJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:completedPieces:ExportJobResponse', exportJobResponse_completedPieces - The number of pieces that were processed successfully (completed) by the
export job, as of the time of the request.
$sel:completionDate:ExportJobResponse', exportJobResponse_completionDate - The date, in ISO 8601 format, when the export job was completed.
$sel:failedPieces:ExportJobResponse', exportJobResponse_failedPieces - The number of pieces that weren't processed successfully (failed) by
the export job, as of the time of the request.
$sel:failures:ExportJobResponse', exportJobResponse_failures - An array of entries, one for each of the first 100 entries that weren't
processed successfully (failed) by the export job, if any.
$sel:totalFailures:ExportJobResponse', exportJobResponse_totalFailures - The total number of endpoint definitions that weren't processed
successfully (failed) by the export job, typically because an error,
such as a syntax error, occurred.
$sel:totalPieces:ExportJobResponse', exportJobResponse_totalPieces - The total number of pieces that must be processed to complete the export
job. Each piece consists of an approximately equal portion of the
endpoint definitions that are part of the export job.
$sel:totalProcessed:ExportJobResponse', exportJobResponse_totalProcessed - The total number of endpoint definitions that were processed by the
export job.
$sel:jobStatus:ExportJobResponse', exportJobResponse_jobStatus - The status of the export job. The job status is FAILED if Amazon
Pinpoint wasn't able to process one or more pieces in the job.
$sel:creationDate:ExportJobResponse', exportJobResponse_creationDate - The date, in ISO 8601 format, when the export job was created.
$sel:type':ExportJobResponse', exportJobResponse_type - The job type. This value is EXPORT for export jobs.
$sel:definition:ExportJobResponse', exportJobResponse_definition - The resource settings that apply to the export job.
$sel:id:ExportJobResponse', exportJobResponse_id - The unique identifier for the export job.
$sel:applicationId:ExportJobResponse', exportJobResponse_applicationId - The unique identifier for the application that's associated with the
export job.
exportJobResponse_completedPieces :: Lens' ExportJobResponse (Maybe Int) Source #
The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
exportJobResponse_completionDate :: Lens' ExportJobResponse (Maybe Text) Source #
The date, in ISO 8601 format, when the export job was completed.
exportJobResponse_failedPieces :: Lens' ExportJobResponse (Maybe Int) Source #
The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
exportJobResponse_failures :: Lens' ExportJobResponse (Maybe [Text]) Source #
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
exportJobResponse_totalFailures :: Lens' ExportJobResponse (Maybe Int) Source #
The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
exportJobResponse_totalPieces :: Lens' ExportJobResponse (Maybe Int) Source #
The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
exportJobResponse_totalProcessed :: Lens' ExportJobResponse (Maybe Int) Source #
The total number of endpoint definitions that were processed by the export job.
exportJobResponse_jobStatus :: Lens' ExportJobResponse JobStatus Source #
The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
exportJobResponse_creationDate :: Lens' ExportJobResponse Text Source #
The date, in ISO 8601 format, when the export job was created.
exportJobResponse_type :: Lens' ExportJobResponse Text Source #
The job type. This value is EXPORT for export jobs.
exportJobResponse_definition :: Lens' ExportJobResponse ExportJobResource Source #
The resource settings that apply to the export job.
exportJobResponse_id :: Lens' ExportJobResponse Text Source #
The unique identifier for the export job.
exportJobResponse_applicationId :: Lens' ExportJobResponse Text Source #
The unique identifier for the application that's associated with the export job.
ExportJobsResponse
data ExportJobsResponse Source #
Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.
See: newExportJobsResponse smart constructor.
Constructors
| ExportJobsResponse' | |
Fields
| |
Instances
newExportJobsResponse :: ExportJobsResponse Source #
Create a value of ExportJobsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ExportJobsResponse', exportJobsResponse_nextToken - The string to use in a subsequent request to get the next page of
results in a paginated response. This value is null if there are no
additional pages.
$sel:item:ExportJobsResponse', exportJobsResponse_item - An array of responses, one for each export job that's associated with
the application (Export Jobs resource) or segment (Segment Export Jobs
resource).
exportJobsResponse_nextToken :: Lens' ExportJobsResponse (Maybe Text) Source #
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
exportJobsResponse_item :: Lens' ExportJobsResponse [ExportJobResponse] Source #
An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).
GCMChannelRequest
data GCMChannelRequest Source #
Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
See: newGCMChannelRequest smart constructor.
Constructors
| GCMChannelRequest' | |
Instances
Arguments
| :: Text | |
| -> GCMChannelRequest |
Create a value of GCMChannelRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:GCMChannelRequest', gCMChannelRequest_enabled - Specifies whether to enable the GCM channel for the application.
$sel:apiKey:GCMChannelRequest', gCMChannelRequest_apiKey - The Web API Key, also referred to as an API_KEY or server key, that
you received from Google to communicate with Google services.
gCMChannelRequest_enabled :: Lens' GCMChannelRequest (Maybe Bool) Source #
Specifies whether to enable the GCM channel for the application.
gCMChannelRequest_apiKey :: Lens' GCMChannelRequest Text Source #
The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
GCMChannelResponse
data GCMChannelResponse Source #
Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
See: newGCMChannelResponse smart constructor.
Constructors
| GCMChannelResponse' | |
Fields
| |
Instances
newGCMChannelResponse Source #
Arguments
| :: Text | |
| -> Text | |
| -> GCMChannelResponse |
Create a value of GCMChannelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:GCMChannelResponse', gCMChannelResponse_applicationId - The unique identifier for the application that the GCM channel applies
to.
$sel:creationDate:GCMChannelResponse', gCMChannelResponse_creationDate - The date and time when the GCM channel was enabled.
$sel:enabled:GCMChannelResponse', gCMChannelResponse_enabled - Specifies whether the GCM channel is enabled for the application.
$sel:hasCredential:GCMChannelResponse', gCMChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.
$sel:id:GCMChannelResponse', gCMChannelResponse_id - (Deprecated) An identifier for the GCM channel. This property is
retained only for backward compatibility.
$sel:isArchived:GCMChannelResponse', gCMChannelResponse_isArchived - Specifies whether the GCM channel is archived.
$sel:lastModifiedBy:GCMChannelResponse', gCMChannelResponse_lastModifiedBy - The user who last modified the GCM channel.
$sel:lastModifiedDate:GCMChannelResponse', gCMChannelResponse_lastModifiedDate - The date and time when the GCM channel was last modified.
$sel:version:GCMChannelResponse', gCMChannelResponse_version - The current version of the GCM channel.
$sel:credential:GCMChannelResponse', gCMChannelResponse_credential - The Web API Key, also referred to as an API_KEY or server key, that
you received from Google to communicate with Google services.
$sel:platform:GCMChannelResponse', gCMChannelResponse_platform - The type of messaging or notification platform for the channel. For the
GCM channel, this value is GCM.
gCMChannelResponse_applicationId :: Lens' GCMChannelResponse (Maybe Text) Source #
The unique identifier for the application that the GCM channel applies to.
gCMChannelResponse_creationDate :: Lens' GCMChannelResponse (Maybe Text) Source #
The date and time when the GCM channel was enabled.
gCMChannelResponse_enabled :: Lens' GCMChannelResponse (Maybe Bool) Source #
Specifies whether the GCM channel is enabled for the application.
gCMChannelResponse_hasCredential :: Lens' GCMChannelResponse (Maybe Bool) Source #
(Not used) This property is retained only for backward compatibility.
gCMChannelResponse_id :: Lens' GCMChannelResponse (Maybe Text) Source #
(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.
gCMChannelResponse_isArchived :: Lens' GCMChannelResponse (Maybe Bool) Source #
Specifies whether the GCM channel is archived.
gCMChannelResponse_lastModifiedBy :: Lens' GCMChannelResponse (Maybe Text) Source #
The user who last modified the GCM channel.
gCMChannelResponse_lastModifiedDate :: Lens' GCMChannelResponse (Maybe Text) Source #
The date and time when the GCM channel was last modified.
gCMChannelResponse_version :: Lens' GCMChannelResponse (Maybe Int) Source #
The current version of the GCM channel.
gCMChannelResponse_credential :: Lens' GCMChannelResponse Text Source #
The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
gCMChannelResponse_platform :: Lens' GCMChannelResponse Text Source #
The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.
GCMMessage
data GCMMessage Source #
Specifies the settings for a one-time message that's sent directly to an endpoint through the GCM channel. The GCM channel enables Amazon Pinpoint to send messages to the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
See: newGCMMessage smart constructor.
Constructors
| GCMMessage' | |
Fields
| |
Instances
newGCMMessage :: GCMMessage Source #
Create a value of GCMMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:GCMMessage', gCMMessage_action - The action to occur if the recipient taps the push notification. Valid
values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
$sel:body:GCMMessage', gCMMessage_body - The body of the notification message.
$sel:collapseKey:GCMMessage', gCMMessage_collapseKey - An arbitrary string that identifies a group of messages that can be
collapsed to ensure that only the last message is sent when delivery can
resume. This helps avoid sending too many instances of the same messages
when the recipient's device comes online again or becomes active.
Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.
$sel:data':GCMMessage', gCMMessage_data - The JSON data payload to use for the push notification, if the
notification is a silent push notification. This payload is added to the
data.pinpoint.jsonBody object of the notification.
$sel:iconReference:GCMMessage', gCMMessage_iconReference - The icon image name of the asset saved in your app.
$sel:imageIconUrl:GCMMessage', gCMMessage_imageIconUrl - The URL of the large icon image to display in the content view of the
push notification.
$sel:imageUrl:GCMMessage', gCMMessage_imageUrl - The URL of an image to display in the push notification.
$sel:priority:GCMMessage', gCMMessage_priority - para>normal - The notification might be delayed. Delivery is optimized
for battery usage on the recipient's device. Use this value unless
immediate delivery is required.
/listitem>
high - The notification is sent immediately and might wake a sleeping device.
/para>
Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.
The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.
$sel:rawContent:GCMMessage', gCMMessage_rawContent - The raw, JSON-formatted string to use as the payload for the
notification message. If specified, this value overrides all other
content for the message.
$sel:restrictedPackageName:GCMMessage', gCMMessage_restrictedPackageName - The package name of the application where registration tokens must match
in order for the recipient to receive the message.
$sel:silentPush:GCMMessage', gCMMessage_silentPush - Specifies whether the notification is a silent push notification, which
is a push notification that doesn't display on a recipient's device.
Silent push notifications can be used for cases such as updating an
app's configuration or supporting phone home functionality.
$sel:smallImageIconUrl:GCMMessage', gCMMessage_smallImageIconUrl - The URL of the small icon image to display in the status bar and the
content view of the push notification.
$sel:sound:GCMMessage', gCMMessage_sound - The sound to play when the recipient receives the push notification. You
can use the default stream or specify the file name of a sound resource
that's bundled in your app. On an Android platform, the sound file must
reside in /res/raw/.
$sel:substitutions:GCMMessage', gCMMessage_substitutions - The default message variables to use in the notification message. You
can override the default variables with individual address variables.
$sel:timeToLive:GCMMessage', gCMMessage_timeToLive - The amount of time, in seconds, that FCM should store and attempt to
deliver the push notification, if the service is unable to deliver the
notification the first time. If you don't specify this value, FCM
defaults to the maximum value, which is 2,419,200 seconds (28 days).
Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.
$sel:title:GCMMessage', gCMMessage_title - The title to display above the notification message on the recipient's
device.
$sel:url:GCMMessage', gCMMessage_url - The URL to open in the recipient's default mobile browser, if a
recipient taps the push notification and the value of the Action
property is URL.
gCMMessage_action :: Lens' GCMMessage (Maybe Action) Source #
The action to occur if the recipient taps the push notification. Valid values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
gCMMessage_body :: Lens' GCMMessage (Maybe Text) Source #
The body of the notification message.
gCMMessage_collapseKey :: Lens' GCMMessage (Maybe Text) Source #
An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.
Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.
gCMMessage_data :: Lens' GCMMessage (Maybe (HashMap Text Text)) Source #
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
gCMMessage_iconReference :: Lens' GCMMessage (Maybe Text) Source #
The icon image name of the asset saved in your app.
gCMMessage_imageIconUrl :: Lens' GCMMessage (Maybe Text) Source #
The URL of the large icon image to display in the content view of the push notification.
gCMMessage_imageUrl :: Lens' GCMMessage (Maybe Text) Source #
The URL of an image to display in the push notification.
gCMMessage_priority :: Lens' GCMMessage (Maybe Text) Source #
para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.
/listitem>
high - The notification is sent immediately and might wake a sleeping device.
/para>
Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.
The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.
gCMMessage_rawContent :: Lens' GCMMessage (Maybe Text) Source #
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
gCMMessage_restrictedPackageName :: Lens' GCMMessage (Maybe Text) Source #
The package name of the application where registration tokens must match in order for the recipient to receive the message.
gCMMessage_silentPush :: Lens' GCMMessage (Maybe Bool) Source #
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
gCMMessage_smallImageIconUrl :: Lens' GCMMessage (Maybe Text) Source #
The URL of the small icon image to display in the status bar and the content view of the push notification.
gCMMessage_sound :: Lens' GCMMessage (Maybe Text) Source #
The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
gCMMessage_substitutions :: Lens' GCMMessage (Maybe (HashMap Text [Text])) Source #
The default message variables to use in the notification message. You can override the default variables with individual address variables.
gCMMessage_timeToLive :: Lens' GCMMessage (Maybe Int) Source #
The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).
Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.
gCMMessage_title :: Lens' GCMMessage (Maybe Text) Source #
The title to display above the notification message on the recipient's device.
gCMMessage_url :: Lens' GCMMessage (Maybe Text) Source #
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
GPSCoordinates
data GPSCoordinates Source #
Specifies the GPS coordinates of a location.
See: newGPSCoordinates smart constructor.
Constructors
| GPSCoordinates' | |
Instances
Arguments
| :: Double | |
| -> Double | |
| -> GPSCoordinates |
Create a value of GPSCoordinates with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:latitude:GPSCoordinates', gPSCoordinates_latitude - The latitude coordinate of the location.
$sel:longitude:GPSCoordinates', gPSCoordinates_longitude - The longitude coordinate of the location.
gPSCoordinates_latitude :: Lens' GPSCoordinates Double Source #
The latitude coordinate of the location.
gPSCoordinates_longitude :: Lens' GPSCoordinates Double Source #
The longitude coordinate of the location.
GPSPointDimension
data GPSPointDimension Source #
Specifies GPS-based criteria for including or excluding endpoints from a segment.
See: newGPSPointDimension smart constructor.
Constructors
| GPSPointDimension' | |
Fields
| |
Instances
Create a value of GPSPointDimension with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rangeInKilometers:GPSPointDimension', gPSPointDimension_rangeInKilometers - The range, in kilometers, from the GPS coordinates.
$sel:coordinates:GPSPointDimension', gPSPointDimension_coordinates - The GPS coordinates to measure distance from.
gPSPointDimension_rangeInKilometers :: Lens' GPSPointDimension (Maybe Double) Source #
The range, in kilometers, from the GPS coordinates.
gPSPointDimension_coordinates :: Lens' GPSPointDimension GPSCoordinates Source #
The GPS coordinates to measure distance from.
HoldoutActivity
data HoldoutActivity Source #
Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants.
See: newHoldoutActivity smart constructor.
Constructors
| HoldoutActivity' | |
Fields
| |
Instances
Arguments
| :: Int | |
| -> HoldoutActivity |
Create a value of HoldoutActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextActivity:HoldoutActivity', holdoutActivity_nextActivity - The unique identifier for the next activity to perform, after performing
the holdout activity.
$sel:percentage:HoldoutActivity', holdoutActivity_percentage - The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
holdoutActivity_nextActivity :: Lens' HoldoutActivity (Maybe Text) Source #
The unique identifier for the next activity to perform, after performing the holdout activity.
holdoutActivity_percentage :: Lens' HoldoutActivity Int Source #
The percentage of participants who shouldn't continue the journey.
To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
ImportJobRequest
data ImportJobRequest Source #
Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.
See: newImportJobRequest smart constructor.
Constructors
| ImportJobRequest' | |
Fields
| |
Instances
Arguments
| :: DefinitionFormat | |
| -> Text | |
| -> Text | |
| -> ImportJobRequest |
Create a value of ImportJobRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defineSegment:ImportJobRequest', importJobRequest_defineSegment - Specifies whether to create a segment that contains the endpoints, when
the endpoint definitions are imported.
$sel:externalId:ImportJobRequest', importJobRequest_externalId - (Deprecated) Your AWS account ID, which you assigned to an external ID
key in an IAM trust policy. Amazon Pinpoint previously used this value
to assume an IAM role when importing endpoint definitions, but we
removed this requirement. We don't recommend use of external IDs for
IAM roles that are assumed by Amazon Pinpoint.
$sel:registerEndpoints:ImportJobRequest', importJobRequest_registerEndpoints - Specifies whether to register the endpoints with Amazon Pinpoint, when
the endpoint definitions are imported.
$sel:segmentId:ImportJobRequest', importJobRequest_segmentId - The identifier for the segment to update or add the imported endpoint
definitions to, if the import job is meant to update an existing
segment.
$sel:segmentName:ImportJobRequest', importJobRequest_segmentName - A custom name for the segment that's created by the import job, if the
value of the DefineSegment property is true.
$sel:format:ImportJobRequest', importJobRequest_format - The format of the files that contain the endpoint definitions to import.
Valid values are: CSV, for comma-separated values format; and, JSON, for
newline-delimited JSON format. If the Amazon S3 location stores multiple
files that use different formats, Amazon Pinpoint imports data only from
the files that use the specified format.
$sel:s3Url:ImportJobRequest', importJobRequest_s3Url - The URL of the Amazon Simple Storage Service (Amazon S3) bucket that
contains the endpoint definitions to import. This location can be a
folder or a single file. If the location is a folder, Amazon Pinpoint
imports endpoint definitions from the files in this location, including
any subfolders that the folder contains.
The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
$sel:roleArn:ImportJobRequest', importJobRequest_roleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that authorizes Amazon Pinpoint to access the Amazon S3
location to import endpoint definitions from.
importJobRequest_defineSegment :: Lens' ImportJobRequest (Maybe Bool) Source #
Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
importJobRequest_externalId :: Lens' ImportJobRequest (Maybe Text) Source #
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
importJobRequest_registerEndpoints :: Lens' ImportJobRequest (Maybe Bool) Source #
Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
importJobRequest_segmentId :: Lens' ImportJobRequest (Maybe Text) Source #
The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
importJobRequest_segmentName :: Lens' ImportJobRequest (Maybe Text) Source #
A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
importJobRequest_format :: Lens' ImportJobRequest DefinitionFormat Source #
The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
importJobRequest_s3Url :: Lens' ImportJobRequest Text Source #
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
importJobRequest_roleArn :: Lens' ImportJobRequest Text Source #
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
ImportJobResource
data ImportJobResource Source #
Provides information about the resource settings for a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.
See: newImportJobResource smart constructor.
Constructors
| ImportJobResource' | |
Fields
| |
Instances
Arguments
| :: DefinitionFormat | |
| -> Text | |
| -> Text | |
| -> ImportJobResource |
Create a value of ImportJobResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defineSegment:ImportJobResource', importJobResource_defineSegment - Specifies whether the import job creates a segment that contains the
endpoints, when the endpoint definitions are imported.
$sel:externalId:ImportJobResource', importJobResource_externalId - (Deprecated) Your AWS account ID, which you assigned to an external ID
key in an IAM trust policy. Amazon Pinpoint previously used this value
to assume an IAM role when importing endpoint definitions, but we
removed this requirement. We don't recommend use of external IDs for
IAM roles that are assumed by Amazon Pinpoint.
$sel:registerEndpoints:ImportJobResource', importJobResource_registerEndpoints - Specifies whether the import job registers the endpoints with Amazon
Pinpoint, when the endpoint definitions are imported.
$sel:segmentId:ImportJobResource', importJobResource_segmentId - The identifier for the segment that the import job updates or adds
endpoint definitions to, if the import job updates an existing segment.
$sel:segmentName:ImportJobResource', importJobResource_segmentName - The custom name for the segment that's created by the import job, if
the value of the DefineSegment property is true.
$sel:format:ImportJobResource', importJobResource_format - The format of the files that contain the endpoint definitions to import.
Valid values are: CSV, for comma-separated values format; and, JSON, for
newline-delimited JSON format.
If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
$sel:s3Url:ImportJobResource', importJobResource_s3Url - The URL of the Amazon Simple Storage Service (Amazon S3) bucket that
contains the endpoint definitions to import. This location can be a
folder or a single file. If the location is a folder, Amazon Pinpoint
imports endpoint definitions from the files in this location, including
any subfolders that the folder contains.
The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
$sel:roleArn:ImportJobResource', importJobResource_roleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that authorizes Amazon Pinpoint to access the Amazon S3
location to import endpoint definitions from.
importJobResource_defineSegment :: Lens' ImportJobResource (Maybe Bool) Source #
Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
importJobResource_externalId :: Lens' ImportJobResource (Maybe Text) Source #
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
importJobResource_registerEndpoints :: Lens' ImportJobResource (Maybe Bool) Source #
Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
importJobResource_segmentId :: Lens' ImportJobResource (Maybe Text) Source #
The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
importJobResource_segmentName :: Lens' ImportJobResource (Maybe Text) Source #
The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
importJobResource_format :: Lens' ImportJobResource DefinitionFormat Source #
The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
importJobResource_s3Url :: Lens' ImportJobResource Text Source #
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
importJobResource_roleArn :: Lens' ImportJobResource Text Source #
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
ImportJobResponse
data ImportJobResponse Source #
Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.
See: newImportJobResponse smart constructor.
Constructors
| ImportJobResponse' | |
Fields
| |
Instances
Arguments
| :: JobStatus | |
| -> Text | |
| -> Text | |
| -> ImportJobResource | |
| -> Text | |
| -> Text | |
| -> ImportJobResponse |
Create a value of ImportJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:completedPieces:ImportJobResponse', importJobResponse_completedPieces - The number of pieces that were processed successfully (completed) by the
import job, as of the time of the request.
$sel:completionDate:ImportJobResponse', importJobResponse_completionDate - The date, in ISO 8601 format, when the import job was completed.
$sel:failedPieces:ImportJobResponse', importJobResponse_failedPieces - The number of pieces that weren't processed successfully (failed) by
the import job, as of the time of the request.
$sel:failures:ImportJobResponse', importJobResponse_failures - An array of entries, one for each of the first 100 entries that weren't
processed successfully (failed) by the import job, if any.
$sel:totalFailures:ImportJobResponse', importJobResponse_totalFailures - The total number of endpoint definitions that weren't processed
successfully (failed) by the import job, typically because an error,
such as a syntax error, occurred.
$sel:totalPieces:ImportJobResponse', importJobResponse_totalPieces - The total number of pieces that must be processed to complete the import
job. Each piece consists of an approximately equal portion of the
endpoint definitions that are part of the import job.
$sel:totalProcessed:ImportJobResponse', importJobResponse_totalProcessed - The total number of endpoint definitions that were processed by the
import job.
$sel:jobStatus:ImportJobResponse', importJobResponse_jobStatus - The status of the import job. The job status is FAILED if Amazon
Pinpoint wasn't able to process one or more pieces in the job.
$sel:creationDate:ImportJobResponse', importJobResponse_creationDate - The date, in ISO 8601 format, when the import job was created.
$sel:type':ImportJobResponse', importJobResponse_type - The job type. This value is IMPORT for import jobs.
$sel:definition:ImportJobResponse', importJobResponse_definition - The resource settings that apply to the import job.
$sel:id:ImportJobResponse', importJobResponse_id - The unique identifier for the import job.
$sel:applicationId:ImportJobResponse', importJobResponse_applicationId - The unique identifier for the application that's associated with the
import job.
importJobResponse_completedPieces :: Lens' ImportJobResponse (Maybe Int) Source #
The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
importJobResponse_completionDate :: Lens' ImportJobResponse (Maybe Text) Source #
The date, in ISO 8601 format, when the import job was completed.
importJobResponse_failedPieces :: Lens' ImportJobResponse (Maybe Int) Source #
The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
importJobResponse_failures :: Lens' ImportJobResponse (Maybe [Text]) Source #
An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.
importJobResponse_totalFailures :: Lens' ImportJobResponse (Maybe Int) Source #
The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.
importJobResponse_totalPieces :: Lens' ImportJobResponse (Maybe Int) Source #
The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.
importJobResponse_totalProcessed :: Lens' ImportJobResponse (Maybe Int) Source #
The total number of endpoint definitions that were processed by the import job.
importJobResponse_jobStatus :: Lens' ImportJobResponse JobStatus Source #
The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
importJobResponse_creationDate :: Lens' ImportJobResponse Text Source #
The date, in ISO 8601 format, when the import job was created.
importJobResponse_type :: Lens' ImportJobResponse Text Source #
The job type. This value is IMPORT for import jobs.
importJobResponse_definition :: Lens' ImportJobResponse ImportJobResource Source #
The resource settings that apply to the import job.
importJobResponse_id :: Lens' ImportJobResponse Text Source #
The unique identifier for the import job.
importJobResponse_applicationId :: Lens' ImportJobResponse Text Source #
The unique identifier for the application that's associated with the import job.
ImportJobsResponse
data ImportJobsResponse Source #
Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.
See: newImportJobsResponse smart constructor.
Constructors
| ImportJobsResponse' | |
Fields
| |
Instances
newImportJobsResponse :: ImportJobsResponse Source #
Create a value of ImportJobsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ImportJobsResponse', importJobsResponse_nextToken - The string to use in a subsequent request to get the next page of
results in a paginated response. This value is null if there are no
additional pages.
$sel:item:ImportJobsResponse', importJobsResponse_item - An array of responses, one for each import job that's associated with
the application (Import Jobs resource) or segment (Segment Import Jobs
resource).
importJobsResponse_nextToken :: Lens' ImportJobsResponse (Maybe Text) Source #
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
importJobsResponse_item :: Lens' ImportJobsResponse [ImportJobResponse] Source #
An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).
InAppCampaignSchedule
data InAppCampaignSchedule Source #
Schedule of the campaign.
See: newInAppCampaignSchedule smart constructor.
Constructors
| InAppCampaignSchedule' | |
Fields
| |
Instances
newInAppCampaignSchedule :: InAppCampaignSchedule Source #
Create a value of InAppCampaignSchedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endDate:InAppCampaignSchedule', inAppCampaignSchedule_endDate - The scheduled time after which the in-app message should not be shown.
Timestamp is in ISO 8601 format.
$sel:eventFilter:InAppCampaignSchedule', inAppCampaignSchedule_eventFilter - The event filter the SDK has to use to show the in-app message in the
application.
$sel:quietTime:InAppCampaignSchedule', inAppCampaignSchedule_quietTime - Time during which the in-app message should not be shown to the user.
inAppCampaignSchedule_endDate :: Lens' InAppCampaignSchedule (Maybe Text) Source #
The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.
inAppCampaignSchedule_eventFilter :: Lens' InAppCampaignSchedule (Maybe CampaignEventFilter) Source #
The event filter the SDK has to use to show the in-app message in the application.
inAppCampaignSchedule_quietTime :: Lens' InAppCampaignSchedule (Maybe QuietTime) Source #
Time during which the in-app message should not be shown to the user.
InAppMessage
data InAppMessage Source #
Provides all fields required for building an in-app message.
See: newInAppMessage smart constructor.
Constructors
| InAppMessage' | |
Instances
newInAppMessage :: InAppMessage Source #
Create a value of InAppMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:content:InAppMessage', inAppMessage_content - In-app message content.
$sel:customConfig:InAppMessage', inAppMessage_customConfig - Custom config to be sent to SDK.
$sel:layout:InAppMessage', inAppMessage_layout - The layout of the message.
inAppMessage_content :: Lens' InAppMessage (Maybe [InAppMessageContent]) Source #
In-app message content.
inAppMessage_customConfig :: Lens' InAppMessage (Maybe (HashMap Text Text)) Source #
Custom config to be sent to SDK.
inAppMessage_layout :: Lens' InAppMessage (Maybe Layout) Source #
The layout of the message.
InAppMessageBodyConfig
data InAppMessageBodyConfig Source #
Text config for Message Body.
See: newInAppMessageBodyConfig smart constructor.
Constructors
| InAppMessageBodyConfig' | |
Instances
newInAppMessageBodyConfig Source #
Arguments
| :: Alignment | |
| -> Text | |
| -> Text | |
| -> InAppMessageBodyConfig |
Create a value of InAppMessageBodyConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alignment:InAppMessageBodyConfig', inAppMessageBodyConfig_alignment - The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
$sel:textColor:InAppMessageBodyConfig', inAppMessageBodyConfig_textColor - The text color.
$sel:body:InAppMessageBodyConfig', inAppMessageBodyConfig_body - Message Body.
inAppMessageBodyConfig_alignment :: Lens' InAppMessageBodyConfig Alignment Source #
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
inAppMessageBodyConfig_textColor :: Lens' InAppMessageBodyConfig Text Source #
The text color.
inAppMessageBodyConfig_body :: Lens' InAppMessageBodyConfig Text Source #
Message Body.
InAppMessageButton
data InAppMessageButton Source #
Button Config for an in-app message.
See: newInAppMessageButton smart constructor.
Constructors
| InAppMessageButton' | |
Fields
| |
Instances
newInAppMessageButton :: InAppMessageButton Source #
Create a value of InAppMessageButton with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:android:InAppMessageButton', inAppMessageButton_android - Default button content.
$sel:defaultConfig:InAppMessageButton', inAppMessageButton_defaultConfig - Default button content.
$sel:ios:InAppMessageButton', inAppMessageButton_ios - Default button content.
$sel:web:InAppMessageButton', inAppMessageButton_web - Default button content.
inAppMessageButton_android :: Lens' InAppMessageButton (Maybe OverrideButtonConfiguration) Source #
Default button content.
inAppMessageButton_defaultConfig :: Lens' InAppMessageButton (Maybe DefaultButtonConfiguration) Source #
Default button content.
inAppMessageButton_ios :: Lens' InAppMessageButton (Maybe OverrideButtonConfiguration) Source #
Default button content.
inAppMessageButton_web :: Lens' InAppMessageButton (Maybe OverrideButtonConfiguration) Source #
Default button content.
InAppMessageCampaign
data InAppMessageCampaign Source #
Targeted in-app message campaign.
See: newInAppMessageCampaign smart constructor.
Constructors
| InAppMessageCampaign' | |
Fields
| |
Instances
newInAppMessageCampaign :: InAppMessageCampaign Source #
Create a value of InAppMessageCampaign with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:campaignId:InAppMessageCampaign', inAppMessageCampaign_campaignId - Campaign id of the corresponding campaign.
$sel:dailyCap:InAppMessageCampaign', inAppMessageCampaign_dailyCap - Daily cap which controls the number of times any in-app messages can be
shown to the endpoint during a day.
$sel:inAppMessage:InAppMessageCampaign', inAppMessageCampaign_inAppMessage - In-app message content with all fields required for rendering an in-app
message.
$sel:priority:InAppMessageCampaign', inAppMessageCampaign_priority - Priority of the in-app message.
$sel:schedule:InAppMessageCampaign', inAppMessageCampaign_schedule - Schedule of the campaign.
$sel:sessionCap:InAppMessageCampaign', inAppMessageCampaign_sessionCap - Session cap which controls the number of times an in-app message can be
shown to the endpoint during an application session.
$sel:totalCap:InAppMessageCampaign', inAppMessageCampaign_totalCap - Total cap which controls the number of times an in-app message can be
shown to the endpoint.
$sel:treatmentId:InAppMessageCampaign', inAppMessageCampaign_treatmentId - Treatment id of the campaign.
inAppMessageCampaign_campaignId :: Lens' InAppMessageCampaign (Maybe Text) Source #
Campaign id of the corresponding campaign.
inAppMessageCampaign_dailyCap :: Lens' InAppMessageCampaign (Maybe Int) Source #
Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
inAppMessageCampaign_inAppMessage :: Lens' InAppMessageCampaign (Maybe InAppMessage) Source #
In-app message content with all fields required for rendering an in-app message.
inAppMessageCampaign_priority :: Lens' InAppMessageCampaign (Maybe Int) Source #
Priority of the in-app message.
inAppMessageCampaign_schedule :: Lens' InAppMessageCampaign (Maybe InAppCampaignSchedule) Source #
Schedule of the campaign.
inAppMessageCampaign_sessionCap :: Lens' InAppMessageCampaign (Maybe Int) Source #
Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
inAppMessageCampaign_totalCap :: Lens' InAppMessageCampaign (Maybe Int) Source #
Total cap which controls the number of times an in-app message can be shown to the endpoint.
inAppMessageCampaign_treatmentId :: Lens' InAppMessageCampaign (Maybe Text) Source #
Treatment id of the campaign.
InAppMessageContent
data InAppMessageContent Source #
The configuration for the message content.
See: newInAppMessageContent smart constructor.
Constructors
| InAppMessageContent' | |
Fields
| |
Instances
newInAppMessageContent :: InAppMessageContent Source #
Create a value of InAppMessageContent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backgroundColor:InAppMessageContent', inAppMessageContent_backgroundColor - The background color for the message.
$sel:bodyConfig:InAppMessageContent', inAppMessageContent_bodyConfig - The configuration for the message body.
$sel:headerConfig:InAppMessageContent', inAppMessageContent_headerConfig - The configuration for the message header.
$sel:imageUrl:InAppMessageContent', inAppMessageContent_imageUrl - The image url for the background of message.
$sel:primaryBtn:InAppMessageContent', inAppMessageContent_primaryBtn - The first button inside the message.
$sel:secondaryBtn:InAppMessageContent', inAppMessageContent_secondaryBtn - The second button inside message.
inAppMessageContent_backgroundColor :: Lens' InAppMessageContent (Maybe Text) Source #
The background color for the message.
inAppMessageContent_bodyConfig :: Lens' InAppMessageContent (Maybe InAppMessageBodyConfig) Source #
The configuration for the message body.
inAppMessageContent_headerConfig :: Lens' InAppMessageContent (Maybe InAppMessageHeaderConfig) Source #
The configuration for the message header.
inAppMessageContent_imageUrl :: Lens' InAppMessageContent (Maybe Text) Source #
The image url for the background of message.
inAppMessageContent_primaryBtn :: Lens' InAppMessageContent (Maybe InAppMessageButton) Source #
The first button inside the message.
inAppMessageContent_secondaryBtn :: Lens' InAppMessageContent (Maybe InAppMessageButton) Source #
The second button inside message.
InAppMessageHeaderConfig
data InAppMessageHeaderConfig Source #
Text config for Message Header.
See: newInAppMessageHeaderConfig smart constructor.
Constructors
| InAppMessageHeaderConfig' | |
Instances
newInAppMessageHeaderConfig Source #
Arguments
| :: Alignment | |
| -> Text | |
| -> Text | |
| -> InAppMessageHeaderConfig |
Create a value of InAppMessageHeaderConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alignment:InAppMessageHeaderConfig', inAppMessageHeaderConfig_alignment - The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
$sel:header:InAppMessageHeaderConfig', inAppMessageHeaderConfig_header - Message Header.
$sel:textColor:InAppMessageHeaderConfig', inAppMessageHeaderConfig_textColor - The text color.
inAppMessageHeaderConfig_alignment :: Lens' InAppMessageHeaderConfig Alignment Source #
The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
inAppMessageHeaderConfig_header :: Lens' InAppMessageHeaderConfig Text Source #
Message Header.
inAppMessageHeaderConfig_textColor :: Lens' InAppMessageHeaderConfig Text Source #
The text color.
InAppMessagesResponse
data InAppMessagesResponse Source #
Get in-app messages response object.
See: newInAppMessagesResponse smart constructor.
Constructors
| InAppMessagesResponse' | |
Fields
| |
Instances
newInAppMessagesResponse :: InAppMessagesResponse Source #
Create a value of InAppMessagesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inAppMessageCampaigns:InAppMessagesResponse', inAppMessagesResponse_inAppMessageCampaigns - List of targeted in-app message campaigns.
inAppMessagesResponse_inAppMessageCampaigns :: Lens' InAppMessagesResponse (Maybe [InAppMessageCampaign]) Source #
List of targeted in-app message campaigns.
InAppTemplateRequest
data InAppTemplateRequest Source #
InApp Template Request.
See: newInAppTemplateRequest smart constructor.
Constructors
| InAppTemplateRequest' | |
Fields
| |
Instances
newInAppTemplateRequest :: InAppTemplateRequest Source #
Create a value of InAppTemplateRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:content:InAppTemplateRequest', inAppTemplateRequest_content - The content of the message, can include up to 5 modals. Each modal must
contain a message, a header, and background color. ImageUrl and buttons
are optional.
$sel:customConfig:InAppTemplateRequest', inAppTemplateRequest_customConfig - Custom config to be sent to client.
$sel:layout:InAppTemplateRequest', inAppTemplateRequest_layout - The layout of the message.
$sel:templateDescription:InAppTemplateRequest', inAppTemplateRequest_templateDescription - The description of the template.
$sel:tags:InAppTemplateRequest', inAppTemplateRequest_tags - A string-to-string map of key-value pairs that defines the tags to
associate with the message template. Each tag consists of a required tag
key and an associated tag value.
inAppTemplateRequest_content :: Lens' InAppTemplateRequest (Maybe [InAppMessageContent]) Source #
The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
inAppTemplateRequest_customConfig :: Lens' InAppTemplateRequest (Maybe (HashMap Text Text)) Source #
Custom config to be sent to client.
inAppTemplateRequest_layout :: Lens' InAppTemplateRequest (Maybe Layout) Source #
The layout of the message.
inAppTemplateRequest_templateDescription :: Lens' InAppTemplateRequest (Maybe Text) Source #
The description of the template.
inAppTemplateRequest_tags :: Lens' InAppTemplateRequest (Maybe (HashMap Text Text)) Source #
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
InAppTemplateResponse
data InAppTemplateResponse Source #
In-App Template Response.
See: newInAppTemplateResponse smart constructor.
Constructors
| InAppTemplateResponse' | |
Fields
| |
Instances
newInAppTemplateResponse Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> TemplateType | |
| -> InAppTemplateResponse |
Create a value of InAppTemplateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:InAppTemplateResponse', inAppTemplateResponse_arn - The resource arn of the template.
$sel:content:InAppTemplateResponse', inAppTemplateResponse_content - The content of the message, can include up to 5 modals. Each modal must
contain a message, a header, and background color. ImageUrl and buttons
are optional.
$sel:customConfig:InAppTemplateResponse', inAppTemplateResponse_customConfig - Custom config to be sent to client.
$sel:layout:InAppTemplateResponse', inAppTemplateResponse_layout - The layout of the message.
$sel:templateDescription:InAppTemplateResponse', inAppTemplateResponse_templateDescription - The description of the template.
$sel:version:InAppTemplateResponse', inAppTemplateResponse_version - The version id of the template.
$sel:tags:InAppTemplateResponse', inAppTemplateResponse_tags - A string-to-string map of key-value pairs that defines the tags to
associate with the message template. Each tag consists of a required tag
key and an associated tag value.
$sel:lastModifiedDate:InAppTemplateResponse', inAppTemplateResponse_lastModifiedDate - The last modified date of the template.
$sel:creationDate:InAppTemplateResponse', inAppTemplateResponse_creationDate - The creation date of the template.
$sel:templateName:InAppTemplateResponse', inAppTemplateResponse_templateName - The name of the template.
$sel:templateType:InAppTemplateResponse', inAppTemplateResponse_templateType - The type of the template.
inAppTemplateResponse_arn :: Lens' InAppTemplateResponse (Maybe Text) Source #
The resource arn of the template.
inAppTemplateResponse_content :: Lens' InAppTemplateResponse (Maybe [InAppMessageContent]) Source #
The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
inAppTemplateResponse_customConfig :: Lens' InAppTemplateResponse (Maybe (HashMap Text Text)) Source #
Custom config to be sent to client.
inAppTemplateResponse_layout :: Lens' InAppTemplateResponse (Maybe Layout) Source #
The layout of the message.
inAppTemplateResponse_templateDescription :: Lens' InAppTemplateResponse (Maybe Text) Source #
The description of the template.
inAppTemplateResponse_version :: Lens' InAppTemplateResponse (Maybe Text) Source #
The version id of the template.
inAppTemplateResponse_tags :: Lens' InAppTemplateResponse (Maybe (HashMap Text Text)) Source #
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
inAppTemplateResponse_lastModifiedDate :: Lens' InAppTemplateResponse Text Source #
The last modified date of the template.
inAppTemplateResponse_creationDate :: Lens' InAppTemplateResponse Text Source #
The creation date of the template.
inAppTemplateResponse_templateName :: Lens' InAppTemplateResponse Text Source #
The name of the template.
inAppTemplateResponse_templateType :: Lens' InAppTemplateResponse TemplateType Source #
The type of the template.
ItemResponse
data ItemResponse Source #
Provides information about the results of a request to create or update an endpoint that's associated with an event.
See: newItemResponse smart constructor.
Constructors
| ItemResponse' | |
Fields
| |
Instances
newItemResponse :: ItemResponse Source #
Create a value of ItemResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointItemResponse:ItemResponse', itemResponse_endpointItemResponse - The response that was received after the endpoint data was accepted.
$sel:eventsItemResponse:ItemResponse', itemResponse_eventsItemResponse - A multipart response object that contains a key and a value for each
event in the request. In each object, the event ID is the key and an
EventItemResponse object is the value.
itemResponse_endpointItemResponse :: Lens' ItemResponse (Maybe EndpointItemResponse) Source #
The response that was received after the endpoint data was accepted.
itemResponse_eventsItemResponse :: Lens' ItemResponse (Maybe (HashMap Text EventItemResponse)) Source #
A multipart response object that contains a key and a value for each event in the request. In each object, the event ID is the key and an EventItemResponse object is the value.
JourneyChannelSettings
data JourneyChannelSettings Source #
The channel-specific configurations for the journey.
See: newJourneyChannelSettings smart constructor.
Constructors
| JourneyChannelSettings' | |
Fields
| |
Instances
newJourneyChannelSettings :: JourneyChannelSettings Source #
Create a value of JourneyChannelSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connectCampaignArn:JourneyChannelSettings', journeyChannelSettings_connectCampaignArn - Amazon Resource Name (ARN) of the Connect Campaign.
$sel:connectCampaignExecutionRoleArn:JourneyChannelSettings', journeyChannelSettings_connectCampaignExecutionRoleArn - IAM role ARN to be assumed when invoking Connect campaign execution APIs
for dialing.
journeyChannelSettings_connectCampaignArn :: Lens' JourneyChannelSettings (Maybe Text) Source #
Amazon Resource Name (ARN) of the Connect Campaign.
journeyChannelSettings_connectCampaignExecutionRoleArn :: Lens' JourneyChannelSettings (Maybe Text) Source #
IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
JourneyCustomMessage
data JourneyCustomMessage Source #
Specifies the message content for a custom channel message that's sent to participants in a journey.
See: newJourneyCustomMessage smart constructor.
Constructors
| JourneyCustomMessage' | |
Instances
newJourneyCustomMessage :: JourneyCustomMessage Source #
Create a value of JourneyCustomMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:data':JourneyCustomMessage', journeyCustomMessage_data - The message content that's passed to an AWS Lambda function or to a web
hook.
journeyCustomMessage_data :: Lens' JourneyCustomMessage (Maybe Text) Source #
The message content that's passed to an AWS Lambda function or to a web hook.
JourneyDateRangeKpiResponse
data JourneyDateRangeKpiResponse Source #
Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query.
See: newJourneyDateRangeKpiResponse smart constructor.
Constructors
| JourneyDateRangeKpiResponse' | |
Fields
| |
Instances
newJourneyDateRangeKpiResponse Source #
Arguments
| :: BaseKpiResult | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> Text | |
| -> JourneyDateRangeKpiResponse |
Create a value of JourneyDateRangeKpiResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_nextToken - The string to use in a subsequent request to get the next page of
results in a paginated response. This value is null for the Journey
Engagement Metrics resource because the resource returns all results in
a single page.
$sel:kpiResult:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_kpiResult - An array of objects that contains the results of the query. Each object
contains the value for the metric and metadata about that value.
$sel:kpiName:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_kpiName - The name of the metric, also referred to as a /key performance indicator
(KPI)/, that the data was retrieved for. This value describes the
associated metric and consists of two or more terms, which are comprised
of lowercase alphanumeric characters, separated by a hyphen. For a list
of possible values, see the
Amazon Pinpoint Developer Guide.
$sel:journeyId:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_journeyId - The unique identifier for the journey that the metric applies to.
$sel:endTime:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_endTime - The last date and time of the date range that was used to filter the
query results, in extended ISO 8601 format. The date range is inclusive.
$sel:startTime:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_startTime - The first date and time of the date range that was used to filter the
query results, in extended ISO 8601 format. The date range is inclusive.
$sel:applicationId:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_applicationId - The unique identifier for the application that the metric applies to.
journeyDateRangeKpiResponse_nextToken :: Lens' JourneyDateRangeKpiResponse (Maybe Text) Source #
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.
journeyDateRangeKpiResponse_kpiResult :: Lens' JourneyDateRangeKpiResponse BaseKpiResult Source #
An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
journeyDateRangeKpiResponse_kpiName :: Lens' JourneyDateRangeKpiResponse Text Source #
The name of the metric, also referred to as a /key performance indicator (KPI)/, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
journeyDateRangeKpiResponse_journeyId :: Lens' JourneyDateRangeKpiResponse Text Source #
The unique identifier for the journey that the metric applies to.
journeyDateRangeKpiResponse_endTime :: Lens' JourneyDateRangeKpiResponse UTCTime Source #
The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
journeyDateRangeKpiResponse_startTime :: Lens' JourneyDateRangeKpiResponse UTCTime Source #
The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
journeyDateRangeKpiResponse_applicationId :: Lens' JourneyDateRangeKpiResponse Text Source #
The unique identifier for the application that the metric applies to.
JourneyEmailMessage
data JourneyEmailMessage Source #
Specifies the "From" address for an email message that's sent to participants in a journey.
See: newJourneyEmailMessage smart constructor.
Constructors
| JourneyEmailMessage' | |
Fields
| |
Instances
newJourneyEmailMessage :: JourneyEmailMessage Source #
Create a value of JourneyEmailMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fromAddress:JourneyEmailMessage', journeyEmailMessage_fromAddress - The verified email address to send the email message from. The default
address is the FromAddress specified for the email channel for the
application.
journeyEmailMessage_fromAddress :: Lens' JourneyEmailMessage (Maybe Text) Source #
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
JourneyExecutionActivityMetricsResponse
data JourneyExecutionActivityMetricsResponse Source #
Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.
See: newJourneyExecutionActivityMetricsResponse smart constructor.
Constructors
| JourneyExecutionActivityMetricsResponse' | |
Fields
| |
Instances
newJourneyExecutionActivityMetricsResponse Source #
Arguments
Create a value of JourneyExecutionActivityMetricsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metrics:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_metrics - A JSON object that contains the results of the query. The results vary
depending on the type of activity (ActivityType). For information about
the structure and contents of the results, see the
Amazon Pinpoint Developer Guide.
$sel:journeyId:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_journeyId - The unique identifier for the journey that the metric applies to.
$sel:lastEvaluatedTime:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_lastEvaluatedTime - The date and time, in ISO 8601 format, when Amazon Pinpoint last
evaluated the execution status of the activity and updated the data for
the metric.
$sel:journeyActivityId:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_journeyActivityId - The unique identifier for the activity that the metric applies to.
$sel:activityType:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_activityType - The type of activity that the metric applies to. Possible values are:
- CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.
- HOLDOUT - For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.
- MESSAGE - For an email activity, which is an activity that sends an email message to participants.
- MULTI_CONDITIONAL_SPLIT - For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.
- RANDOM_SPLIT - For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.
- WAIT - For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
$sel:applicationId:JourneyExecutionActivityMetricsResponse', journeyExecutionActivityMetricsResponse_applicationId - The unique identifier for the application that the metric applies to.
journeyExecutionActivityMetricsResponse_metrics :: Lens' JourneyExecutionActivityMetricsResponse (HashMap Text Text) Source #
A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
journeyExecutionActivityMetricsResponse_journeyId :: Lens' JourneyExecutionActivityMetricsResponse Text Source #
The unique identifier for the journey that the metric applies to.
journeyExecutionActivityMetricsResponse_lastEvaluatedTime :: Lens' JourneyExecutionActivityMetricsResponse Text Source #
The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.
journeyExecutionActivityMetricsResponse_journeyActivityId :: Lens' JourneyExecutionActivityMetricsResponse Text Source #
The unique identifier for the activity that the metric applies to.
journeyExecutionActivityMetricsResponse_activityType :: Lens' JourneyExecutionActivityMetricsResponse Text Source #
The type of activity that the metric applies to. Possible values are:
- CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.
- HOLDOUT - For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.
- MESSAGE - For an email activity, which is an activity that sends an email message to participants.
- MULTI_CONDITIONAL_SPLIT - For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.
- RANDOM_SPLIT - For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.
- WAIT - For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
journeyExecutionActivityMetricsResponse_applicationId :: Lens' JourneyExecutionActivityMetricsResponse Text Source #
The unique identifier for the application that the metric applies to.
JourneyExecutionMetricsResponse
data JourneyExecutionMetricsResponse Source #
Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.
See: newJourneyExecutionMetricsResponse smart constructor.
Constructors
| JourneyExecutionMetricsResponse' | |
Fields
| |
Instances
newJourneyExecutionMetricsResponse Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> JourneyExecutionMetricsResponse |
Create a value of JourneyExecutionMetricsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metrics:JourneyExecutionMetricsResponse', journeyExecutionMetricsResponse_metrics - A JSON object that contains the results of the query. For information
about the structure and contents of the results, see the
Amazon Pinpoint Developer Guide.
$sel:journeyId:JourneyExecutionMetricsResponse', journeyExecutionMetricsResponse_journeyId - The unique identifier for the journey that the metric applies to.
$sel:lastEvaluatedTime:JourneyExecutionMetricsResponse', journeyExecutionMetricsResponse_lastEvaluatedTime - The date and time, in ISO 8601 format, when Amazon Pinpoint last
evaluated the journey and updated the data for the metric.
$sel:applicationId:JourneyExecutionMetricsResponse', journeyExecutionMetricsResponse_applicationId - The unique identifier for the application that the metric applies to.
journeyExecutionMetricsResponse_metrics :: Lens' JourneyExecutionMetricsResponse (HashMap Text Text) Source #
A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
journeyExecutionMetricsResponse_journeyId :: Lens' JourneyExecutionMetricsResponse Text Source #
The unique identifier for the journey that the metric applies to.
journeyExecutionMetricsResponse_lastEvaluatedTime :: Lens' JourneyExecutionMetricsResponse Text Source #
The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.
journeyExecutionMetricsResponse_applicationId :: Lens' JourneyExecutionMetricsResponse Text Source #
The unique identifier for the application that the metric applies to.
JourneyLimits
data JourneyLimits Source #
Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.
See: newJourneyLimits smart constructor.
Constructors
| JourneyLimits' | |
Fields
| |
Instances
newJourneyLimits :: JourneyLimits Source #
Create a value of JourneyLimits with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dailyCap:JourneyLimits', journeyLimits_dailyCap - The maximum number of messages that the journey can send to a single
participant during a 24-hour period. The maximum value is 100.
$sel:endpointReentryCap:JourneyLimits', journeyLimits_endpointReentryCap - The maximum number of times that a participant can enter the journey.
The maximum value is 100. To allow participants to enter the journey an
unlimited number of times, set this value to 0.
$sel:endpointReentryInterval:JourneyLimits', journeyLimits_endpointReentryInterval - Minimum time that must pass before an endpoint can re-enter a given
journey. The duration should use an ISO 8601 format, such as PT1H.
$sel:messagesPerSecond:JourneyLimits', journeyLimits_messagesPerSecond - The maximum number of messages that the journey can send each second.
journeyLimits_dailyCap :: Lens' JourneyLimits (Maybe Int) Source #
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
journeyLimits_endpointReentryCap :: Lens' JourneyLimits (Maybe Int) Source #
The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
journeyLimits_endpointReentryInterval :: Lens' JourneyLimits (Maybe Text) Source #
Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.
journeyLimits_messagesPerSecond :: Lens' JourneyLimits (Maybe Int) Source #
The maximum number of messages that the journey can send each second.
JourneyPushMessage
data JourneyPushMessage Source #
Specifies the message configuration for a push notification that's sent to participants in a journey.
See: newJourneyPushMessage smart constructor.
Constructors
| JourneyPushMessage' | |
Fields
| |
Instances
newJourneyPushMessage :: JourneyPushMessage Source #
Create a value of JourneyPushMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timeToLive:JourneyPushMessage', journeyPushMessage_timeToLive - The number of seconds that the push notification service should keep the
message, if the service is unable to deliver the notification the first
time. This value is converted to an expiration value when it's sent to
a push-notification service. If this value is 0, the service treats the
notification as if it expires immediately and the service doesn't store
or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
journeyPushMessage_timeToLive :: Lens' JourneyPushMessage (Maybe Text) Source #
The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
JourneyResponse
data JourneyResponse Source #
Provides information about the status, configuration, and other settings for a journey.
See: newJourneyResponse smart constructor.
Constructors
| JourneyResponse' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> JourneyResponse |
Create a value of JourneyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:activities:JourneyResponse', journeyResponse_activities - A map that contains a set of Activity objects, one object for each
activity in the journey. For each Activity object, the key is the unique
identifier (string) for an activity and the value is the settings for
the activity.
$sel:closedDays:JourneyResponse', journeyResponse_closedDays - The time when journey will stop sending messages. QuietTime should be
configured first and SendingSchedule should be set to true.
$sel:creationDate:JourneyResponse', journeyResponse_creationDate - The date, in ISO 8601 format, when the journey was created.
$sel:journeyChannelSettings:JourneyResponse', journeyResponse_journeyChannelSettings - The channel-specific configurations for the journey.
$sel:lastModifiedDate:JourneyResponse', journeyResponse_lastModifiedDate - The date, in ISO 8601 format, when the journey was last modified.
$sel:limits:JourneyResponse', journeyResponse_limits - The messaging and entry limits for the journey.
$sel:localTime:JourneyResponse', journeyResponse_localTime - Specifies whether the journey's scheduled start and end times use each
participant's local time. If this value is true, the schedule uses each
participant's local time.
$sel:openHours:JourneyResponse', journeyResponse_openHours - The time when journey allow to send messages. QuietTime should be
configured first and SendingSchedule should be set to true.
$sel:quietTime:JourneyResponse', journeyResponse_quietTime - The quiet time settings for the journey. Quiet time is a specific time
range when a journey doesn't send messages to participants, if all the
following conditions are met:
- The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
- The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
- The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
$sel:refreshFrequency:JourneyResponse', journeyResponse_refreshFrequency - The frequency with which Amazon Pinpoint evaluates segment and event
data for the journey, as a duration in ISO 8601 format.
$sel:refreshOnSegmentUpdate:JourneyResponse', journeyResponse_refreshOnSegmentUpdate - Specifies whether a journey should be refreshed on segment update.
$sel:schedule:JourneyResponse', journeyResponse_schedule - The schedule settings for the journey.
$sel:sendingSchedule:JourneyResponse', journeyResponse_sendingSchedule - Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays).
This flag should be set to true in order to allow (OpenHours and
ClosedDays)
$sel:startActivity:JourneyResponse', journeyResponse_startActivity - The unique identifier for the first activity in the journey.
$sel:startCondition:JourneyResponse', journeyResponse_startCondition - The segment that defines which users are participants in the journey.
$sel:state:JourneyResponse', journeyResponse_state - The current status of the journey. Possible values are:
- DRAFT - The journey is being developed and hasn't been published yet.
- ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
- COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
- CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
- CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
$sel:waitForQuietTime:JourneyResponse', journeyResponse_waitForQuietTime - Specifies whether endpoints in quiet hours should enter a wait till the
end of their quiet hours.
$sel:tags:JourneyResponse', journeyResponse_tags - This object is not used or supported.
$sel:name:JourneyResponse', journeyResponse_name - The name of the journey.
$sel:id:JourneyResponse', journeyResponse_id - The unique identifier for the journey.
$sel:applicationId:JourneyResponse', journeyResponse_applicationId - The unique identifier for the application that the journey applies to.
journeyResponse_activities :: Lens' JourneyResponse (Maybe (HashMap Text Activity)) Source #
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
journeyResponse_closedDays :: Lens' JourneyResponse (Maybe ClosedDays) Source #
The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.
journeyResponse_creationDate :: Lens' JourneyResponse (Maybe Text) Source #
The date, in ISO 8601 format, when the journey was created.
journeyResponse_journeyChannelSettings :: Lens' JourneyResponse (Maybe JourneyChannelSettings) Source #
The channel-specific configurations for the journey.
journeyResponse_lastModifiedDate :: Lens' JourneyResponse (Maybe Text) Source #
The date, in ISO 8601 format, when the journey was last modified.
journeyResponse_limits :: Lens' JourneyResponse (Maybe JourneyLimits) Source #
The messaging and entry limits for the journey.
journeyResponse_localTime :: Lens' JourneyResponse (Maybe Bool) Source #
Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
journeyResponse_openHours :: Lens' JourneyResponse (Maybe OpenHours) Source #
The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.
journeyResponse_quietTime :: Lens' JourneyResponse (Maybe QuietTime) Source #
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
- The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
- The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
- The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
journeyResponse_refreshFrequency :: Lens' JourneyResponse (Maybe Text) Source #
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
journeyResponse_refreshOnSegmentUpdate :: Lens' JourneyResponse (Maybe Bool) Source #
Specifies whether a journey should be refreshed on segment update.
journeyResponse_schedule :: Lens' JourneyResponse (Maybe JourneySchedule) Source #
The schedule settings for the journey.
journeyResponse_sendingSchedule :: Lens' JourneyResponse (Maybe Bool) Source #
Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)
journeyResponse_startActivity :: Lens' JourneyResponse (Maybe Text) Source #
The unique identifier for the first activity in the journey.
journeyResponse_startCondition :: Lens' JourneyResponse (Maybe StartCondition) Source #
The segment that defines which users are participants in the journey.
journeyResponse_state :: Lens' JourneyResponse (Maybe State) Source #
The current status of the journey. Possible values are:
- DRAFT - The journey is being developed and hasn't been published yet.
- ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
- COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.
- CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.
- CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
journeyResponse_waitForQuietTime :: Lens' JourneyResponse (Maybe Bool) Source #
Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
journeyResponse_tags :: Lens' JourneyResponse (Maybe (HashMap Text Text)) Source #
This object is not used or supported.
journeyResponse_name :: Lens' JourneyResponse Text Source #
The name of the journey.
journeyResponse_id :: Lens' JourneyResponse Text Source #
The unique identifier for the journey.
journeyResponse_applicationId :: Lens' JourneyResponse Text Source #
The unique identifier for the application that the journey applies to.
JourneySMSMessage
data JourneySMSMessage Source #
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
See: newJourneySMSMessage smart constructor.
Constructors
| JourneySMSMessage' | |
Fields
| |
Instances
newJourneySMSMessage :: JourneySMSMessage Source #
Create a value of JourneySMSMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entityId:JourneySMSMessage', journeySMSMessage_entityId - The entity ID or Principal Entity (PE) id received from the regulatory
body for sending SMS in your country.
$sel:messageType:JourneySMSMessage', journeySMSMessage_messageType - The SMS message type. Valid values are TRANSACTIONAL (for messages that
are critical or time-sensitive, such as a one-time passwords) and
PROMOTIONAL (for messsages that aren't critical or time-sensitive, such
as marketing messages).
$sel:originationNumber:JourneySMSMessage', journeySMSMessage_originationNumber - The long code to send the SMS message from. This value should be one of
the dedicated long codes that's assigned to your AWS account. Although
it isn't required, we recommend that you specify the long code using an
E.164 format to ensure prompt and accurate delivery of the message. For
example, +12065550100.
$sel:senderId:JourneySMSMessage', journeySMSMessage_senderId - The sender ID to display as the sender of the message on a recipient's
device. Support for sender IDs varies by country or region. For more
information, see
Supported Countries and Regions
in the Amazon Pinpoint User Guide.
$sel:templateId:JourneySMSMessage', journeySMSMessage_templateId - The template ID received from the regulatory body for sending SMS in
your country.
journeySMSMessage_entityId :: Lens' JourneySMSMessage (Maybe Text) Source #
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
journeySMSMessage_messageType :: Lens' JourneySMSMessage (Maybe MessageType) Source #
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
journeySMSMessage_originationNumber :: Lens' JourneySMSMessage (Maybe Text) Source #
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
journeySMSMessage_senderId :: Lens' JourneySMSMessage (Maybe Text) Source #
The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
journeySMSMessage_templateId :: Lens' JourneySMSMessage (Maybe Text) Source #
The template ID received from the regulatory body for sending SMS in your country.
JourneySchedule
data JourneySchedule Source #
Specifies the schedule settings for a journey.
See: newJourneySchedule smart constructor.
Constructors
| JourneySchedule' | |
Fields
| |
Instances
newJourneySchedule :: JourneySchedule Source #
Create a value of JourneySchedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endTime:JourneySchedule', journeySchedule_endTime - The scheduled time, in ISO 8601 format, when the journey ended or will
end.
$sel:startTime:JourneySchedule', journeySchedule_startTime - The scheduled time, in ISO 8601 format, when the journey began or will
begin.
$sel:timezone:JourneySchedule', journeySchedule_timezone - The starting UTC offset for the journey schedule, if the value of the
journey's LocalTime property is true. Valid values are: UTC, UTC+01,
UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30,
UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09,
UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13,
UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06,
UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
journeySchedule_endTime :: Lens' JourneySchedule (Maybe UTCTime) Source #
The scheduled time, in ISO 8601 format, when the journey ended or will end.
journeySchedule_startTime :: Lens' JourneySchedule (Maybe UTCTime) Source #
The scheduled time, in ISO 8601 format, when the journey began or will begin.
journeySchedule_timezone :: Lens' JourneySchedule (Maybe Text) Source #
The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.
JourneyStateRequest
data JourneyStateRequest Source #
Changes the status of a journey.
See: newJourneyStateRequest smart constructor.
Constructors
| JourneyStateRequest' | |
Fields
| |
Instances
newJourneyStateRequest :: JourneyStateRequest Source #
Create a value of JourneyStateRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:state:JourneyStateRequest', journeyStateRequest_state - The status of the journey. Currently, Supported values are ACTIVE,
PAUSED, and CANCELLED
If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.
After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.
When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.
journeyStateRequest_state :: Lens' JourneyStateRequest (Maybe State) Source #
The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED
If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.
After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.
When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.
JourneysResponse
data JourneysResponse Source #
Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.
See: newJourneysResponse smart constructor.
Constructors
| JourneysResponse' | |
Fields
| |
Instances
newJourneysResponse :: JourneysResponse Source #
Create a value of JourneysResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:JourneysResponse', journeysResponse_nextToken - The string to use in a subsequent request to get the next page of
results in a paginated response. This value is null if there are no
additional pages.
$sel:item:JourneysResponse', journeysResponse_item - An array of responses, one for each journey that's associated with the
application.
journeysResponse_nextToken :: Lens' JourneysResponse (Maybe Text) Source #
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
journeysResponse_item :: Lens' JourneysResponse [JourneyResponse] Source #
An array of responses, one for each journey that's associated with the application.
ListRecommenderConfigurationsResponse
data ListRecommenderConfigurationsResponse Source #
Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
See: newListRecommenderConfigurationsResponse smart constructor.
Constructors
| ListRecommenderConfigurationsResponse' | |
Fields
| |
Instances
newListRecommenderConfigurationsResponse :: ListRecommenderConfigurationsResponse Source #
Create a value of ListRecommenderConfigurationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListRecommenderConfigurationsResponse', listRecommenderConfigurationsResponse_nextToken - The string to use in a subsequent request to get the next page of
results in a paginated response. This value is null if there are no
additional pages.
$sel:item:ListRecommenderConfigurationsResponse', listRecommenderConfigurationsResponse_item - An array of responses, one for each recommender model configuration
that's associated with your Amazon Pinpoint account.
listRecommenderConfigurationsResponse_nextToken :: Lens' ListRecommenderConfigurationsResponse (Maybe Text) Source #
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
listRecommenderConfigurationsResponse_item :: Lens' ListRecommenderConfigurationsResponse [RecommenderConfigurationResponse] Source #
An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.
Message
Specifies the content and settings for a push notification that's sent to recipients of a campaign.
See: newMessage smart constructor.
Constructors
| Message' | |
Fields
| |
Instances
newMessage :: Message Source #
Create a value of Message with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:Message', message_action - The action to occur if a recipient taps the push notification. Valid
values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
$sel:body:Message', message_body - The body of the notification message. The maximum number of characters
is 200.
$sel:imageIconUrl:Message', message_imageIconUrl - The URL of the image to display as the push-notification icon, such as
the icon for the app.
$sel:imageSmallIconUrl:Message', message_imageSmallIconUrl - The URL of the image to display as the small, push-notification icon,
such as a small version of the icon for the app.
$sel:imageUrl:Message', message_imageUrl - The URL of an image to display in the push notification.
$sel:jsonBody:Message', message_jsonBody - The JSON payload to use for a silent push notification.
$sel:mediaUrl:Message', message_mediaUrl - The URL of the image or video to display in the push notification.
$sel:rawContent:Message', message_rawContent - The raw, JSON-formatted string to use as the payload for the
notification message. If specified, this value overrides all other
content for the message.
$sel:silentPush:Message', message_silentPush - Specifies whether the notification is a silent push notification, which
is a push notification that doesn't display on a recipient's device.
Silent push notifications can be used for cases such as updating an
app's configuration, displaying messages in an in-app message center,
or supporting phone home functionality.
$sel:timeToLive:Message', message_timeToLive - The number of seconds that the push-notification service should keep the
message, if the service is unable to deliver the notification the first
time. This value is converted to an expiration value when it's sent to
a push-notification service. If this value is 0, the service treats the
notification as if it expires immediately and the service doesn't store
or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
$sel:title:Message', message_title - The title to display above the notification message on a recipient's
device.
$sel:url:Message', message_url - The URL to open in a recipient's default mobile browser, if a recipient
taps the push notification and the value of the Action property is URL.
message_action :: Lens' Message (Maybe Action) Source #
The action to occur if a recipient taps the push notification. Valid values are:
- OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
- DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
message_body :: Lens' Message (Maybe Text) Source #
The body of the notification message. The maximum number of characters is 200.
message_imageIconUrl :: Lens' Message (Maybe Text) Source #
The URL of the image to display as the push-notification icon, such as the icon for the app.
message_imageSmallIconUrl :: Lens' Message (Maybe Text) Source #
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
message_imageUrl :: Lens' Message (Maybe Text) Source #
The URL of an image to display in the push notification.
message_jsonBody :: Lens' Message (Maybe Text) Source #
The JSON payload to use for a silent push notification.
message_mediaUrl :: Lens' Message (Maybe Text) Source #
The URL of the image or video to display in the push notification.
message_rawContent :: Lens' Message (Maybe Text) Source #
The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
message_silentPush :: Lens' Message (Maybe Bool) Source #
Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
message_timeToLive :: Lens' Message (Maybe Int) Source #
The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
message_title :: Lens' Message (Maybe Text) Source #
The title to display above the notification message on a recipient's device.
message_url :: Lens' Message (Maybe Text) Source #
The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
MessageBody
data MessageBody Source #
Provides information about an API request or response.
See: newMessageBody smart constructor.
Constructors
| MessageBody' | |
Instances
newMessageBody :: MessageBody Source #
Create a value of MessageBody with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:MessageBody', messageBody_message - The message that's returned from the API.
$sel:requestID:MessageBody', messageBody_requestID - The unique identifier for the request or response.
messageBody_message :: Lens' MessageBody (Maybe Text) Source #
The message that's returned from the API.
messageBody_requestID :: Lens' MessageBody (Maybe Text) Source #
The unique identifier for the request or response.
MessageConfiguration
data MessageConfiguration Source #
Specifies the message configuration settings for a campaign.
See: newMessageConfiguration smart constructor.
Constructors
| MessageConfiguration' | |
Fields
| |
Instances
newMessageConfiguration :: MessageConfiguration Source #
Create a value of MessageConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aDMMessage:MessageConfiguration', messageConfiguration_aDMMessage - The message that the campaign sends through the ADM (Amazon Device
Messaging) channel. If specified, this message overrides the default
message.
$sel:aPNSMessage:MessageConfiguration', messageConfiguration_aPNSMessage - The message that the campaign sends through the APNs (Apple Push
Notification service) channel. If specified, this message overrides the
default message.
$sel:baiduMessage:MessageConfiguration', messageConfiguration_baiduMessage - The message that the campaign sends through the Baidu (Baidu Cloud Push)
channel. If specified, this message overrides the default message.
$sel:customMessage:MessageConfiguration', messageConfiguration_customMessage - The message that the campaign sends through a custom channel, as
specified by the delivery configuration (CustomDeliveryConfiguration)
settings for the campaign. If specified, this message overrides the
default message.
$sel:defaultMessage:MessageConfiguration', messageConfiguration_defaultMessage - The default message that the campaign sends through all the channels
that are configured for the campaign.
$sel:emailMessage:MessageConfiguration', messageConfiguration_emailMessage - The message that the campaign sends through the email channel. If
specified, this message overrides the default message.
$sel:gCMMessage:MessageConfiguration', messageConfiguration_gCMMessage - The message that the campaign sends through the GCM channel, which
enables Amazon Pinpoint to send push notifications through the Firebase
Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
If specified, this message overrides the default message.
$sel:inAppMessage:MessageConfiguration', messageConfiguration_inAppMessage - The in-app message configuration.
$sel:sMSMessage:MessageConfiguration', messageConfiguration_sMSMessage - The message that the campaign sends through the SMS channel. If
specified, this message overrides the default message.
messageConfiguration_aDMMessage :: Lens' MessageConfiguration (Maybe Message) Source #
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
messageConfiguration_aPNSMessage :: Lens' MessageConfiguration (Maybe Message) Source #
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
messageConfiguration_baiduMessage :: Lens' MessageConfiguration (Maybe Message) Source #
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
messageConfiguration_customMessage :: Lens' MessageConfiguration (Maybe CampaignCustomMessage) Source #
The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
messageConfiguration_defaultMessage :: Lens' MessageConfiguration (Maybe Message) Source #
The default message that the campaign sends through all the channels that are configured for the campaign.
messageConfiguration_emailMessage :: Lens' MessageConfiguration (Maybe CampaignEmailMessage) Source #
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
messageConfiguration_gCMMessage :: Lens' MessageConfiguration (Maybe Message) Source #
The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
messageConfiguration_inAppMessage :: Lens' MessageConfiguration (Maybe CampaignInAppMessage) Source #
The in-app message configuration.
messageConfiguration_sMSMessage :: Lens' MessageConfiguration (Maybe CampaignSmsMessage) Source #
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
MessageRequest
data MessageRequest Source #
Specifies the configuration and other settings for a message.
See: newMessageRequest smart constructor.
Constructors
| MessageRequest' | |
Fields
| |
Instances
Create a value of MessageRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:addresses:MessageRequest', messageRequest_addresses - A map of key-value pairs, where each key is an address and each value is
an
AddressConfiguration
object. An address can be a push notification token, a phone number, or
an email address. You can use an
AddressConfiguration
object to tailor the message for an address by specifying settings such
as content overrides and message variables.
MessageRequest, messageRequest_context - A map of custom attributes to attach to the message. For a push
notification, this payload is added to the data.pinpoint object. For an
email or text message, this payload is added to email/SMS delivery
receipt event attributes.
$sel:endpoints:MessageRequest', messageRequest_endpoints - A map of key-value pairs, where each key is an endpoint ID and each
value is an
EndpointSendConfiguration
object. You can use an
EndpointSendConfiguration
object to tailor the message for an endpoint by specifying settings such
as content overrides and message variables.
$sel:templateConfiguration:MessageRequest', messageRequest_templateConfiguration - The message template to use for the message.
$sel:traceId:MessageRequest', messageRequest_traceId - The unique identifier for tracing the message. This identifier is
visible to message recipients.
$sel:messageConfiguration:MessageRequest', messageRequest_messageConfiguration - The settings and content for the default message and any default
messages that you defined for specific channels.
messageRequest_addresses :: Lens' MessageRequest (Maybe (HashMap Text AddressConfiguration)) Source #
A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
messageRequest_context :: Lens' MessageRequest (Maybe (HashMap Text Text)) Source #
A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
messageRequest_endpoints :: Lens' MessageRequest (Maybe (HashMap Text EndpointSendConfiguration)) Source #
A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.
messageRequest_templateConfiguration :: Lens' MessageRequest (Maybe TemplateConfiguration) Source #
The message template to use for the message.
messageRequest_traceId :: Lens' MessageRequest (Maybe Text) Source #
The unique identifier for tracing the message. This identifier is visible to message recipients.
messageRequest_messageConfiguration :: Lens' MessageRequest DirectMessageConfiguration Source #
The settings and content for the default message and any default messages that you defined for specific channels.
MessageResponse
data MessageResponse Source #
Provides information about the results of a request to send a message to an endpoint address.
See: newMessageResponse smart constructor.
Constructors
| MessageResponse' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> MessageResponse |
Create a value of MessageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointResult:MessageResponse', messageResponse_endpointResult - A map that contains a multipart response for each address that the
message was sent to. In the map, the endpoint ID is the key and the
result is the value.
$sel:requestId:MessageResponse', messageResponse_requestId - The identifier for the original request that the message was delivered
for.
$sel:result:MessageResponse', messageResponse_result - A map that contains a multipart response for each address (email
address, phone number, or push notification token) that the message was
sent to. In the map, the address is the key and the result is the value.
$sel:applicationId:MessageResponse', messageResponse_applicationId - The unique identifier for the application that was used to send the
message.
messageResponse_endpointResult :: Lens' MessageResponse (Maybe (HashMap Text EndpointMessageResult)) Source #
A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.
messageResponse_requestId :: Lens' MessageResponse (Maybe Text) Source #
The identifier for the original request that the message was delivered for.
messageResponse_result :: Lens' MessageResponse (Maybe (HashMap Text MessageResult)) Source #
A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.
messageResponse_applicationId :: Lens' MessageResponse Text Source #
The unique identifier for the application that was used to send the message.
MessageResult
data MessageResult Source #
Provides information about the results of sending a message directly to an endpoint address.
See: newMessageResult smart constructor.
Constructors
| MessageResult' | |
Fields
| |
Instances
Arguments
| :: DeliveryStatus | |
| -> Int | |
| -> MessageResult |
Create a value of MessageResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:messageId:MessageResult', messageResult_messageId - The unique identifier for the message that was sent.
$sel:statusMessage:MessageResult', messageResult_statusMessage - The status message for delivering the message.
$sel:updatedToken:MessageResult', messageResult_updatedToken - For push notifications that are sent through the GCM channel, specifies
whether the endpoint's device registration token was updated as part of
delivering the message.
$sel:deliveryStatus:MessageResult', messageResult_deliveryStatus - The delivery status of the message. Possible values are:
- DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
- OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
- PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
- SUCCESSFUL - The message was successfully delivered to the endpoint address.
- TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
- THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
- TIMEOUT - The message couldn't be sent within the timeout period.
- UNKNOWN_FAILURE - An unknown error occurred.
$sel:statusCode:MessageResult', messageResult_statusCode - The downstream service status code for delivering the message.
messageResult_messageId :: Lens' MessageResult (Maybe Text) Source #
The unique identifier for the message that was sent.
messageResult_statusMessage :: Lens' MessageResult (Maybe Text) Source #
The status message for delivering the message.
messageResult_updatedToken :: Lens' MessageResult (Maybe Text) Source #
For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
messageResult_deliveryStatus :: Lens' MessageResult DeliveryStatus Source #
The delivery status of the message. Possible values are:
- DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
- OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
- PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
- SUCCESSFUL - The message was successfully delivered to the endpoint address.
- TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
- THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
- TIMEOUT - The message couldn't be sent within the timeout period.
- UNKNOWN_FAILURE - An unknown error occurred.
messageResult_statusCode :: Lens' MessageResult Int Source #
The downstream service status code for delivering the message.
MetricDimension
data MetricDimension Source #
Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.
See: newMetricDimension smart constructor.
Constructors
| MetricDimension' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Double | |
| -> MetricDimension |
Create a value of MetricDimension with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comparisonOperator:MetricDimension', metricDimension_comparisonOperator - The operator to use when comparing metric values. Valid values are:
GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and
EQUAL.
$sel:value:MetricDimension', metricDimension_value - The value to compare.
metricDimension_comparisonOperator :: Lens' MetricDimension Text Source #
The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
metricDimension_value :: Lens' MetricDimension Double Source #
The value to compare.
MultiConditionalBranch
data MultiConditionalBranch Source #
Specifies a condition to evaluate for an activity path in a journey.
See: newMultiConditionalBranch smart constructor.
Constructors
| MultiConditionalBranch' | |
Fields
| |
Instances
newMultiConditionalBranch :: MultiConditionalBranch Source #
Create a value of MultiConditionalBranch with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:condition:MultiConditionalBranch', multiConditionalBranch_condition - The condition to evaluate for the activity path.
$sel:nextActivity:MultiConditionalBranch', multiConditionalBranch_nextActivity - The unique identifier for the next activity to perform, after completing
the activity for the path.
multiConditionalBranch_condition :: Lens' MultiConditionalBranch (Maybe SimpleCondition) Source #
The condition to evaluate for the activity path.
multiConditionalBranch_nextActivity :: Lens' MultiConditionalBranch (Maybe Text) Source #
The unique identifier for the next activity to perform, after completing the activity for the path.
MultiConditionalSplitActivity
data MultiConditionalSplitActivity Source #
Specifies the settings for a multivariate split activity in a journey. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
To create multivariate split activities that send participants down different paths based on push notification events (such as Open or Received events), your mobile app has to specify the User ID and Endpoint ID values. For more information, see Integrating Amazon Pinpoint with your application in the Amazon Pinpoint Developer Guide.
See: newMultiConditionalSplitActivity smart constructor.
Constructors
| MultiConditionalSplitActivity' | |
Fields
| |
Instances
newMultiConditionalSplitActivity :: MultiConditionalSplitActivity Source #
Create a value of MultiConditionalSplitActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:branches:MultiConditionalSplitActivity', multiConditionalSplitActivity_branches - The paths for the activity, including the conditions for entering each
path and the activity to perform for each path.
$sel:defaultActivity:MultiConditionalSplitActivity', multiConditionalSplitActivity_defaultActivity - The unique identifier for the activity to perform for participants who
don't meet any of the conditions specified for other paths in the
activity.
$sel:evaluationWaitTime:MultiConditionalSplitActivity', multiConditionalSplitActivity_evaluationWaitTime - The amount of time to wait or the date and time when Amazon Pinpoint
determines whether the conditions are met.
multiConditionalSplitActivity_branches :: Lens' MultiConditionalSplitActivity (Maybe [MultiConditionalBranch]) Source #
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
multiConditionalSplitActivity_defaultActivity :: Lens' MultiConditionalSplitActivity (Maybe Text) Source #
The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
multiConditionalSplitActivity_evaluationWaitTime :: Lens' MultiConditionalSplitActivity (Maybe WaitTime) Source #
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
NumberValidateRequest
data NumberValidateRequest Source #
Specifies a phone number to validate and retrieve information about.
See: newNumberValidateRequest smart constructor.
Constructors
| NumberValidateRequest' | |
Fields
| |
Instances
newNumberValidateRequest :: NumberValidateRequest Source #
Create a value of NumberValidateRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:isoCountryCode:NumberValidateRequest', numberValidateRequest_isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region where the phone number was originally registered.
$sel:phoneNumber:NumberValidateRequest', numberValidateRequest_phoneNumber - The phone number to retrieve information about. The phone number that
you provide should include a valid numeric country code. Otherwise, the
operation might result in an error.
numberValidateRequest_isoCountryCode :: Lens' NumberValidateRequest (Maybe Text) Source #
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
numberValidateRequest_phoneNumber :: Lens' NumberValidateRequest (Maybe Text) Source #
The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.
NumberValidateResponse
data NumberValidateResponse Source #
Provides information about a phone number.
See: newNumberValidateResponse smart constructor.
Constructors
| NumberValidateResponse' | |
Fields
| |
Instances
newNumberValidateResponse :: NumberValidateResponse Source #
Create a value of NumberValidateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:carrier:NumberValidateResponse', numberValidateResponse_carrier - The carrier or service provider that the phone number is currently
registered with. In some countries and regions, this value may be the
carrier or service provider that the phone number was originally
registered with.
$sel:city:NumberValidateResponse', numberValidateResponse_city - The name of the city where the phone number was originally registered.
$sel:cleansedPhoneNumberE164:NumberValidateResponse', numberValidateResponse_cleansedPhoneNumberE164 - The cleansed phone number, in E.164 format, for the location where the
phone number was originally registered.
$sel:cleansedPhoneNumberNational:NumberValidateResponse', numberValidateResponse_cleansedPhoneNumberNational - The cleansed phone number, in the format for the location where the
phone number was originally registered.
$sel:country:NumberValidateResponse', numberValidateResponse_country - The name of the country or region where the phone number was originally
registered.
$sel:countryCodeIso2:NumberValidateResponse', numberValidateResponse_countryCodeIso2 - The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region where the phone number was originally registered.
$sel:countryCodeNumeric:NumberValidateResponse', numberValidateResponse_countryCodeNumeric - The numeric code for the country or region where the phone number was
originally registered.
$sel:county:NumberValidateResponse', numberValidateResponse_county - The name of the county where the phone number was originally registered.
$sel:originalCountryCodeIso2:NumberValidateResponse', numberValidateResponse_originalCountryCodeIso2 - The two-character code, in ISO 3166-1 alpha-2 format, that was sent in
the request body.
$sel:originalPhoneNumber:NumberValidateResponse', numberValidateResponse_originalPhoneNumber - The phone number that was sent in the request body.
$sel:phoneType:NumberValidateResponse', numberValidateResponse_phoneType - The description of the phone type. Valid values are: MOBILE, LANDLINE,
VOIP, INVALID, PREPAID, and OTHER.
$sel:phoneTypeCode:NumberValidateResponse', numberValidateResponse_phoneTypeCode - The phone type, represented by an integer. Valid values are: 0 (mobile),
1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).
$sel:timezone:NumberValidateResponse', numberValidateResponse_timezone - The time zone for the location where the phone number was originally
registered.
$sel:zipCode:NumberValidateResponse', numberValidateResponse_zipCode - The postal or ZIP code for the location where the phone number was
originally registered.
numberValidateResponse_carrier :: Lens' NumberValidateResponse (Maybe Text) Source #
The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.
numberValidateResponse_city :: Lens' NumberValidateResponse (Maybe Text) Source #
The name of the city where the phone number was originally registered.
numberValidateResponse_cleansedPhoneNumberE164 :: Lens' NumberValidateResponse (Maybe Text) Source #
The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.
numberValidateResponse_cleansedPhoneNumberNational :: Lens' NumberValidateResponse (Maybe Text) Source #
The cleansed phone number, in the format for the location where the phone number was originally registered.
numberValidateResponse_country :: Lens' NumberValidateResponse (Maybe Text) Source #
The name of the country or region where the phone number was originally registered.
numberValidateResponse_countryCodeIso2 :: Lens' NumberValidateResponse (Maybe Text) Source #
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
numberValidateResponse_countryCodeNumeric :: Lens' NumberValidateResponse (Maybe Text) Source #
The numeric code for the country or region where the phone number was originally registered.
numberValidateResponse_county :: Lens' NumberValidateResponse (Maybe Text) Source #
The name of the county where the phone number was originally registered.
numberValidateResponse_originalCountryCodeIso2 :: Lens' NumberValidateResponse (Maybe Text) Source #
The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.
numberValidateResponse_originalPhoneNumber :: Lens' NumberValidateResponse (Maybe Text) Source #
The phone number that was sent in the request body.
numberValidateResponse_phoneType :: Lens' NumberValidateResponse (Maybe Text) Source #
The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.
numberValidateResponse_phoneTypeCode :: Lens' NumberValidateResponse (Maybe Int) Source #
The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).
numberValidateResponse_timezone :: Lens' NumberValidateResponse (Maybe Text) Source #
The time zone for the location where the phone number was originally registered.
numberValidateResponse_zipCode :: Lens' NumberValidateResponse (Maybe Text) Source #
The postal or ZIP code for the location where the phone number was originally registered.
OpenHours
The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.
See: newOpenHours smart constructor.
Constructors
| OpenHours' | |
Fields
| |
Instances
newOpenHours :: OpenHours Source #
Create a value of OpenHours with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:custom:OpenHours', openHours_custom - Rules for Custom Channel.
$sel:email:OpenHours', openHours_email - Rules for Email Channel.
$sel:push:OpenHours', openHours_push - Rules for Push Channel.
$sel:sms:OpenHours', openHours_sms - Rules for SMS Channel.
$sel:voice:OpenHours', openHours_voice - Rules for Voice Channel.
openHours_custom :: Lens' OpenHours (Maybe (HashMap DayOfWeek [OpenHoursRule])) Source #
Rules for Custom Channel.
openHours_email :: Lens' OpenHours (Maybe (HashMap DayOfWeek [OpenHoursRule])) Source #
Rules for Email Channel.
openHours_push :: Lens' OpenHours (Maybe (HashMap DayOfWeek [OpenHoursRule])) Source #
Rules for Push Channel.
openHours_sms :: Lens' OpenHours (Maybe (HashMap DayOfWeek [OpenHoursRule])) Source #
Rules for SMS Channel.
openHours_voice :: Lens' OpenHours (Maybe (HashMap DayOfWeek [OpenHoursRule])) Source #
Rules for Voice Channel.
OpenHoursRule
data OpenHoursRule Source #
List of OpenHours Rules.
See: newOpenHoursRule smart constructor.
Constructors
| OpenHoursRule' | |
Instances
newOpenHoursRule :: OpenHoursRule Source #
Create a value of OpenHoursRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endTime:OpenHoursRule', openHoursRule_endTime - Local start time in ISO 8601 format.
$sel:startTime:OpenHoursRule', openHoursRule_startTime - Local start time in ISO 8601 format.
openHoursRule_endTime :: Lens' OpenHoursRule (Maybe Text) Source #
Local start time in ISO 8601 format.
openHoursRule_startTime :: Lens' OpenHoursRule (Maybe Text) Source #
Local start time in ISO 8601 format.
OverrideButtonConfiguration
data OverrideButtonConfiguration Source #
Override button configuration.
See: newOverrideButtonConfiguration smart constructor.
Constructors
| OverrideButtonConfiguration' | |
Fields
| |
Instances
newOverrideButtonConfiguration Source #
Arguments
| :: ButtonAction | |
| -> OverrideButtonConfiguration |
Create a value of OverrideButtonConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:link:OverrideButtonConfiguration', overrideButtonConfiguration_link - Button destination.
$sel:buttonAction:OverrideButtonConfiguration', overrideButtonConfiguration_buttonAction - Action triggered by the button.
overrideButtonConfiguration_link :: Lens' OverrideButtonConfiguration (Maybe Text) Source #
Button destination.
overrideButtonConfiguration_buttonAction :: Lens' OverrideButtonConfiguration ButtonAction Source #
Action triggered by the button.
PublicEndpoint
data PublicEndpoint Source #
Specifies the properties and attributes of an endpoint that's associated with an event.
See: newPublicEndpoint smart constructor.
Constructors
| PublicEndpoint' | |
Fields
| |
Instances
newPublicEndpoint :: PublicEndpoint Source #
Create a value of PublicEndpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:address:PublicEndpoint', publicEndpoint_address - The unique identifier for the recipient, such as a device token, email
address, or mobile phone number.
$sel:attributes:PublicEndpoint', publicEndpoint_attributes - One or more custom attributes that describe the endpoint by associating
a name with an array of values. You can use these attributes as filter
criteria when you create segments.
$sel:channelType:PublicEndpoint', publicEndpoint_channelType - The channel that's used when sending messages or push notifications to
the endpoint.
$sel:demographic:PublicEndpoint', publicEndpoint_demographic - The demographic information for the endpoint, such as the time zone and
platform.
$sel:effectiveDate:PublicEndpoint', publicEndpoint_effectiveDate - The date and time, in ISO 8601 format, when the endpoint was last
updated.
$sel:endpointStatus:PublicEndpoint', publicEndpoint_endpointStatus - Specifies whether to send messages or push notifications to the
endpoint. Valid values are: ACTIVE, messages are sent to the endpoint;
and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
$sel:location:PublicEndpoint', publicEndpoint_location - The geographic information for the endpoint.
$sel:metrics:PublicEndpoint', publicEndpoint_metrics - One or more custom metrics that your app reports to Amazon Pinpoint for
the endpoint.
$sel:optOut:PublicEndpoint', publicEndpoint_optOut - Specifies whether the user who's associated with the endpoint has opted
out of receiving messages and push notifications from you. Possible
values are: ALL, the user has opted out and doesn't want to receive any
messages or push notifications; and, NONE, the user hasn't opted out
and wants to receive all messages and push notifications.
$sel:requestId:PublicEndpoint', publicEndpoint_requestId - A unique identifier that's generated each time the endpoint is updated.
$sel:user:PublicEndpoint', publicEndpoint_user - One or more custom user attributes that your app reports to Amazon
Pinpoint for the user who's associated with the endpoint.
publicEndpoint_address :: Lens' PublicEndpoint (Maybe Text) Source #
The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
publicEndpoint_attributes :: Lens' PublicEndpoint (Maybe (HashMap Text [Text])) Source #
One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.
publicEndpoint_channelType :: Lens' PublicEndpoint (Maybe ChannelType) Source #
The channel that's used when sending messages or push notifications to the endpoint.
publicEndpoint_demographic :: Lens' PublicEndpoint (Maybe EndpointDemographic) Source #
The demographic information for the endpoint, such as the time zone and platform.
publicEndpoint_effectiveDate :: Lens' PublicEndpoint (Maybe Text) Source #
The date and time, in ISO 8601 format, when the endpoint was last updated.
publicEndpoint_endpointStatus :: Lens' PublicEndpoint (Maybe Text) Source #
Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
publicEndpoint_location :: Lens' PublicEndpoint (Maybe EndpointLocation) Source #
The geographic information for the endpoint.
publicEndpoint_metrics :: Lens' PublicEndpoint (Maybe (HashMap Text Double)) Source #
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
publicEndpoint_optOut :: Lens' PublicEndpoint (Maybe Text) Source #
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
publicEndpoint_requestId :: Lens' PublicEndpoint (Maybe Text) Source #
A unique identifier that's generated each time the endpoint is updated.
publicEndpoint_user :: Lens' PublicEndpoint (Maybe EndpointUser) Source #
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
PushMessageActivity
data PushMessageActivity Source #
Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants.
See: newPushMessageActivity smart constructor.
Constructors
| PushMessageActivity' | |
Fields
| |
Instances
newPushMessageActivity :: PushMessageActivity Source #
Create a value of PushMessageActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:messageConfig:PushMessageActivity', pushMessageActivity_messageConfig - Specifies the time to live (TTL) value for push notifications that are
sent to participants in a journey.
$sel:nextActivity:PushMessageActivity', pushMessageActivity_nextActivity - The unique identifier for the next activity to perform, after the
message is sent.
$sel:templateName:PushMessageActivity', pushMessageActivity_templateName - The name of the push notification template to use for the message. If
specified, this value must match the name of an existing message
template.
$sel:templateVersion:PushMessageActivity', pushMessageActivity_templateVersion - The unique identifier for the version of the push notification template
to use for the message. If specified, this value must match the
identifier for an existing template version. To retrieve a list of
versions and version identifiers for a template, use the Template
Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
pushMessageActivity_messageConfig :: Lens' PushMessageActivity (Maybe JourneyPushMessage) Source #
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
pushMessageActivity_nextActivity :: Lens' PushMessageActivity (Maybe Text) Source #
The unique identifier for the next activity to perform, after the message is sent.
pushMessageActivity_templateName :: Lens' PushMessageActivity (Maybe Text) Source #
The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
pushMessageActivity_templateVersion :: Lens' PushMessageActivity (Maybe Text) Source #
The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
PushNotificationTemplateRequest
data PushNotificationTemplateRequest Source #
Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.
See: newPushNotificationTemplateRequest smart constructor.
Constructors
| PushNotificationTemplateRequest' | |
Fields
| |
Instances
newPushNotificationTemplateRequest :: PushNotificationTemplateRequest Source #
Create a value of PushNotificationTemplateRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:adm:PushNotificationTemplateRequest', pushNotificationTemplateRequest_adm - The message template to use for the ADM (Amazon Device Messaging)
channel. This message template overrides the default template for push
notification channels (DefaultPushNotificationTemplate).
$sel:apns:PushNotificationTemplateRequest', pushNotificationTemplateRequest_apns - The message template to use for the APNs (Apple Push Notification
service) channel. This message template overrides the default template
for push notification channels (DefaultPushNotificationTemplate).
$sel:baidu:PushNotificationTemplateRequest', pushNotificationTemplateRequest_baidu - The message template to use for the Baidu (Baidu Cloud Push) channel.
This message template overrides the default template for push
notification channels (DefaultPushNotificationTemplate).
$sel:default':PushNotificationTemplateRequest', pushNotificationTemplateRequest_default - The default message template to use for push notification channels.
$sel:defaultSubstitutions:PushNotificationTemplateRequest', pushNotificationTemplateRequest_defaultSubstitutions - A JSON object that specifies the default values to use for message
variables in the message template. This object is a set of key-value
pairs. Each key defines a message variable in the template. The
corresponding value defines the default value for that variable. When
you create a message that's based on the template, you can override
these defaults with message-specific and address-specific variables and
values.
$sel:gcm:PushNotificationTemplateRequest', pushNotificationTemplateRequest_gcm - The message template to use for the GCM channel, which is used to send
notifications through the Firebase Cloud Messaging (FCM), formerly
Google Cloud Messaging (GCM), service. This message template overrides
the default template for push notification channels
(DefaultPushNotificationTemplate).
$sel:recommenderId:PushNotificationTemplateRequest', pushNotificationTemplateRequest_recommenderId - The unique identifier for the recommender model to use for the message
template. Amazon Pinpoint uses this value to determine how to retrieve
and process data from a recommender model when it sends messages that
use the template, if the template contains message variables for
recommendation data.
$sel:templateDescription:PushNotificationTemplateRequest', pushNotificationTemplateRequest_templateDescription - A custom description of the message template.
$sel:tags:PushNotificationTemplateRequest', pushNotificationTemplateRequest_tags - A string-to-string map of key-value pairs that defines the tags to
associate with the message template. Each tag consists of a required tag
key and an associated tag value.
pushNotificationTemplateRequest_adm :: Lens' PushNotificationTemplateRequest (Maybe AndroidPushNotificationTemplate) Source #
The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
pushNotificationTemplateRequest_apns :: Lens' PushNotificationTemplateRequest (Maybe APNSPushNotificationTemplate) Source #
The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
pushNotificationTemplateRequest_baidu :: Lens' PushNotificationTemplateRequest (Maybe AndroidPushNotificationTemplate) Source #
The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
pushNotificationTemplateRequest_default :: Lens' PushNotificationTemplateRequest (Maybe DefaultPushNotificationTemplate) Source #
The default message template to use for push notification channels.
pushNotificationTemplateRequest_defaultSubstitutions :: Lens' PushNotificationTemplateRequest (Maybe Text) Source #
A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
pushNotificationTemplateRequest_gcm :: Lens' PushNotificationTemplateRequest (Maybe AndroidPushNotificationTemplate) Source #
The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
pushNotificationTemplateRequest_recommenderId :: Lens' PushNotificationTemplateRequest (Maybe Text) Source #
The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
pushNotificationTemplateRequest_templateDescription :: Lens' PushNotificationTemplateRequest (Maybe Text) Source #
A custom description of the message template.
pushNotificationTemplateRequest_tags :: Lens' PushNotificationTemplateRequest (Maybe (HashMap Text Text)) Source #
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
PushNotificationTemplateResponse
data PushNotificationTemplateResponse Source #
Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.
See: newPushNotificationTemplateResponse smart constructor.
Constructors
| PushNotificationTemplateResponse' | |
Fields
| |
Instances
newPushNotificationTemplateResponse Source #
Arguments
| :: Text | |
| -> Text | |
| -> TemplateType | |
| -> Text | |
| -> PushNotificationTemplateResponse |
Create a value of PushNotificationTemplateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:adm:PushNotificationTemplateResponse', pushNotificationTemplateResponse_adm - The message template that's used for the ADM (Amazon Device Messaging)
channel. This message template overrides the default template for push
notification channels (DefaultPushNotificationTemplate).
$sel:apns:PushNotificationTemplateResponse', pushNotificationTemplateResponse_apns - The message template that's used for the APNs (Apple Push Notification
service) channel. This message template overrides the default template
for push notification channels (DefaultPushNotificationTemplate).
$sel:arn:PushNotificationTemplateResponse', pushNotificationTemplateResponse_arn - The Amazon Resource Name (ARN) of the message template.
$sel:baidu:PushNotificationTemplateResponse', pushNotificationTemplateResponse_baidu - The message template that's used for the Baidu (Baidu Cloud Push)
channel. This message template overrides the default template for push
notification channels (DefaultPushNotificationTemplate).
$sel:default':PushNotificationTemplateResponse', pushNotificationTemplateResponse_default - The default message template that's used for push notification
channels.
$sel:defaultSubstitutions:PushNotificationTemplateResponse', pushNotificationTemplateResponse_defaultSubstitutions - The JSON object that specifies the default values that are used for
message variables in the message template. This object is a set of
key-value pairs. Each key defines a message variable in the template.
The corresponding value defines the default value for that variable.
$sel:gcm:PushNotificationTemplateResponse', pushNotificationTemplateResponse_gcm - The message template that's used for the GCM channel, which is used to
send notifications through the Firebase Cloud Messaging (FCM), formerly
Google Cloud Messaging (GCM), service. This message template overrides
the default template for push notification channels
(DefaultPushNotificationTemplate).
$sel:recommenderId:PushNotificationTemplateResponse', pushNotificationTemplateResponse_recommenderId - The unique identifier for the recommender model that's used by the
message template.
$sel:templateDescription:PushNotificationTemplateResponse', pushNotificationTemplateResponse_templateDescription - The custom description of the message template.
$sel:version:PushNotificationTemplateResponse', pushNotificationTemplateResponse_version - The unique identifier, as an integer, for the active version of the
message template, or the version of the template that you specified by
using the version parameter in your request.
$sel:tags:PushNotificationTemplateResponse', pushNotificationTemplateResponse_tags - A string-to-string map of key-value pairs that identifies the tags that
are associated with the message template. Each tag consists of a
required tag key and an associated tag value.
$sel:lastModifiedDate:PushNotificationTemplateResponse', pushNotificationTemplateResponse_lastModifiedDate - The date, in ISO 8601 format, when the message template was last
modified.
$sel:creationDate:PushNotificationTemplateResponse', pushNotificationTemplateResponse_creationDate - The date, in ISO 8601 format, when the message template was created.
$sel:templateType:PushNotificationTemplateResponse', pushNotificationTemplateResponse_templateType - The type of channel that the message template is designed for. For a
push notification template, this value is PUSH.
$sel:templateName:PushNotificationTemplateResponse', pushNotificationTemplateResponse_templateName - The name of the message template.
pushNotificationTemplateResponse_adm :: Lens' PushNotificationTemplateResponse (Maybe AndroidPushNotificationTemplate) Source #
The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
pushNotificationTemplateResponse_apns :: Lens' PushNotificationTemplateResponse (Maybe APNSPushNotificationTemplate) Source #
The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
pushNotificationTemplateResponse_arn :: Lens' PushNotificationTemplateResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the message template.
pushNotificationTemplateResponse_baidu :: Lens' PushNotificationTemplateResponse (Maybe AndroidPushNotificationTemplate) Source #
The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
pushNotificationTemplateResponse_default :: Lens' PushNotificationTemplateResponse (Maybe DefaultPushNotificationTemplate) Source #
The default message template that's used for push notification channels.
pushNotificationTemplateResponse_defaultSubstitutions :: Lens' PushNotificationTemplateResponse (Maybe Text) Source #
The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
pushNotificationTemplateResponse_gcm :: Lens' PushNotificationTemplateResponse (Maybe AndroidPushNotificationTemplate) Source #
The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
pushNotificationTemplateResponse_recommenderId :: Lens' PushNotificationTemplateResponse (Maybe Text) Source #
The unique identifier for the recommender model that's used by the message template.
pushNotificationTemplateResponse_templateDescription :: Lens' PushNotificationTemplateResponse (Maybe Text) Source #
The custom description of the message template.
pushNotificationTemplateResponse_version :: Lens' PushNotificationTemplateResponse (Maybe Text) Source #
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
pushNotificationTemplateResponse_tags :: Lens' PushNotificationTemplateResponse (Maybe (HashMap Text Text)) Source #
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
pushNotificationTemplateResponse_lastModifiedDate :: Lens' PushNotificationTemplateResponse Text Source #
The date, in ISO 8601 format, when the message template was last modified.
pushNotificationTemplateResponse_creationDate :: Lens' PushNotificationTemplateResponse Text Source #
The date, in ISO 8601 format, when the message template was created.
pushNotificationTemplateResponse_templateType :: Lens' PushNotificationTemplateResponse TemplateType Source #
The type of channel that the message template is designed for. For a push notification template, this value is PUSH.
pushNotificationTemplateResponse_templateName :: Lens' PushNotificationTemplateResponse Text Source #
The name of the message template.
QuietTime
Specifies the start and end times that define a time range when messages aren't sent to endpoints.
See: newQuietTime smart constructor.
Constructors
| QuietTime' | |
Fields
| |
Instances
| FromJSON QuietTime Source # | |
| ToJSON QuietTime Source # | |
Defined in Amazonka.Pinpoint.Types.QuietTime | |
| Generic QuietTime Source # | |
| Read QuietTime Source # | |
| Show QuietTime Source # | |
| NFData QuietTime Source # | |
Defined in Amazonka.Pinpoint.Types.QuietTime | |
| Eq QuietTime Source # | |
| Hashable QuietTime Source # | |
Defined in Amazonka.Pinpoint.Types.QuietTime | |
| type Rep QuietTime Source # | |
Defined in Amazonka.Pinpoint.Types.QuietTime type Rep QuietTime = D1 ('MetaData "QuietTime" "Amazonka.Pinpoint.Types.QuietTime" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "QuietTime'" 'PrefixI 'True) (S1 ('MetaSel ('Just "end") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "start") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newQuietTime :: QuietTime Source #
Create a value of QuietTime with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:end:QuietTime', quietTime_end - The specific time when quiet time ends. This value has to use 24-hour
notation and be in HH:MM format, where HH is the hour (with a leading
zero, if applicable) and MM is the minutes. For example, use 02:30 to
represent 2:30 AM, or 14:30 to represent 2:30 PM.
$sel:start:QuietTime', quietTime_start - The specific time when quiet time begins. This value has to use 24-hour
notation and be in HH:MM format, where HH is the hour (with a leading
zero, if applicable) and MM is the minutes. For example, use 02:30 to
represent 2:30 AM, or 14:30 to represent 2:30 PM.
quietTime_end :: Lens' QuietTime (Maybe Text) Source #
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
quietTime_start :: Lens' QuietTime (Maybe Text) Source #
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
RandomSplitActivity
data RandomSplitActivity Source #
Specifies the settings for a random split activity in a journey. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
See: newRandomSplitActivity smart constructor.
Constructors
| RandomSplitActivity' | |
Fields
| |
Instances
newRandomSplitActivity :: RandomSplitActivity Source #
Create a value of RandomSplitActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:branches:RandomSplitActivity', randomSplitActivity_branches - The paths for the activity, including the percentage of participants to
enter each path and the activity to perform for each path.
randomSplitActivity_branches :: Lens' RandomSplitActivity (Maybe [RandomSplitEntry]) Source #
The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
RandomSplitEntry
data RandomSplitEntry Source #
Specifies the settings for a path in a random split activity in a journey.
See: newRandomSplitEntry smart constructor.
Constructors
| RandomSplitEntry' | |
Fields
| |
Instances
newRandomSplitEntry :: RandomSplitEntry Source #
Create a value of RandomSplitEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextActivity:RandomSplitEntry', randomSplitEntry_nextActivity - The unique identifier for the next activity to perform, after completing
the activity for the path.
$sel:percentage:RandomSplitEntry', randomSplitEntry_percentage - The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
randomSplitEntry_nextActivity :: Lens' RandomSplitEntry (Maybe Text) Source #
The unique identifier for the next activity to perform, after completing the activity for the path.
randomSplitEntry_percentage :: Lens' RandomSplitEntry (Maybe Int) Source #
The percentage of participants to send down the activity path.
To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
RawEmail
Specifies the contents of an email message, represented as a raw MIME message.
See: newRawEmail smart constructor.
Constructors
| RawEmail' | |
Instances
| ToJSON RawEmail Source # | |
Defined in Amazonka.Pinpoint.Types.RawEmail | |
| Generic RawEmail Source # | |
| Read RawEmail Source # | |
| Show RawEmail Source # | |
| NFData RawEmail Source # | |
Defined in Amazonka.Pinpoint.Types.RawEmail | |
| Eq RawEmail Source # | |
| Hashable RawEmail Source # | |
Defined in Amazonka.Pinpoint.Types.RawEmail | |
| type Rep RawEmail Source # | |
Defined in Amazonka.Pinpoint.Types.RawEmail | |
newRawEmail :: RawEmail Source #
Create a value of RawEmail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:data':RawEmail', rawEmail_data - The email message, represented as a raw MIME message. The entire message
must be base64 encoded.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
rawEmail_data :: Lens' RawEmail (Maybe ByteString) Source #
The email message, represented as a raw MIME message. The entire message
must be base64 encoded.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
RecencyDimension
data RecencyDimension Source #
Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active.
See: newRecencyDimension smart constructor.
Constructors
| RecencyDimension' | |
Fields
| |
Instances
Arguments
| :: Duration | |
| -> RecencyType | |
| -> RecencyDimension |
Create a value of RecencyDimension with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:duration:RecencyDimension', recencyDimension_duration - The duration to use when determining whether an endpoint is active or
inactive.
$sel:recencyType:RecencyDimension', recencyDimension_recencyType - The type of recency dimension to use for the segment. Valid values are:
ACTIVE, endpoints that were active within the specified duration are
included in the segment; and, INACTIVE, endpoints that weren't active
within the specified duration are included in the segment.
recencyDimension_duration :: Lens' RecencyDimension Duration Source #
The duration to use when determining whether an endpoint is active or inactive.
recencyDimension_recencyType :: Lens' RecencyDimension RecencyType Source #
The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
RecommenderConfigurationResponse
data RecommenderConfigurationResponse Source #
Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.
See: newRecommenderConfigurationResponse smart constructor.
Constructors
| RecommenderConfigurationResponse' | |
Fields
| |
Instances
newRecommenderConfigurationResponse Source #
Arguments
Create a value of RecommenderConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:RecommenderConfigurationResponse', recommenderConfigurationResponse_attributes - A map that defines 1-10 custom endpoint or user attributes, depending on
the value for the RecommendationProviderIdType property. Each of these
attributes temporarily stores a recommended item that's retrieved from
the recommender model and sent to an AWS Lambda function for additional
processing. Each attribute can be used as a message variable in a
message template.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
$sel:description:RecommenderConfigurationResponse', recommenderConfigurationResponse_description - The custom description of the configuration for the recommender model.
$sel:name:RecommenderConfigurationResponse', recommenderConfigurationResponse_name - The custom name of the configuration for the recommender model.
$sel:recommendationProviderIdType:RecommenderConfigurationResponse', recommenderConfigurationResponse_recommendationProviderIdType - The type of Amazon Pinpoint ID that's associated with unique user IDs
in the recommender model. This value enables the model to use attribute
and event data that’s specific to a particular endpoint or user in an
Amazon Pinpoint application. Possible values are:
- PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
- PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
$sel:recommendationTransformerUri:RecommenderConfigurationResponse', recommenderConfigurationResponse_recommendationTransformerUri - The name or Amazon Resource Name (ARN) of the AWS Lambda function that
Amazon Pinpoint invokes to perform additional processing of
recommendation data that it retrieves from the recommender model.
$sel:recommendationsDisplayName:RecommenderConfigurationResponse', recommenderConfigurationResponse_recommendationsDisplayName - The custom display name for the standard endpoint or user attribute
(RecommendationItems) that temporarily stores recommended items for each
endpoint or user, depending on the value for the
RecommendationProviderIdType property. This name appears in the
Attribute finder of the template editor on the Amazon Pinpoint
console.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
$sel:recommendationsPerMessage:RecommenderConfigurationResponse', recommenderConfigurationResponse_recommendationsPerMessage - The number of recommended items that are retrieved from the model for
each endpoint or user, depending on the value for the
RecommendationProviderIdType property. This number determines how many
recommended items are available for use in message variables.
$sel:recommendationProviderUri:RecommenderConfigurationResponse', recommenderConfigurationResponse_recommendationProviderUri - The Amazon Resource Name (ARN) of the recommender model that Amazon
Pinpoint retrieves the recommendation data from. This value is the ARN
of an Amazon Personalize campaign.
$sel:lastModifiedDate:RecommenderConfigurationResponse', recommenderConfigurationResponse_lastModifiedDate - The date, in extended ISO 8601 format, when the configuration for the
recommender model was last modified.
$sel:creationDate:RecommenderConfigurationResponse', recommenderConfigurationResponse_creationDate - The date, in extended ISO 8601 format, when the configuration was
created for the recommender model.
$sel:recommendationProviderRoleArn:RecommenderConfigurationResponse', recommenderConfigurationResponse_recommendationProviderRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that authorizes Amazon Pinpoint to retrieve recommendation
data from the recommender model.
$sel:id:RecommenderConfigurationResponse', recommenderConfigurationResponse_id - The unique identifier for the recommender model configuration.
recommenderConfigurationResponse_attributes :: Lens' RecommenderConfigurationResponse (Maybe (HashMap Text Text)) Source #
A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
recommenderConfigurationResponse_description :: Lens' RecommenderConfigurationResponse (Maybe Text) Source #
The custom description of the configuration for the recommender model.
recommenderConfigurationResponse_name :: Lens' RecommenderConfigurationResponse (Maybe Text) Source #
The custom name of the configuration for the recommender model.
recommenderConfigurationResponse_recommendationProviderIdType :: Lens' RecommenderConfigurationResponse (Maybe Text) Source #
The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:
- PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
- PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
recommenderConfigurationResponse_recommendationTransformerUri :: Lens' RecommenderConfigurationResponse (Maybe Text) Source #
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.
recommenderConfigurationResponse_recommendationsDisplayName :: Lens' RecommenderConfigurationResponse (Maybe Text) Source #
The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console.
This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
recommenderConfigurationResponse_recommendationsPerMessage :: Lens' RecommenderConfigurationResponse (Maybe Int) Source #
The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.
recommenderConfigurationResponse_recommendationProviderUri :: Lens' RecommenderConfigurationResponse Text Source #
The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.
recommenderConfigurationResponse_lastModifiedDate :: Lens' RecommenderConfigurationResponse Text Source #
The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
recommenderConfigurationResponse_creationDate :: Lens' RecommenderConfigurationResponse Text Source #
The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
recommenderConfigurationResponse_recommendationProviderRoleArn :: Lens' RecommenderConfigurationResponse Text Source #
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
recommenderConfigurationResponse_id :: Lens' RecommenderConfigurationResponse Text Source #
The unique identifier for the recommender model configuration.
ResultRow
Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
See: newResultRow smart constructor.
Constructors
| ResultRow' | |
Fields
| |
Instances
| FromJSON ResultRow Source # | |
| Generic ResultRow Source # | |
| Read ResultRow Source # | |
| Show ResultRow Source # | |
| NFData ResultRow Source # | |
Defined in Amazonka.Pinpoint.Types.ResultRow | |
| Eq ResultRow Source # | |
| Hashable ResultRow Source # | |
Defined in Amazonka.Pinpoint.Types.ResultRow | |
| type Rep ResultRow Source # | |
Defined in Amazonka.Pinpoint.Types.ResultRow type Rep ResultRow = D1 ('MetaData "ResultRow" "Amazonka.Pinpoint.Types.ResultRow" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "ResultRow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupedBys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ResultRowValue]) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ResultRowValue]))) | |
newResultRow :: ResultRow Source #
Create a value of ResultRow with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupedBys:ResultRow', resultRow_groupedBys - An array of objects that defines the field and field values that were
used to group data in a result set that contains multiple results. This
value is null if the data in a result set isn’t grouped.
$sel:values:ResultRow', resultRow_values - An array of objects that provides pre-aggregated values for a standard
metric that applies to an application, campaign, or journey.
resultRow_groupedBys :: Lens' ResultRow [ResultRowValue] Source #
An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.
resultRow_values :: Lens' ResultRow [ResultRowValue] Source #
An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.
ResultRowValue
data ResultRowValue Source #
Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.
See: newResultRowValue smart constructor.
Constructors
| ResultRowValue' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ResultRowValue |
Create a value of ResultRowValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':ResultRowValue', resultRowValue_type - The data type of the value specified by the Value property.
$sel:value:ResultRowValue', resultRowValue_value - In a Values object, the value for the metric that the query retrieved
data for. In a GroupedBys object, the value for the field that was used
to group data in a result set that contains multiple results (Values
objects).
$sel:key:ResultRowValue', resultRowValue_key - The friendly name of the metric whose value is specified by the Value
property.
resultRowValue_type :: Lens' ResultRowValue Text Source #
The data type of the value specified by the Value property.
resultRowValue_value :: Lens' ResultRowValue Text Source #
In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).
resultRowValue_key :: Lens' ResultRowValue Text Source #
The friendly name of the metric whose value is specified by the Value property.
SMSChannelRequest
data SMSChannelRequest Source #
Specifies the status and settings of the SMS channel for an application.
See: newSMSChannelRequest smart constructor.
Constructors
| SMSChannelRequest' | |
Fields
| |
Instances
newSMSChannelRequest :: SMSChannelRequest Source #
Create a value of SMSChannelRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:SMSChannelRequest', sMSChannelRequest_enabled - Specifies whether to enable the SMS channel for the application.
$sel:senderId:SMSChannelRequest', sMSChannelRequest_senderId - The identity that you want to display on recipients' devices when they
receive messages from the SMS channel.
$sel:shortCode:SMSChannelRequest', sMSChannelRequest_shortCode - The registered short code that you want to use when you send messages
through the SMS channel.
sMSChannelRequest_enabled :: Lens' SMSChannelRequest (Maybe Bool) Source #
Specifies whether to enable the SMS channel for the application.
sMSChannelRequest_senderId :: Lens' SMSChannelRequest (Maybe Text) Source #
The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
sMSChannelRequest_shortCode :: Lens' SMSChannelRequest (Maybe Text) Source #
The registered short code that you want to use when you send messages through the SMS channel.
SMSChannelResponse
data SMSChannelResponse Source #
Provides information about the status and settings of the SMS channel for an application.
See: newSMSChannelResponse smart constructor.
Constructors
| SMSChannelResponse' | |
Fields
| |
Instances
newSMSChannelResponse Source #
Arguments
| :: Text | |
| -> SMSChannelResponse |
Create a value of SMSChannelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:SMSChannelResponse', sMSChannelResponse_applicationId - The unique identifier for the application that the SMS channel applies
to.
$sel:creationDate:SMSChannelResponse', sMSChannelResponse_creationDate - The date and time, in ISO 8601 format, when the SMS channel was enabled.
$sel:enabled:SMSChannelResponse', sMSChannelResponse_enabled - Specifies whether the SMS channel is enabled for the application.
$sel:hasCredential:SMSChannelResponse', sMSChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.
$sel:id:SMSChannelResponse', sMSChannelResponse_id - (Deprecated) An identifier for the SMS channel. This property is
retained only for backward compatibility.
$sel:isArchived:SMSChannelResponse', sMSChannelResponse_isArchived - Specifies whether the SMS channel is archived.
$sel:lastModifiedBy:SMSChannelResponse', sMSChannelResponse_lastModifiedBy - The user who last modified the SMS channel.
$sel:lastModifiedDate:SMSChannelResponse', sMSChannelResponse_lastModifiedDate - The date and time, in ISO 8601 format, when the SMS channel was last
modified.
$sel:promotionalMessagesPerSecond:SMSChannelResponse', sMSChannelResponse_promotionalMessagesPerSecond - The maximum number of promotional messages that you can send through the
SMS channel each second.
$sel:senderId:SMSChannelResponse', sMSChannelResponse_senderId - The identity that displays on recipients' devices when they receive
messages from the SMS channel.
$sel:shortCode:SMSChannelResponse', sMSChannelResponse_shortCode - The registered short code to use when you send messages through the SMS
channel.
$sel:transactionalMessagesPerSecond:SMSChannelResponse', sMSChannelResponse_transactionalMessagesPerSecond - The maximum number of transactional messages that you can send through
the SMS channel each second.
$sel:version:SMSChannelResponse', sMSChannelResponse_version - The current version of the SMS channel.
$sel:platform:SMSChannelResponse', sMSChannelResponse_platform - The type of messaging or notification platform for the channel. For the
SMS channel, this value is SMS.
sMSChannelResponse_applicationId :: Lens' SMSChannelResponse (Maybe Text) Source #
The unique identifier for the application that the SMS channel applies to.
sMSChannelResponse_creationDate :: Lens' SMSChannelResponse (Maybe Text) Source #
The date and time, in ISO 8601 format, when the SMS channel was enabled.
sMSChannelResponse_enabled :: Lens' SMSChannelResponse (Maybe Bool) Source #
Specifies whether the SMS channel is enabled for the application.
sMSChannelResponse_hasCredential :: Lens' SMSChannelResponse (Maybe Bool) Source #
(Not used) This property is retained only for backward compatibility.
sMSChannelResponse_id :: Lens' SMSChannelResponse (Maybe Text) Source #
(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
sMSChannelResponse_isArchived :: Lens' SMSChannelResponse (Maybe Bool) Source #
Specifies whether the SMS channel is archived.
sMSChannelResponse_lastModifiedBy :: Lens' SMSChannelResponse (Maybe Text) Source #
The user who last modified the SMS channel.
sMSChannelResponse_lastModifiedDate :: Lens' SMSChannelResponse (Maybe Text) Source #
The date and time, in ISO 8601 format, when the SMS channel was last modified.
sMSChannelResponse_promotionalMessagesPerSecond :: Lens' SMSChannelResponse (Maybe Int) Source #
The maximum number of promotional messages that you can send through the SMS channel each second.
sMSChannelResponse_senderId :: Lens' SMSChannelResponse (Maybe Text) Source #
The identity that displays on recipients' devices when they receive messages from the SMS channel.
sMSChannelResponse_shortCode :: Lens' SMSChannelResponse (Maybe Text) Source #
The registered short code to use when you send messages through the SMS channel.
sMSChannelResponse_transactionalMessagesPerSecond :: Lens' SMSChannelResponse (Maybe Int) Source #
The maximum number of transactional messages that you can send through the SMS channel each second.
sMSChannelResponse_version :: Lens' SMSChannelResponse (Maybe Int) Source #
The current version of the SMS channel.
sMSChannelResponse_platform :: Lens' SMSChannelResponse Text Source #
The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
SMSMessage
data SMSMessage Source #
Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.
See: newSMSMessage smart constructor.
Constructors
| SMSMessage' | |
Fields
| |
Instances
newSMSMessage :: SMSMessage Source #
Create a value of SMSMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:body:SMSMessage', sMSMessage_body - The body of the SMS message.
$sel:entityId:SMSMessage', sMSMessage_entityId - The entity ID or Principal Entity (PE) id received from the regulatory
body for sending SMS in your country.
$sel:keyword:SMSMessage', sMSMessage_keyword - The SMS program name that you provided to AWS Support when you requested
your dedicated number.
$sel:mediaUrl:SMSMessage', sMSMessage_mediaUrl - This field is reserved for future use.
$sel:messageType:SMSMessage', sMSMessage_messageType - The SMS message type. Valid values are TRANSACTIONAL (for messages that
are critical or time-sensitive, such as a one-time passwords) and
PROMOTIONAL (for messsages that aren't critical or time-sensitive, such
as marketing messages).
$sel:originationNumber:SMSMessage', sMSMessage_originationNumber - The number to send the SMS message from. This value should be one of the
dedicated long or short codes that's assigned to your AWS account. If
you don't specify a long or short code, Amazon Pinpoint assigns a
random long code to the SMS message and sends the message from that
code.
$sel:senderId:SMSMessage', sMSMessage_senderId - The sender ID to display as the sender of the message on a recipient's
device. Support for sender IDs varies by country or region.
$sel:substitutions:SMSMessage', sMSMessage_substitutions - The message variables to use in the SMS message. You can override the
default variables with individual address variables.
$sel:templateId:SMSMessage', sMSMessage_templateId - The template ID received from the regulatory body for sending SMS in
your country.
sMSMessage_body :: Lens' SMSMessage (Maybe Text) Source #
The body of the SMS message.
sMSMessage_entityId :: Lens' SMSMessage (Maybe Text) Source #
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
sMSMessage_keyword :: Lens' SMSMessage (Maybe Text) Source #
The SMS program name that you provided to AWS Support when you requested your dedicated number.
sMSMessage_mediaUrl :: Lens' SMSMessage (Maybe Text) Source #
This field is reserved for future use.
sMSMessage_messageType :: Lens' SMSMessage (Maybe MessageType) Source #
The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
sMSMessage_originationNumber :: Lens' SMSMessage (Maybe Text) Source #
The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
sMSMessage_senderId :: Lens' SMSMessage (Maybe Text) Source #
The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
sMSMessage_substitutions :: Lens' SMSMessage (Maybe (HashMap Text [Text])) Source #
The message variables to use in the SMS message. You can override the default variables with individual address variables.
sMSMessage_templateId :: Lens' SMSMessage (Maybe Text) Source #
The template ID received from the regulatory body for sending SMS in your country.
SMSMessageActivity
data SMSMessageActivity Source #
Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants.
See: newSMSMessageActivity smart constructor.
Constructors
| SMSMessageActivity' | |
Fields
| |
Instances
newSMSMessageActivity :: SMSMessageActivity Source #
Create a value of SMSMessageActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:messageConfig:SMSMessageActivity', sMSMessageActivity_messageConfig - Specifies the sender ID and message type for an SMS message that's sent
to participants in a journey.
$sel:nextActivity:SMSMessageActivity', sMSMessageActivity_nextActivity - The unique identifier for the next activity to perform, after the
message is sent.
$sel:templateName:SMSMessageActivity', sMSMessageActivity_templateName - The name of the SMS message template to use for the message. If
specified, this value must match the name of an existing message
template.
$sel:templateVersion:SMSMessageActivity', sMSMessageActivity_templateVersion - The unique identifier for the version of the SMS template to use for the
message. If specified, this value must match the identifier for an
existing template version. To retrieve a list of versions and version
identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
sMSMessageActivity_messageConfig :: Lens' SMSMessageActivity (Maybe JourneySMSMessage) Source #
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
sMSMessageActivity_nextActivity :: Lens' SMSMessageActivity (Maybe Text) Source #
The unique identifier for the next activity to perform, after the message is sent.
sMSMessageActivity_templateName :: Lens' SMSMessageActivity (Maybe Text) Source #
The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
sMSMessageActivity_templateVersion :: Lens' SMSMessageActivity (Maybe Text) Source #
The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
SMSTemplateRequest
data SMSTemplateRequest Source #
Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.
See: newSMSTemplateRequest smart constructor.
Constructors
| SMSTemplateRequest' | |
Fields
| |
Instances
newSMSTemplateRequest :: SMSTemplateRequest Source #
Create a value of SMSTemplateRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:body:SMSTemplateRequest', sMSTemplateRequest_body - The message body to use in text messages that are based on the message
template.
$sel:defaultSubstitutions:SMSTemplateRequest', sMSTemplateRequest_defaultSubstitutions - A JSON object that specifies the default values to use for message
variables in the message template. This object is a set of key-value
pairs. Each key defines a message variable in the template. The
corresponding value defines the default value for that variable. When
you create a message that's based on the template, you can override
these defaults with message-specific and address-specific variables and
values.
$sel:recommenderId:SMSTemplateRequest', sMSTemplateRequest_recommenderId - The unique identifier for the recommender model to use for the message
template. Amazon Pinpoint uses this value to determine how to retrieve
and process data from a recommender model when it sends messages that
use the template, if the template contains message variables for
recommendation data.
$sel:templateDescription:SMSTemplateRequest', sMSTemplateRequest_templateDescription - A custom description of the message template.
$sel:tags:SMSTemplateRequest', sMSTemplateRequest_tags - A string-to-string map of key-value pairs that defines the tags to
associate with the message template. Each tag consists of a required tag
key and an associated tag value.
sMSTemplateRequest_body :: Lens' SMSTemplateRequest (Maybe Text) Source #
The message body to use in text messages that are based on the message template.
sMSTemplateRequest_defaultSubstitutions :: Lens' SMSTemplateRequest (Maybe Text) Source #
A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
sMSTemplateRequest_recommenderId :: Lens' SMSTemplateRequest (Maybe Text) Source #
The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
sMSTemplateRequest_templateDescription :: Lens' SMSTemplateRequest (Maybe Text) Source #
A custom description of the message template.
sMSTemplateRequest_tags :: Lens' SMSTemplateRequest (Maybe (HashMap Text Text)) Source #
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
SMSTemplateResponse
data SMSTemplateResponse Source #
Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.
See: newSMSTemplateResponse smart constructor.
Constructors
| SMSTemplateResponse' | |
Fields
| |
Instances
newSMSTemplateResponse Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> TemplateType | |
| -> SMSTemplateResponse |
Create a value of SMSTemplateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:SMSTemplateResponse', sMSTemplateResponse_arn - The Amazon Resource Name (ARN) of the message template.
$sel:body:SMSTemplateResponse', sMSTemplateResponse_body - The message body that's used in text messages that are based on the
message template.
$sel:defaultSubstitutions:SMSTemplateResponse', sMSTemplateResponse_defaultSubstitutions - The JSON object that specifies the default values that are used for
message variables in the message template. This object is a set of
key-value pairs. Each key defines a message variable in the template.
The corresponding value defines the default value for that variable.
$sel:recommenderId:SMSTemplateResponse', sMSTemplateResponse_recommenderId - The unique identifier for the recommender model that's used by the
message template.
$sel:templateDescription:SMSTemplateResponse', sMSTemplateResponse_templateDescription - The custom description of the message template.
$sel:version:SMSTemplateResponse', sMSTemplateResponse_version - The unique identifier, as an integer, for the active version of the
message template, or the version of the template that you specified by
using the version parameter in your request.
$sel:tags:SMSTemplateResponse', sMSTemplateResponse_tags - A string-to-string map of key-value pairs that identifies the tags that
are associated with the message template. Each tag consists of a
required tag key and an associated tag value.
$sel:lastModifiedDate:SMSTemplateResponse', sMSTemplateResponse_lastModifiedDate - The date, in ISO 8601 format, when the message template was last
modified.
$sel:creationDate:SMSTemplateResponse', sMSTemplateResponse_creationDate - The date, in ISO 8601 format, when the message template was created.
$sel:templateName:SMSTemplateResponse', sMSTemplateResponse_templateName - The name of the message template.
$sel:templateType:SMSTemplateResponse', sMSTemplateResponse_templateType - The type of channel that the message template is designed for. For an
SMS template, this value is SMS.
sMSTemplateResponse_arn :: Lens' SMSTemplateResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the message template.
sMSTemplateResponse_body :: Lens' SMSTemplateResponse (Maybe Text) Source #
The message body that's used in text messages that are based on the message template.
sMSTemplateResponse_defaultSubstitutions :: Lens' SMSTemplateResponse (Maybe Text) Source #
The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
sMSTemplateResponse_recommenderId :: Lens' SMSTemplateResponse (Maybe Text) Source #
The unique identifier for the recommender model that's used by the message template.
sMSTemplateResponse_templateDescription :: Lens' SMSTemplateResponse (Maybe Text) Source #
The custom description of the message template.
sMSTemplateResponse_version :: Lens' SMSTemplateResponse (Maybe Text) Source #
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
sMSTemplateResponse_tags :: Lens' SMSTemplateResponse (Maybe (HashMap Text Text)) Source #
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
sMSTemplateResponse_lastModifiedDate :: Lens' SMSTemplateResponse Text Source #
The date, in ISO 8601 format, when the message template was last modified.
sMSTemplateResponse_creationDate :: Lens' SMSTemplateResponse Text Source #
The date, in ISO 8601 format, when the message template was created.
sMSTemplateResponse_templateName :: Lens' SMSTemplateResponse Text Source #
The name of the message template.
sMSTemplateResponse_templateType :: Lens' SMSTemplateResponse TemplateType Source #
The type of channel that the message template is designed for. For an SMS template, this value is SMS.
Schedule
Specifies the schedule settings for a campaign.
See: newSchedule smart constructor.
Constructors
| Schedule' | |
Fields
| |
Instances
Create a value of Schedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endTime:Schedule', schedule_endTime - The scheduled time, in ISO 8601 format, when the campaign ended or will
end.
$sel:eventFilter:Schedule', schedule_eventFilter - The type of event that causes the campaign to be sent, if the value of
the Frequency property is EVENT.
$sel:frequency:Schedule', schedule_frequency - Specifies how often the campaign is sent or whether the campaign is sent
in response to a specific event.
$sel:isLocalTime:Schedule', schedule_isLocalTime - Specifies whether the start and end times for the campaign schedule use
each recipient's local time. To base the schedule on each recipient's
local time, set this value to true.
$sel:quietTime:Schedule', schedule_quietTime - The default quiet time for the campaign. Quiet time is a specific time
range when a campaign doesn't send messages to endpoints, if all the
following conditions are met:
- The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
- The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
- The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
$sel:timezone:Schedule', schedule_timezone - The starting UTC offset for the campaign schedule, if the value of the
IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02,
UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45,
UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30,
UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07,
UTC-08, UTC-09, UTC-10, and UTC-11.
$sel:startTime:Schedule', schedule_startTime - The scheduled time when the campaign began or will begin. Valid values
are: IMMEDIATE, to start the campaign immediately; or, a specific time
in ISO 8601 format.
schedule_endTime :: Lens' Schedule (Maybe Text) Source #
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
schedule_eventFilter :: Lens' Schedule (Maybe CampaignEventFilter) Source #
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
schedule_frequency :: Lens' Schedule (Maybe Frequency) Source #
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
schedule_isLocalTime :: Lens' Schedule (Maybe Bool) Source #
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
schedule_quietTime :: Lens' Schedule (Maybe QuietTime) Source #
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
- The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
- The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
- The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
schedule_timezone :: Lens' Schedule (Maybe Text) Source #
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
schedule_startTime :: Lens' Schedule Text Source #
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
SegmentBehaviors
data SegmentBehaviors Source #
Specifies dimension settings for including or excluding endpoints from a segment based on how recently an endpoint was active.
See: newSegmentBehaviors smart constructor.
Constructors
| SegmentBehaviors' | |
Fields
| |
Instances
newSegmentBehaviors :: SegmentBehaviors Source #
Create a value of SegmentBehaviors with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recency:SegmentBehaviors', segmentBehaviors_recency - The dimension settings that are based on how recently an endpoint was
active.
segmentBehaviors_recency :: Lens' SegmentBehaviors (Maybe RecencyDimension) Source #
The dimension settings that are based on how recently an endpoint was active.
SegmentCondition
data SegmentCondition Source #
Specifies a segment to associate with an activity in a journey.
See: newSegmentCondition smart constructor.
Constructors
| SegmentCondition' | |
Instances
Arguments
| :: Text | |
| -> SegmentCondition |
Create a value of SegmentCondition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:segmentId:SegmentCondition', segmentCondition_segmentId - The unique identifier for the segment to associate with the activity.
segmentCondition_segmentId :: Lens' SegmentCondition Text Source #
The unique identifier for the segment to associate with the activity.
SegmentDemographics
data SegmentDemographics Source #
Specifies demographic-based dimension settings for including or excluding endpoints from a segment. These settings derive from characteristics of endpoint devices, such as platform, make, and model.
See: newSegmentDemographics smart constructor.
Constructors
| SegmentDemographics' | |
Fields
| |
Instances
newSegmentDemographics :: SegmentDemographics Source #
Create a value of SegmentDemographics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appVersion:SegmentDemographics', segmentDemographics_appVersion - The app version criteria for the segment.
$sel:channel:SegmentDemographics', segmentDemographics_channel - The channel criteria for the segment.
$sel:deviceType:SegmentDemographics', segmentDemographics_deviceType - The device type criteria for the segment.
$sel:make:SegmentDemographics', segmentDemographics_make - The device make criteria for the segment.
$sel:model:SegmentDemographics', segmentDemographics_model - The device model criteria for the segment.
$sel:platform:SegmentDemographics', segmentDemographics_platform - The device platform criteria for the segment.
segmentDemographics_appVersion :: Lens' SegmentDemographics (Maybe SetDimension) Source #
The app version criteria for the segment.
segmentDemographics_channel :: Lens' SegmentDemographics (Maybe SetDimension) Source #
The channel criteria for the segment.
segmentDemographics_deviceType :: Lens' SegmentDemographics (Maybe SetDimension) Source #
The device type criteria for the segment.
segmentDemographics_make :: Lens' SegmentDemographics (Maybe SetDimension) Source #
The device make criteria for the segment.
segmentDemographics_model :: Lens' SegmentDemographics (Maybe SetDimension) Source #
The device model criteria for the segment.
segmentDemographics_platform :: Lens' SegmentDemographics (Maybe SetDimension) Source #
The device platform criteria for the segment.
SegmentDimensions
data SegmentDimensions Source #
Specifies the dimension settings for a segment.
See: newSegmentDimensions smart constructor.
Constructors
| SegmentDimensions' | |
Fields
| |
Instances
newSegmentDimensions :: SegmentDimensions Source #
Create a value of SegmentDimensions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:SegmentDimensions', segmentDimensions_attributes - One or more custom attributes to use as criteria for the segment.
$sel:behavior:SegmentDimensions', segmentDimensions_behavior - The behavior-based criteria, such as how recently users have used your
app, for the segment.
$sel:demographic:SegmentDimensions', segmentDimensions_demographic - The demographic-based criteria, such as device platform, for the
segment.
$sel:location:SegmentDimensions', segmentDimensions_location - The location-based criteria, such as region or GPS coordinates, for the
segment.
$sel:metrics:SegmentDimensions', segmentDimensions_metrics - One or more custom metrics to use as criteria for the segment.
$sel:userAttributes:SegmentDimensions', segmentDimensions_userAttributes - One or more custom user attributes to use as criteria for the segment.
segmentDimensions_attributes :: Lens' SegmentDimensions (Maybe (HashMap Text AttributeDimension)) Source #
One or more custom attributes to use as criteria for the segment.
segmentDimensions_behavior :: Lens' SegmentDimensions (Maybe SegmentBehaviors) Source #
The behavior-based criteria, such as how recently users have used your app, for the segment.
segmentDimensions_demographic :: Lens' SegmentDimensions (Maybe SegmentDemographics) Source #
The demographic-based criteria, such as device platform, for the segment.
segmentDimensions_location :: Lens' SegmentDimensions (Maybe SegmentLocation) Source #
The location-based criteria, such as region or GPS coordinates, for the segment.
segmentDimensions_metrics :: Lens' SegmentDimensions (Maybe (HashMap Text MetricDimension)) Source #
One or more custom metrics to use as criteria for the segment.
segmentDimensions_userAttributes :: Lens' SegmentDimensions (Maybe (HashMap Text AttributeDimension)) Source #
One or more custom user attributes to use as criteria for the segment.
SegmentGroup
data SegmentGroup Source #
Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.
See: newSegmentGroup smart constructor.
Constructors
| SegmentGroup' | |
Fields
| |
Instances
newSegmentGroup :: SegmentGroup Source #
Create a value of SegmentGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensions:SegmentGroup', segmentGroup_dimensions - An array that defines the dimensions for the segment.
$sel:sourceSegments:SegmentGroup', segmentGroup_sourceSegments - The base segment to build the segment on. A base segment, also referred
to as a source segment, defines the initial population of endpoints
for a segment. When you add dimensions to a segment, Amazon Pinpoint
filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
$sel:sourceType:SegmentGroup', segmentGroup_sourceType - Specifies how to handle multiple base segments for the segment. For
example, if you specify three base segments for the segment, whether the
resulting segment is based on all, any, or none of the base segments.
$sel:type':SegmentGroup', segmentGroup_type - Specifies how to handle multiple dimensions for the segment. For
example, if you specify three dimensions for the segment, whether the
resulting segment includes endpoints that match all, any, or none of the
dimensions.
segmentGroup_dimensions :: Lens' SegmentGroup (Maybe [SegmentDimensions]) Source #
An array that defines the dimensions for the segment.
segmentGroup_sourceSegments :: Lens' SegmentGroup (Maybe [SegmentReference]) Source #
The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
segmentGroup_sourceType :: Lens' SegmentGroup (Maybe SourceType) Source #
Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
segmentGroup_type :: Lens' SegmentGroup (Maybe Type) Source #
Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
SegmentGroupList
data SegmentGroupList Source #
Specifies the settings that define the relationships between segment groups for a segment.
See: newSegmentGroupList smart constructor.
Constructors
| SegmentGroupList' | |
Fields
| |
Instances
newSegmentGroupList :: SegmentGroupList Source #
Create a value of SegmentGroupList with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groups:SegmentGroupList', segmentGroupList_groups - An array that defines the set of segment criteria to evaluate when
handling segment groups for the segment.
$sel:include:SegmentGroupList', segmentGroupList_include - Specifies how to handle multiple segment groups for the segment. For
example, if the segment includes three segment groups, whether the
resulting segment includes endpoints that match all, any, or none of the
segment groups.
segmentGroupList_groups :: Lens' SegmentGroupList (Maybe [SegmentGroup]) Source #
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
segmentGroupList_include :: Lens' SegmentGroupList (Maybe Include) Source #
Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
SegmentImportResource
data SegmentImportResource Source #
Provides information about the import job that created a segment. An import job is a job that creates a user segment by importing endpoint definitions.
See: newSegmentImportResource smart constructor.
Constructors
| SegmentImportResource' | |
Fields
| |
Instances
newSegmentImportResource Source #
Arguments
| :: DefinitionFormat | |
| -> Text | |
| -> Int | |
| -> Text | |
| -> Text | |
| -> SegmentImportResource |
Create a value of SegmentImportResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelCounts:SegmentImportResource', segmentImportResource_channelCounts - The number of channel types in the endpoint definitions that were
imported to create the segment.
$sel:format:SegmentImportResource', segmentImportResource_format - The format of the files that were imported to create the segment. Valid
values are: CSV, for comma-separated values format; and, JSON, for
newline-delimited JSON format.
$sel:s3Url:SegmentImportResource', segmentImportResource_s3Url - The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the
endpoint definitions were imported from to create the segment.
$sel:size:SegmentImportResource', segmentImportResource_size - The number of endpoint definitions that were imported successfully to
create the segment.
$sel:externalId:SegmentImportResource', segmentImportResource_externalId - (Deprecated) Your AWS account ID, which you assigned to an external ID
key in an IAM trust policy. Amazon Pinpoint previously used this value
to assume an IAM role when importing endpoint definitions, but we
removed this requirement. We don't recommend use of external IDs for
IAM roles that are assumed by Amazon Pinpoint.
$sel:roleArn:SegmentImportResource', segmentImportResource_roleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that authorized Amazon Pinpoint to access the Amazon S3
location to import endpoint definitions from.
segmentImportResource_channelCounts :: Lens' SegmentImportResource (Maybe (HashMap Text Int)) Source #
The number of channel types in the endpoint definitions that were imported to create the segment.
segmentImportResource_format :: Lens' SegmentImportResource DefinitionFormat Source #
The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
segmentImportResource_s3Url :: Lens' SegmentImportResource Text Source #
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
segmentImportResource_size :: Lens' SegmentImportResource Int Source #
The number of endpoint definitions that were imported successfully to create the segment.
segmentImportResource_externalId :: Lens' SegmentImportResource Text Source #
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
segmentImportResource_roleArn :: Lens' SegmentImportResource Text Source #
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
SegmentLocation
data SegmentLocation Source #
Specifies geographical dimension settings for a segment.
See: newSegmentLocation smart constructor.
Constructors
| SegmentLocation' | |
Fields
| |
Instances
newSegmentLocation :: SegmentLocation Source #
Create a value of SegmentLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:country:SegmentLocation', segmentLocation_country - The country or region code, in ISO 3166-1 alpha-2 format, for the
segment.
$sel:gPSPoint:SegmentLocation', segmentLocation_gPSPoint - The GPS location and range for the segment.
segmentLocation_country :: Lens' SegmentLocation (Maybe SetDimension) Source #
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
segmentLocation_gPSPoint :: Lens' SegmentLocation (Maybe GPSPointDimension) Source #
The GPS location and range for the segment.
SegmentReference
data SegmentReference Source #
Specifies the segment identifier and version of a segment.
See: newSegmentReference smart constructor.
Constructors
| SegmentReference' | |
Instances
Arguments
| :: Text | |
| -> SegmentReference |
Create a value of SegmentReference with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:version:SegmentReference', segmentReference_version - The version number of the segment.
$sel:id:SegmentReference', segmentReference_id - The unique identifier for the segment.
segmentReference_version :: Lens' SegmentReference (Maybe Int) Source #
The version number of the segment.
segmentReference_id :: Lens' SegmentReference Text Source #
The unique identifier for the segment.
SegmentResponse
data SegmentResponse Source #
Provides information about the configuration, dimension, and other settings for a segment.
See: newSegmentResponse smart constructor.
Constructors
| SegmentResponse' | |
Fields
| |
Instances
Arguments
| :: SegmentType | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> SegmentResponse |
Create a value of SegmentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensions:SegmentResponse', segmentResponse_dimensions - The dimension settings for the segment.
$sel:importDefinition:SegmentResponse', segmentResponse_importDefinition - The settings for the import job that's associated with the segment.
$sel:lastModifiedDate:SegmentResponse', segmentResponse_lastModifiedDate - The date and time when the segment was last modified.
$sel:name:SegmentResponse', segmentResponse_name - The name of the segment.
$sel:segmentGroups:SegmentResponse', segmentResponse_segmentGroups - A list of one or more segment groups that apply to the segment. Each
segment group consists of zero or more base segments and the dimensions
that are applied to those base segments.
$sel:version:SegmentResponse', segmentResponse_version - The version number of the segment.
$sel:tags:SegmentResponse', segmentResponse_tags - A string-to-string map of key-value pairs that identifies the tags that
are associated with the segment. Each tag consists of a required tag key
and an associated tag value.
$sel:segmentType:SegmentResponse', segmentResponse_segmentType - The segment type. Valid values are:
- DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
- IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.
$sel:creationDate:SegmentResponse', segmentResponse_creationDate - The date and time when the segment was created.
$sel:id:SegmentResponse', segmentResponse_id - The unique identifier for the segment.
$sel:arn:SegmentResponse', segmentResponse_arn - The Amazon Resource Name (ARN) of the segment.
$sel:applicationId:SegmentResponse', segmentResponse_applicationId - The unique identifier for the application that the segment is associated
with.
segmentResponse_dimensions :: Lens' SegmentResponse (Maybe SegmentDimensions) Source #
The dimension settings for the segment.
segmentResponse_importDefinition :: Lens' SegmentResponse (Maybe SegmentImportResource) Source #
The settings for the import job that's associated with the segment.
segmentResponse_lastModifiedDate :: Lens' SegmentResponse (Maybe Text) Source #
The date and time when the segment was last modified.
segmentResponse_name :: Lens' SegmentResponse (Maybe Text) Source #
The name of the segment.
segmentResponse_segmentGroups :: Lens' SegmentResponse (Maybe SegmentGroupList) Source #
A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
segmentResponse_version :: Lens' SegmentResponse (Maybe Int) Source #
The version number of the segment.
segmentResponse_tags :: Lens' SegmentResponse (Maybe (HashMap Text Text)) Source #
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
segmentResponse_segmentType :: Lens' SegmentResponse SegmentType Source #
The segment type. Valid values are:
- DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
- IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.
segmentResponse_creationDate :: Lens' SegmentResponse Text Source #
The date and time when the segment was created.
segmentResponse_id :: Lens' SegmentResponse Text Source #
The unique identifier for the segment.
segmentResponse_arn :: Lens' SegmentResponse Text Source #
The Amazon Resource Name (ARN) of the segment.
segmentResponse_applicationId :: Lens' SegmentResponse Text Source #
The unique identifier for the application that the segment is associated with.
SegmentsResponse
data SegmentsResponse Source #
Provides information about all the segments that are associated with an application.
See: newSegmentsResponse smart constructor.
Constructors
| SegmentsResponse' | |
Fields
| |
Instances
newSegmentsResponse :: SegmentsResponse Source #
Create a value of SegmentsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:SegmentsResponse', segmentsResponse_nextToken - The string to use in a subsequent request to get the next page of
results in a paginated response. This value is null if there are no
additional pages.
$sel:item:SegmentsResponse', segmentsResponse_item - An array of responses, one for each segment that's associated with the
application (Segments resource) or each version of a segment that's
associated with the application (Segment Versions resource).
segmentsResponse_nextToken :: Lens' SegmentsResponse (Maybe Text) Source #
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
segmentsResponse_item :: Lens' SegmentsResponse [SegmentResponse] Source #
An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).
SendOTPMessageRequestParameters
data SendOTPMessageRequestParameters Source #
Send OTP message request parameters.
See: newSendOTPMessageRequestParameters smart constructor.
Constructors
| SendOTPMessageRequestParameters' | |
Fields
| |
Instances
newSendOTPMessageRequestParameters Source #
Create a value of SendOTPMessageRequestParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowedAttempts:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_allowedAttempts - The attempts allowed to validate an OTP.
$sel:codeLength:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_codeLength - The number of characters in the generated OTP.
$sel:entityId:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_entityId - A unique Entity ID received from DLT after entity registration is
approved.
$sel:language:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_language - The language to be used for the outgoing message body containing the
OTP.
$sel:templateId:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_templateId - A unique Template ID received from DLT after entity registration is
approved.
$sel:validityPeriod:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_validityPeriod - The time in minutes before the OTP is no longer valid.
$sel:brandName:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_brandName - The brand name that will be substituted into the OTP message body.
Should be owned by calling AWS account.
$sel:referenceId:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_referenceId - Developer-specified reference identifier. Required to match during OTP
verification.
$sel:channel:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_channel - Channel type for the OTP message. Supported values: [SMS].
$sel:destinationIdentity:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_destinationIdentity - The destination identity to send OTP to.
$sel:originationIdentity:SendOTPMessageRequestParameters', sendOTPMessageRequestParameters_originationIdentity - The origination identity used to send OTP from.
sendOTPMessageRequestParameters_allowedAttempts :: Lens' SendOTPMessageRequestParameters (Maybe Int) Source #
The attempts allowed to validate an OTP.
sendOTPMessageRequestParameters_codeLength :: Lens' SendOTPMessageRequestParameters (Maybe Int) Source #
The number of characters in the generated OTP.
sendOTPMessageRequestParameters_entityId :: Lens' SendOTPMessageRequestParameters (Maybe Text) Source #
A unique Entity ID received from DLT after entity registration is approved.
sendOTPMessageRequestParameters_language :: Lens' SendOTPMessageRequestParameters (Maybe Text) Source #
The language to be used for the outgoing message body containing the OTP.
sendOTPMessageRequestParameters_templateId :: Lens' SendOTPMessageRequestParameters (Maybe Text) Source #
A unique Template ID received from DLT after entity registration is approved.
sendOTPMessageRequestParameters_validityPeriod :: Lens' SendOTPMessageRequestParameters (Maybe Int) Source #
The time in minutes before the OTP is no longer valid.
sendOTPMessageRequestParameters_brandName :: Lens' SendOTPMessageRequestParameters Text Source #
The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.
sendOTPMessageRequestParameters_referenceId :: Lens' SendOTPMessageRequestParameters Text Source #
Developer-specified reference identifier. Required to match during OTP verification.
sendOTPMessageRequestParameters_channel :: Lens' SendOTPMessageRequestParameters Text Source #
Channel type for the OTP message. Supported values: [SMS].
sendOTPMessageRequestParameters_destinationIdentity :: Lens' SendOTPMessageRequestParameters Text Source #
The destination identity to send OTP to.
sendOTPMessageRequestParameters_originationIdentity :: Lens' SendOTPMessageRequestParameters Text Source #
The origination identity used to send OTP from.
SendUsersMessageRequest
data SendUsersMessageRequest Source #
Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.
See: newSendUsersMessageRequest smart constructor.
Constructors
| SendUsersMessageRequest' | |
Fields
| |
Instances
newSendUsersMessageRequest Source #
Arguments
| :: DirectMessageConfiguration | |
| -> SendUsersMessageRequest |
Create a value of SendUsersMessageRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SendUsersMessageRequest, sendUsersMessageRequest_context - A map of custom attribute-value pairs. For a push notification, Amazon
Pinpoint adds these attributes to the data.pinpoint object in the body
of the notification payload. Amazon Pinpoint also provides these
attributes in the events that it generates for users-messages
deliveries.
$sel:templateConfiguration:SendUsersMessageRequest', sendUsersMessageRequest_templateConfiguration - The message template to use for the message.
$sel:traceId:SendUsersMessageRequest', sendUsersMessageRequest_traceId - The unique identifier for tracing the message. This identifier is
visible to message recipients.
$sel:messageConfiguration:SendUsersMessageRequest', sendUsersMessageRequest_messageConfiguration - The settings and content for the default message and any default
messages that you defined for specific channels.
$sel:users:SendUsersMessageRequest', sendUsersMessageRequest_users - A map that associates user IDs with
EndpointSendConfiguration
objects. You can use an
EndpointSendConfiguration
object to tailor the message for a user by specifying settings such as
content overrides and message variables.
sendUsersMessageRequest_context :: Lens' SendUsersMessageRequest (Maybe (HashMap Text Text)) Source #
A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.
sendUsersMessageRequest_templateConfiguration :: Lens' SendUsersMessageRequest (Maybe TemplateConfiguration) Source #
The message template to use for the message.
sendUsersMessageRequest_traceId :: Lens' SendUsersMessageRequest (Maybe Text) Source #
The unique identifier for tracing the message. This identifier is visible to message recipients.
sendUsersMessageRequest_messageConfiguration :: Lens' SendUsersMessageRequest DirectMessageConfiguration Source #
The settings and content for the default message and any default messages that you defined for specific channels.
sendUsersMessageRequest_users :: Lens' SendUsersMessageRequest (HashMap Text EndpointSendConfiguration) Source #
A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.
SendUsersMessageResponse
data SendUsersMessageResponse Source #
Provides information about which users and endpoints a message was sent to.
See: newSendUsersMessageResponse smart constructor.
Constructors
| SendUsersMessageResponse' | |
Fields
| |
Instances
newSendUsersMessageResponse Source #
Create a value of SendUsersMessageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:requestId:SendUsersMessageResponse', sendUsersMessageResponse_requestId - The unique identifier that was assigned to the message request.
$sel:result:SendUsersMessageResponse', sendUsersMessageResponse_result - An object that indicates which endpoints the message was sent to, for
each user. The object lists user IDs and, for each user ID, provides the
endpoint IDs that the message was sent to. For each endpoint ID, it
provides an EndpointMessageResult object.
$sel:applicationId:SendUsersMessageResponse', sendUsersMessageResponse_applicationId - The unique identifier for the application that was used to send the
message.
sendUsersMessageResponse_requestId :: Lens' SendUsersMessageResponse (Maybe Text) Source #
The unique identifier that was assigned to the message request.
sendUsersMessageResponse_result :: Lens' SendUsersMessageResponse (Maybe (HashMap Text (HashMap Text EndpointMessageResult))) Source #
An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.
sendUsersMessageResponse_applicationId :: Lens' SendUsersMessageResponse Text Source #
The unique identifier for the application that was used to send the message.
Session
Provides information about a session.
See: newSession smart constructor.
Constructors
| Session' | |
Fields
| |
Instances
| ToJSON Session Source # | |
Defined in Amazonka.Pinpoint.Types.Session | |
| Generic Session Source # | |
| Read Session Source # | |
| Show Session Source # | |
| NFData Session Source # | |
Defined in Amazonka.Pinpoint.Types.Session | |
| Eq Session Source # | |
| Hashable Session Source # | |
Defined in Amazonka.Pinpoint.Types.Session | |
| type Rep Session Source # | |
Defined in Amazonka.Pinpoint.Types.Session type Rep Session = D1 ('MetaData "Session" "Amazonka.Pinpoint.Types.Session" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "Session'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "stopTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "startTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of Session with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:duration:Session', session_duration - The duration of the session, in milliseconds.
$sel:stopTimestamp:Session', session_stopTimestamp - The date and time when the session ended.
$sel:startTimestamp:Session', session_startTimestamp - The date and time when the session began.
$sel:id:Session', session_id - The unique identifier for the session.
session_stopTimestamp :: Lens' Session (Maybe Text) Source #
The date and time when the session ended.
SetDimension
data SetDimension Source #
Specifies the dimension type and values for a segment dimension.
See: newSetDimension smart constructor.
Constructors
| SetDimension' | |
Fields
| |
Instances
newSetDimension :: SetDimension Source #
Create a value of SetDimension with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensionType:SetDimension', setDimension_dimensionType - The type of segment dimension to use. Valid values are: INCLUSIVE,
endpoints that match the criteria are included in the segment; and,
EXCLUSIVE, endpoints that match the criteria are excluded from the
segment.
$sel:values:SetDimension', setDimension_values - The criteria values to use for the segment dimension. Depending on the
value of the DimensionType property, endpoints are included or excluded
from the segment if their values match the criteria values.
setDimension_dimensionType :: Lens' SetDimension (Maybe DimensionType) Source #
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
setDimension_values :: Lens' SetDimension [Text] Source #
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
SimpleCondition
data SimpleCondition Source #
Specifies a condition to evaluate for an activity in a journey.
See: newSimpleCondition smart constructor.
Constructors
| SimpleCondition' | |
Fields
| |
Instances
newSimpleCondition :: SimpleCondition Source #
Create a value of SimpleCondition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventCondition:SimpleCondition', simpleCondition_eventCondition - The dimension settings for the event that's associated with the
activity.
$sel:segmentCondition:SimpleCondition', simpleCondition_segmentCondition - The segment that's associated with the activity.
$sel:segmentDimensions:SimpleCondition', simpleCondition_segmentDimensions - The dimension settings for the segment that's associated with the
activity.
simpleCondition_eventCondition :: Lens' SimpleCondition (Maybe EventCondition) Source #
The dimension settings for the event that's associated with the activity.
simpleCondition_segmentCondition :: Lens' SimpleCondition (Maybe SegmentCondition) Source #
The segment that's associated with the activity.
simpleCondition_segmentDimensions :: Lens' SimpleCondition (Maybe SegmentDimensions) Source #
The dimension settings for the segment that's associated with the activity.
SimpleEmail
data SimpleEmail Source #
Specifies the contents of an email message, composed of a subject, a text part, and an HTML part.
See: newSimpleEmail smart constructor.
Constructors
| SimpleEmail' | |
Fields
| |
Instances
newSimpleEmail :: SimpleEmail Source #
Create a value of SimpleEmail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:htmlPart:SimpleEmail', simpleEmail_htmlPart - The body of the email message, in HTML format. We recommend using HTML
format for email clients that render HTML content. You can include
links, formatted text, and more in an HTML message.
$sel:subject:SimpleEmail', simpleEmail_subject - The subject line, or title, of the email.
$sel:textPart:SimpleEmail', simpleEmail_textPart - The body of the email message, in plain text format. We recommend using
plain text format for email clients that don't render HTML content and
clients that are connected to high-latency networks, such as mobile
devices.
simpleEmail_htmlPart :: Lens' SimpleEmail (Maybe SimpleEmailPart) Source #
The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
simpleEmail_subject :: Lens' SimpleEmail (Maybe SimpleEmailPart) Source #
The subject line, or title, of the email.
simpleEmail_textPart :: Lens' SimpleEmail (Maybe SimpleEmailPart) Source #
The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
SimpleEmailPart
data SimpleEmailPart Source #
Specifies the subject or body of an email message, represented as textual email data and the applicable character set.
See: newSimpleEmailPart smart constructor.
Constructors
| SimpleEmailPart' | |
Instances
newSimpleEmailPart :: SimpleEmailPart Source #
Create a value of SimpleEmailPart with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:charset:SimpleEmailPart', simpleEmailPart_charset - The applicable character set for the message content.
$sel:data':SimpleEmailPart', simpleEmailPart_data - The textual data of the message content.
simpleEmailPart_charset :: Lens' SimpleEmailPart (Maybe Text) Source #
The applicable character set for the message content.
simpleEmailPart_data :: Lens' SimpleEmailPart (Maybe Text) Source #
The textual data of the message content.
StartCondition
data StartCondition Source #
Specifies the conditions for the first activity in a journey. This activity and its conditions determine which users are participants in a journey.
See: newStartCondition smart constructor.
Constructors
| StartCondition' | |
Fields
| |
Instances
newStartCondition :: StartCondition Source #
Create a value of StartCondition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:StartCondition', startCondition_description - The custom description of the condition.
$sel:eventStartCondition:StartCondition', startCondition_eventStartCondition - Undocumented member.
$sel:segmentStartCondition:StartCondition', startCondition_segmentStartCondition - The segment that's associated with the first activity in the journey.
This segment determines which users are participants in the journey.
startCondition_description :: Lens' StartCondition (Maybe Text) Source #
The custom description of the condition.
startCondition_eventStartCondition :: Lens' StartCondition (Maybe EventStartCondition) Source #
Undocumented member.
startCondition_segmentStartCondition :: Lens' StartCondition (Maybe SegmentCondition) Source #
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
TagsModel
Specifies the tags (keys and values) for an application, campaign, message template, or segment.
See: newTagsModel smart constructor.
Constructors
| TagsModel' | |
Fields
| |
Instances
| FromJSON TagsModel Source # | |
| ToJSON TagsModel Source # | |
Defined in Amazonka.Pinpoint.Types.TagsModel | |
| Generic TagsModel Source # | |
| Read TagsModel Source # | |
| Show TagsModel Source # | |
| NFData TagsModel Source # | |
Defined in Amazonka.Pinpoint.Types.TagsModel | |
| Eq TagsModel Source # | |
| Hashable TagsModel Source # | |
Defined in Amazonka.Pinpoint.Types.TagsModel | |
| type Rep TagsModel Source # | |
Defined in Amazonka.Pinpoint.Types.TagsModel | |
newTagsModel :: TagsModel Source #
Create a value of TagsModel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:TagsModel', tagsModel_tags - A string-to-string map of key-value pairs that defines the tags for an
application, campaign, message template, or segment. Each of these
resources can have a maximum of 50 tags.
Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
tagsModel_tags :: Lens' TagsModel (HashMap Text Text) Source #
A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.
Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
Template
Specifies the name and version of the message template to use for the message.
See: newTemplate smart constructor.
Constructors
| Template' | |
Fields
| |
Instances
| FromJSON Template Source # | |
| ToJSON Template Source # | |
Defined in Amazonka.Pinpoint.Types.Template | |
| Generic Template Source # | |
| Read Template Source # | |
| Show Template Source # | |
| NFData Template Source # | |
Defined in Amazonka.Pinpoint.Types.Template | |
| Eq Template Source # | |
| Hashable Template Source # | |
Defined in Amazonka.Pinpoint.Types.Template | |
| type Rep Template Source # | |
Defined in Amazonka.Pinpoint.Types.Template type Rep Template = D1 ('MetaData "Template" "Amazonka.Pinpoint.Types.Template" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "Template'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newTemplate :: Template Source #
Create a value of Template with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Template', template_name - The name of the message template to use for the message. If specified,
this value must match the name of an existing message template.
$sel:version:Template', template_version - The unique identifier for the version of the message template to use for
the message. If specified, this value must match the identifier for an
existing template version. To retrieve a list of versions and version
identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
template_name :: Lens' Template (Maybe Text) Source #
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
template_version :: Lens' Template (Maybe Text) Source #
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
TemplateActiveVersionRequest
data TemplateActiveVersionRequest Source #
Specifies which version of a message template to use as the active version of the template.
See: newTemplateActiveVersionRequest smart constructor.
Constructors
| TemplateActiveVersionRequest' | |
Fields
| |
Instances
newTemplateActiveVersionRequest :: TemplateActiveVersionRequest Source #
Create a value of TemplateActiveVersionRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:version:TemplateActiveVersionRequest', templateActiveVersionRequest_version - The version of the message template to use as the active version of the
template. Valid values are: latest, for the most recent version of the
template; or, the unique identifier for any existing version of the
template. If you specify an identifier, the value must match the
identifier for an existing template version. To retrieve a list of
versions and version identifiers for a template, use the Template
Versions resource.
templateActiveVersionRequest_version :: Lens' TemplateActiveVersionRequest (Maybe Text) Source #
The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
TemplateConfiguration
data TemplateConfiguration Source #
Specifies the message template to use for the message, for each type of channel.
See: newTemplateConfiguration smart constructor.
Constructors
| TemplateConfiguration' | |
Fields
| |
Instances
newTemplateConfiguration :: TemplateConfiguration Source #
Create a value of TemplateConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:emailTemplate:TemplateConfiguration', templateConfiguration_emailTemplate - The email template to use for the message.
$sel:pushTemplate:TemplateConfiguration', templateConfiguration_pushTemplate - The push notification template to use for the message.
$sel:sMSTemplate:TemplateConfiguration', templateConfiguration_sMSTemplate - The SMS template to use for the message.
$sel:voiceTemplate:TemplateConfiguration', templateConfiguration_voiceTemplate - The voice template to use for the message. This object isn't supported
for campaigns.
templateConfiguration_emailTemplate :: Lens' TemplateConfiguration (Maybe Template) Source #
The email template to use for the message.
templateConfiguration_pushTemplate :: Lens' TemplateConfiguration (Maybe Template) Source #
The push notification template to use for the message.
templateConfiguration_sMSTemplate :: Lens' TemplateConfiguration (Maybe Template) Source #
The SMS template to use for the message.
templateConfiguration_voiceTemplate :: Lens' TemplateConfiguration (Maybe Template) Source #
The voice template to use for the message. This object isn't supported for campaigns.
TemplateCreateMessageBody
data TemplateCreateMessageBody Source #
Provides information about a request to create a message template.
See: newTemplateCreateMessageBody smart constructor.
Constructors
| TemplateCreateMessageBody' | |
Instances
newTemplateCreateMessageBody :: TemplateCreateMessageBody Source #
Create a value of TemplateCreateMessageBody with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:TemplateCreateMessageBody', templateCreateMessageBody_arn - The Amazon Resource Name (ARN) of the message template that was created.
$sel:message:TemplateCreateMessageBody', templateCreateMessageBody_message - The message that's returned from the API for the request to create the
message template.
$sel:requestID:TemplateCreateMessageBody', templateCreateMessageBody_requestID - The unique identifier for the request to create the message template.
templateCreateMessageBody_arn :: Lens' TemplateCreateMessageBody (Maybe Text) Source #
The Amazon Resource Name (ARN) of the message template that was created.
templateCreateMessageBody_message :: Lens' TemplateCreateMessageBody (Maybe Text) Source #
The message that's returned from the API for the request to create the message template.
templateCreateMessageBody_requestID :: Lens' TemplateCreateMessageBody (Maybe Text) Source #
The unique identifier for the request to create the message template.
TemplateResponse
data TemplateResponse Source #
Provides information about a message template that's associated with your Amazon Pinpoint account.
See: newTemplateResponse smart constructor.
Constructors
| TemplateResponse' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> TemplateType | |
| -> TemplateResponse |
Create a value of TemplateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:TemplateResponse', templateResponse_arn - The Amazon Resource Name (ARN) of the message template. This value
isn't included in a TemplateResponse object. To retrieve the ARN of a
template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or
GetVoiceTemplate operation, depending on the type of template that you
want to retrieve the ARN for.
$sel:defaultSubstitutions:TemplateResponse', templateResponse_defaultSubstitutions - The JSON object that specifies the default values that are used for
message variables in the message template. This object isn't included
in a TemplateResponse object. To retrieve this object for a template,
use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or
GetVoiceTemplate operation, depending on the type of template that you
want to retrieve the object for.
$sel:templateDescription:TemplateResponse', templateResponse_templateDescription - The custom description of the message template. This value isn't
included in a TemplateResponse object. To retrieve the description of a
template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or
GetVoiceTemplate operation, depending on the type of template that you
want to retrieve the description for.
$sel:version:TemplateResponse', templateResponse_version - The unique identifier, as an integer, for the active version of the
message template.
$sel:tags:TemplateResponse', templateResponse_tags - A map of key-value pairs that identifies the tags that are associated
with the message template. This object isn't included in a
TemplateResponse object. To retrieve this object for a template, use the
GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate
operation, depending on the type of template that you want to retrieve
the object for.
$sel:lastModifiedDate:TemplateResponse', templateResponse_lastModifiedDate - The date, in ISO 8601 format, when the message template was last
modified.
$sel:creationDate:TemplateResponse', templateResponse_creationDate - The date, in ISO 8601 format, when the message template was created.
$sel:templateName:TemplateResponse', templateResponse_templateName - The name of the message template.
$sel:templateType:TemplateResponse', templateResponse_templateType - The type of channel that the message template is designed for. Possible
values are: EMAIL, PUSH, SMS, and VOICE.
templateResponse_arn :: Lens' TemplateResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.
templateResponse_defaultSubstitutions :: Lens' TemplateResponse (Maybe Text) Source #
The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
templateResponse_templateDescription :: Lens' TemplateResponse (Maybe Text) Source #
The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.
templateResponse_version :: Lens' TemplateResponse (Maybe Text) Source #
The unique identifier, as an integer, for the active version of the message template.
templateResponse_tags :: Lens' TemplateResponse (Maybe (HashMap Text Text)) Source #
A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
templateResponse_lastModifiedDate :: Lens' TemplateResponse Text Source #
The date, in ISO 8601 format, when the message template was last modified.
templateResponse_creationDate :: Lens' TemplateResponse Text Source #
The date, in ISO 8601 format, when the message template was created.
templateResponse_templateName :: Lens' TemplateResponse Text Source #
The name of the message template.
templateResponse_templateType :: Lens' TemplateResponse TemplateType Source #
The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.
TemplateVersionResponse
data TemplateVersionResponse Source #
Provides information about a specific version of a message template.
See: newTemplateVersionResponse smart constructor.
Constructors
| TemplateVersionResponse' | |
Fields
| |
Instances
newTemplateVersionResponse Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> TemplateVersionResponse |
Create a value of TemplateVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultSubstitutions:TemplateVersionResponse', templateVersionResponse_defaultSubstitutions - A JSON object that specifies the default values that are used for
message variables in the version of the message template. This object is
a set of key-value pairs. Each key defines a message variable in the
template. The corresponding value defines the default value for that
variable.
$sel:templateDescription:TemplateVersionResponse', templateVersionResponse_templateDescription - The custom description of the version of the message template.
$sel:version:TemplateVersionResponse', templateVersionResponse_version - The unique identifier for the version of the message template. This
value is an integer that Amazon Pinpoint automatically increments and
assigns to each new version of a template.
$sel:lastModifiedDate:TemplateVersionResponse', templateVersionResponse_lastModifiedDate - The date, in ISO 8601 format, when the version of the message template
was last modified.
$sel:creationDate:TemplateVersionResponse', templateVersionResponse_creationDate - The date, in ISO 8601 format, when the version of the message template
was created.
$sel:templateName:TemplateVersionResponse', templateVersionResponse_templateName - The name of the message template.
$sel:templateType:TemplateVersionResponse', templateVersionResponse_templateType - The type of channel that the message template is designed for. Possible
values are: EMAIL, PUSH, SMS, and VOICE.
templateVersionResponse_defaultSubstitutions :: Lens' TemplateVersionResponse (Maybe Text) Source #
A JSON object that specifies the default values that are used for message variables in the version of the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
templateVersionResponse_templateDescription :: Lens' TemplateVersionResponse (Maybe Text) Source #
The custom description of the version of the message template.
templateVersionResponse_version :: Lens' TemplateVersionResponse (Maybe Text) Source #
The unique identifier for the version of the message template. This value is an integer that Amazon Pinpoint automatically increments and assigns to each new version of a template.
templateVersionResponse_lastModifiedDate :: Lens' TemplateVersionResponse Text Source #
The date, in ISO 8601 format, when the version of the message template was last modified.
templateVersionResponse_creationDate :: Lens' TemplateVersionResponse Text Source #
The date, in ISO 8601 format, when the version of the message template was created.
templateVersionResponse_templateName :: Lens' TemplateVersionResponse Text Source #
The name of the message template.
templateVersionResponse_templateType :: Lens' TemplateVersionResponse Text Source #
The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.
TemplateVersionsResponse
data TemplateVersionsResponse Source #
Provides information about all the versions of a specific message template.
See: newTemplateVersionsResponse smart constructor.
Constructors
| TemplateVersionsResponse' | |
Fields
| |
Instances
newTemplateVersionsResponse :: TemplateVersionsResponse Source #
Create a value of TemplateVersionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:TemplateVersionsResponse', templateVersionsResponse_message - The message that's returned from the API for the request to retrieve
information about all the versions of the message template.
$sel:nextToken:TemplateVersionsResponse', templateVersionsResponse_nextToken - The string to use in a subsequent request to get the next page of
results in a paginated response. This value is null if there are no
additional pages.
$sel:requestID:TemplateVersionsResponse', templateVersionsResponse_requestID - The unique identifier for the request to retrieve information about all
the versions of the message template.
$sel:item:TemplateVersionsResponse', templateVersionsResponse_item - An array of responses, one for each version of the message template.
templateVersionsResponse_message :: Lens' TemplateVersionsResponse (Maybe Text) Source #
The message that's returned from the API for the request to retrieve information about all the versions of the message template.
templateVersionsResponse_nextToken :: Lens' TemplateVersionsResponse (Maybe Text) Source #
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
templateVersionsResponse_requestID :: Lens' TemplateVersionsResponse (Maybe Text) Source #
The unique identifier for the request to retrieve information about all the versions of the message template.
templateVersionsResponse_item :: Lens' TemplateVersionsResponse [TemplateVersionResponse] Source #
An array of responses, one for each version of the message template.
TemplatesResponse
data TemplatesResponse Source #
Provides information about all the message templates that are associated with your Amazon Pinpoint account.
See: newTemplatesResponse smart constructor.
Constructors
| TemplatesResponse' | |
Fields
| |
Instances
newTemplatesResponse :: TemplatesResponse Source #
Create a value of TemplatesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:TemplatesResponse', templatesResponse_nextToken - The string to use in a subsequent request to get the next page of
results in a paginated response. This value is null if there are no
additional pages.
$sel:item:TemplatesResponse', templatesResponse_item - An array of responses, one for each message template that's associated
with your Amazon Pinpoint account and meets any filter criteria that you
specified in the request.
templatesResponse_nextToken :: Lens' TemplatesResponse (Maybe Text) Source #
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
templatesResponse_item :: Lens' TemplatesResponse [TemplateResponse] Source #
An array of responses, one for each message template that's associated with your Amazon Pinpoint account and meets any filter criteria that you specified in the request.
TreatmentResource
data TreatmentResource Source #
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
See: newTreatmentResource smart constructor.
Constructors
| TreatmentResource' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Int | |
| -> TreatmentResource |
Create a value of TreatmentResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customDeliveryConfiguration:TreatmentResource', treatmentResource_customDeliveryConfiguration - The delivery configuration settings for sending the treatment through a
custom channel. This object is required if the MessageConfiguration
object for the treatment specifies a CustomMessage object.
$sel:messageConfiguration:TreatmentResource', treatmentResource_messageConfiguration - The message configuration settings for the treatment.
$sel:schedule:TreatmentResource', treatmentResource_schedule - The schedule settings for the treatment.
$sel:state:TreatmentResource', treatmentResource_state - The current status of the treatment.
$sel:templateConfiguration:TreatmentResource', treatmentResource_templateConfiguration - The message template to use for the treatment.
$sel:treatmentDescription:TreatmentResource', treatmentResource_treatmentDescription - The custom description of the treatment.
$sel:treatmentName:TreatmentResource', treatmentResource_treatmentName - The custom name of the treatment.
$sel:id:TreatmentResource', treatmentResource_id - The unique identifier for the treatment.
$sel:sizePercent:TreatmentResource', treatmentResource_sizePercent - The allocated percentage of users (segment members) that the treatment
is sent to.
treatmentResource_customDeliveryConfiguration :: Lens' TreatmentResource (Maybe CustomDeliveryConfiguration) Source #
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
treatmentResource_messageConfiguration :: Lens' TreatmentResource (Maybe MessageConfiguration) Source #
The message configuration settings for the treatment.
treatmentResource_schedule :: Lens' TreatmentResource (Maybe Schedule) Source #
The schedule settings for the treatment.
treatmentResource_state :: Lens' TreatmentResource (Maybe CampaignState) Source #
The current status of the treatment.
treatmentResource_templateConfiguration :: Lens' TreatmentResource (Maybe TemplateConfiguration) Source #
The message template to use for the treatment.
treatmentResource_treatmentDescription :: Lens' TreatmentResource (Maybe Text) Source #
The custom description of the treatment.
treatmentResource_treatmentName :: Lens' TreatmentResource (Maybe Text) Source #
The custom name of the treatment.
treatmentResource_id :: Lens' TreatmentResource Text Source #
The unique identifier for the treatment.
treatmentResource_sizePercent :: Lens' TreatmentResource Int Source #
The allocated percentage of users (segment members) that the treatment is sent to.
UpdateAttributesRequest
data UpdateAttributesRequest Source #
Specifies one or more attributes to remove from all the endpoints that are associated with an application.
See: newUpdateAttributesRequest smart constructor.
Constructors
| UpdateAttributesRequest' | |
Fields
| |
Instances
newUpdateAttributesRequest :: UpdateAttributesRequest Source #
Create a value of UpdateAttributesRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blacklist:UpdateAttributesRequest', updateAttributesRequest_blacklist - An array of the attributes to remove from all the endpoints that are
associated with the application. The array can specify the complete,
exact name of each attribute to remove or it can specify a glob pattern
that an attribute name must match in order for the attribute to be
removed.
updateAttributesRequest_blacklist :: Lens' UpdateAttributesRequest (Maybe [Text]) Source #
An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.
UpdateRecommenderConfiguration
data UpdateRecommenderConfiguration Source #
Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
See: newUpdateRecommenderConfiguration smart constructor.
Constructors
| UpdateRecommenderConfiguration' | |
Fields
| |
Instances
newUpdateRecommenderConfiguration Source #
Arguments
| :: Text |
|
| -> Text |
|
| -> UpdateRecommenderConfiguration |
Create a value of UpdateRecommenderConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:UpdateRecommenderConfiguration', updateRecommenderConfiguration_attributes - A map of key-value pairs that defines 1-10 custom endpoint or user
attributes, depending on the value for the RecommendationProviderIdType
property. Each of these attributes temporarily stores a recommended item
that's retrieved from the recommender model and sent to an AWS Lambda
function for additional processing. Each attribute can be used as a
message variable in a message template.
In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:
- An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
- An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.
$sel:description:UpdateRecommenderConfiguration', updateRecommenderConfiguration_description - A custom description of the configuration for the recommender model. The
description can contain up to 128 characters. The characters can be
letters, numbers, spaces, or the following symbols: _ ; () , ‐.
$sel:name:UpdateRecommenderConfiguration', updateRecommenderConfiguration_name - A custom name of the configuration for the recommender model. The name
must start with a letter or number and it can contain up to 128
characters. The characters can be letters, numbers, spaces, underscores
(_), or hyphens (-).
$sel:recommendationProviderIdType:UpdateRecommenderConfiguration', updateRecommenderConfiguration_recommendationProviderIdType - The type of Amazon Pinpoint ID to associate with unique user IDs in the
recommender model. This value enables the model to use attribute and
event data that’s specific to a particular endpoint or user in an Amazon
Pinpoint application. Valid values are:
- PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
- PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
$sel:recommendationTransformerUri:UpdateRecommenderConfiguration', updateRecommenderConfiguration_recommendationTransformerUri - The name or Amazon Resource Name (ARN) of the AWS Lambda function to
invoke for additional processing of recommendation data that's
retrieved from the recommender model.
$sel:recommendationsDisplayName:UpdateRecommenderConfiguration', updateRecommenderConfiguration_recommendationsDisplayName - A custom display name for the standard endpoint or user attribute
(RecommendationItems) that temporarily stores recommended items for each
endpoint or user, depending on the value for the
RecommendationProviderIdType property. This value is required if the
configuration doesn't invoke an AWS Lambda function
(RecommendationTransformerUri) to perform additional processing of
recommendation data.
This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.
$sel:recommendationsPerMessage:UpdateRecommenderConfiguration', updateRecommenderConfiguration_recommendationsPerMessage - The number of recommended items to retrieve from the model for each
endpoint or user, depending on the value for the
RecommendationProviderIdType property. This number determines how many
recommended items are available for use in message variables. The
minimum value is 1. The maximum value is 5. The default value is 5.
To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
$sel:recommendationProviderUri:UpdateRecommenderConfiguration', updateRecommenderConfiguration_recommendationProviderUri - The Amazon Resource Name (ARN) of the recommender model to retrieve
recommendation data from. This value must match the ARN of an Amazon
Personalize campaign.
$sel:recommendationProviderRoleArn:UpdateRecommenderConfiguration', updateRecommenderConfiguration_recommendationProviderRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management
(IAM) role that authorizes Amazon Pinpoint to retrieve recommendation
data from the recommender model.
updateRecommenderConfiguration_attributes :: Lens' UpdateRecommenderConfiguration (Maybe (HashMap Text Text)) Source #
A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.
In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:
- An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.
- An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.
updateRecommenderConfiguration_description :: Lens' UpdateRecommenderConfiguration (Maybe Text) Source #
A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.
updateRecommenderConfiguration_name :: Lens' UpdateRecommenderConfiguration (Maybe Text) Source #
A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
updateRecommenderConfiguration_recommendationProviderIdType :: Lens' UpdateRecommenderConfiguration (Maybe Text) Source #
The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:
- PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.
- PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
updateRecommenderConfiguration_recommendationTransformerUri :: Lens' UpdateRecommenderConfiguration (Maybe Text) Source #
The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.
updateRecommenderConfiguration_recommendationsDisplayName :: Lens' UpdateRecommenderConfiguration (Maybe Text) Source #
A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.
updateRecommenderConfiguration_recommendationsPerMessage :: Lens' UpdateRecommenderConfiguration (Maybe Int) Source #
The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.
To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
updateRecommenderConfiguration_recommendationProviderUri :: Lens' UpdateRecommenderConfiguration Text Source #
The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.
updateRecommenderConfiguration_recommendationProviderRoleArn :: Lens' UpdateRecommenderConfiguration Text Source #
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
VerificationResponse
data VerificationResponse Source #
Verify OTP Message Response.
See: newVerificationResponse smart constructor.
Constructors
| VerificationResponse' | |
Instances
newVerificationResponse :: VerificationResponse Source #
Create a value of VerificationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:valid:VerificationResponse', verificationResponse_valid - Specifies whether the OTP is valid or not.
verificationResponse_valid :: Lens' VerificationResponse (Maybe Bool) Source #
Specifies whether the OTP is valid or not.
VerifyOTPMessageRequestParameters
data VerifyOTPMessageRequestParameters Source #
Verify OTP message request.
See: newVerifyOTPMessageRequestParameters smart constructor.
Constructors
| VerifyOTPMessageRequestParameters' | |
Fields
| |
Instances
newVerifyOTPMessageRequestParameters Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> VerifyOTPMessageRequestParameters |
Create a value of VerifyOTPMessageRequestParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:referenceId:VerifyOTPMessageRequestParameters', verifyOTPMessageRequestParameters_referenceId - The reference identifier provided when the OTP was previously sent.
$sel:otp:VerifyOTPMessageRequestParameters', verifyOTPMessageRequestParameters_otp - The OTP the end user provided for verification.
$sel:destinationIdentity:VerifyOTPMessageRequestParameters', verifyOTPMessageRequestParameters_destinationIdentity - The destination identity to send OTP to.
verifyOTPMessageRequestParameters_referenceId :: Lens' VerifyOTPMessageRequestParameters Text Source #
The reference identifier provided when the OTP was previously sent.
verifyOTPMessageRequestParameters_otp :: Lens' VerifyOTPMessageRequestParameters Text Source #
The OTP the end user provided for verification.
verifyOTPMessageRequestParameters_destinationIdentity :: Lens' VerifyOTPMessageRequestParameters Text Source #
The destination identity to send OTP to.
VoiceChannelRequest
data VoiceChannelRequest Source #
Specifies the status and settings of the voice channel for an application.
See: newVoiceChannelRequest smart constructor.
Constructors
| VoiceChannelRequest' | |
Instances
newVoiceChannelRequest :: VoiceChannelRequest Source #
Create a value of VoiceChannelRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:VoiceChannelRequest', voiceChannelRequest_enabled - Specifies whether to enable the voice channel for the application.
voiceChannelRequest_enabled :: Lens' VoiceChannelRequest (Maybe Bool) Source #
Specifies whether to enable the voice channel for the application.
VoiceChannelResponse
data VoiceChannelResponse Source #
Provides information about the status and settings of the voice channel for an application.
See: newVoiceChannelResponse smart constructor.
Constructors
| VoiceChannelResponse' | |
Fields
| |
Instances
newVoiceChannelResponse Source #
Arguments
| :: Text | |
| -> VoiceChannelResponse |
Create a value of VoiceChannelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:VoiceChannelResponse', voiceChannelResponse_applicationId - The unique identifier for the application that the voice channel applies
to.
$sel:creationDate:VoiceChannelResponse', voiceChannelResponse_creationDate - The date and time, in ISO 8601 format, when the voice channel was
enabled.
$sel:enabled:VoiceChannelResponse', voiceChannelResponse_enabled - Specifies whether the voice channel is enabled for the application.
$sel:hasCredential:VoiceChannelResponse', voiceChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.
$sel:id:VoiceChannelResponse', voiceChannelResponse_id - (Deprecated) An identifier for the voice channel. This property is
retained only for backward compatibility.
$sel:isArchived:VoiceChannelResponse', voiceChannelResponse_isArchived - Specifies whether the voice channel is archived.
$sel:lastModifiedBy:VoiceChannelResponse', voiceChannelResponse_lastModifiedBy - The user who last modified the voice channel.
$sel:lastModifiedDate:VoiceChannelResponse', voiceChannelResponse_lastModifiedDate - The date and time, in ISO 8601 format, when the voice channel was last
modified.
$sel:version:VoiceChannelResponse', voiceChannelResponse_version - The current version of the voice channel.
$sel:platform:VoiceChannelResponse', voiceChannelResponse_platform - The type of messaging or notification platform for the channel. For the
voice channel, this value is VOICE.
voiceChannelResponse_applicationId :: Lens' VoiceChannelResponse (Maybe Text) Source #
The unique identifier for the application that the voice channel applies to.
voiceChannelResponse_creationDate :: Lens' VoiceChannelResponse (Maybe Text) Source #
The date and time, in ISO 8601 format, when the voice channel was enabled.
voiceChannelResponse_enabled :: Lens' VoiceChannelResponse (Maybe Bool) Source #
Specifies whether the voice channel is enabled for the application.
voiceChannelResponse_hasCredential :: Lens' VoiceChannelResponse (Maybe Bool) Source #
(Not used) This property is retained only for backward compatibility.
voiceChannelResponse_id :: Lens' VoiceChannelResponse (Maybe Text) Source #
(Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
voiceChannelResponse_isArchived :: Lens' VoiceChannelResponse (Maybe Bool) Source #
Specifies whether the voice channel is archived.
voiceChannelResponse_lastModifiedBy :: Lens' VoiceChannelResponse (Maybe Text) Source #
The user who last modified the voice channel.
voiceChannelResponse_lastModifiedDate :: Lens' VoiceChannelResponse (Maybe Text) Source #
The date and time, in ISO 8601 format, when the voice channel was last modified.
voiceChannelResponse_version :: Lens' VoiceChannelResponse (Maybe Int) Source #
The current version of the voice channel.
voiceChannelResponse_platform :: Lens' VoiceChannelResponse Text Source #
The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.
VoiceMessage
data VoiceMessage Source #
Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.
See: newVoiceMessage smart constructor.
Constructors
| VoiceMessage' | |
Fields
| |
Instances
newVoiceMessage :: VoiceMessage Source #
Create a value of VoiceMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:body:VoiceMessage', voiceMessage_body - The text of the script to use for the voice message.
$sel:languageCode:VoiceMessage', voiceMessage_languageCode - The code for the language to use when synthesizing the text of the
message script. For a list of supported languages and the code for each
one, see the
Amazon Polly Developer Guide.
$sel:originationNumber:VoiceMessage', voiceMessage_originationNumber - The long code to send the voice message from. This value should be one
of the dedicated long codes that's assigned to your AWS account.
Although it isn't required, we recommend that you specify the long code
in E.164 format, for example +12065550100, to ensure prompt and accurate
delivery of the message.
$sel:substitutions:VoiceMessage', voiceMessage_substitutions - The default message variables to use in the voice message. You can
override the default variables with individual address variables.
$sel:voiceId:VoiceMessage', voiceMessage_voiceId - The name of the voice to use when delivering the message. For a list of
supported voices, see the
Amazon Polly Developer Guide.
voiceMessage_body :: Lens' VoiceMessage (Maybe Text) Source #
The text of the script to use for the voice message.
voiceMessage_languageCode :: Lens' VoiceMessage (Maybe Text) Source #
The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
voiceMessage_originationNumber :: Lens' VoiceMessage (Maybe Text) Source #
The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.
voiceMessage_substitutions :: Lens' VoiceMessage (Maybe (HashMap Text [Text])) Source #
The default message variables to use in the voice message. You can override the default variables with individual address variables.
voiceMessage_voiceId :: Lens' VoiceMessage (Maybe Text) Source #
The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
VoiceTemplateRequest
data VoiceTemplateRequest Source #
Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.
See: newVoiceTemplateRequest smart constructor.
Constructors
| VoiceTemplateRequest' | |
Fields
| |
Instances
newVoiceTemplateRequest :: VoiceTemplateRequest Source #
Create a value of VoiceTemplateRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:body:VoiceTemplateRequest', voiceTemplateRequest_body - The text of the script to use in messages that are based on the message
template, in plain text format.
$sel:defaultSubstitutions:VoiceTemplateRequest', voiceTemplateRequest_defaultSubstitutions - A JSON object that specifies the default values to use for message
variables in the message template. This object is a set of key-value
pairs. Each key defines a message variable in the template. The
corresponding value defines the default value for that variable. When
you create a message that's based on the template, you can override
these defaults with message-specific and address-specific variables and
values.
$sel:languageCode:VoiceTemplateRequest', voiceTemplateRequest_languageCode - The code for the language to use when synthesizing the text of the
script in messages that are based on the message template. For a list of
supported languages and the code for each one, see the
Amazon Polly Developer Guide.
$sel:templateDescription:VoiceTemplateRequest', voiceTemplateRequest_templateDescription - A custom description of the message template.
$sel:voiceId:VoiceTemplateRequest', voiceTemplateRequest_voiceId - The name of the voice to use when delivering messages that are based on
the message template. For a list of supported voices, see the
Amazon Polly Developer Guide.
$sel:tags:VoiceTemplateRequest', voiceTemplateRequest_tags - A string-to-string map of key-value pairs that defines the tags to
associate with the message template. Each tag consists of a required tag
key and an associated tag value.
voiceTemplateRequest_body :: Lens' VoiceTemplateRequest (Maybe Text) Source #
The text of the script to use in messages that are based on the message template, in plain text format.
voiceTemplateRequest_defaultSubstitutions :: Lens' VoiceTemplateRequest (Maybe Text) Source #
A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
voiceTemplateRequest_languageCode :: Lens' VoiceTemplateRequest (Maybe Text) Source #
The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
voiceTemplateRequest_templateDescription :: Lens' VoiceTemplateRequest (Maybe Text) Source #
A custom description of the message template.
voiceTemplateRequest_voiceId :: Lens' VoiceTemplateRequest (Maybe Text) Source #
The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.
voiceTemplateRequest_tags :: Lens' VoiceTemplateRequest (Maybe (HashMap Text Text)) Source #
A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
VoiceTemplateResponse
data VoiceTemplateResponse Source #
Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.
See: newVoiceTemplateResponse smart constructor.
Constructors
| VoiceTemplateResponse' | |
Fields
| |
Instances
newVoiceTemplateResponse Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> TemplateType | |
| -> VoiceTemplateResponse |
Create a value of VoiceTemplateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:VoiceTemplateResponse', voiceTemplateResponse_arn - The Amazon Resource Name (ARN) of the message template.
$sel:body:VoiceTemplateResponse', voiceTemplateResponse_body - The text of the script that's used in messages that are based on the
message template, in plain text format.
$sel:defaultSubstitutions:VoiceTemplateResponse', voiceTemplateResponse_defaultSubstitutions - The JSON object that specifies the default values that are used for
message variables in the message template. This object is a set of
key-value pairs. Each key defines a message variable in the template.
The corresponding value defines the default value for that variable.
$sel:languageCode:VoiceTemplateResponse', voiceTemplateResponse_languageCode - The code for the language that's used when synthesizing the text of the
script in messages that are based on the message template. For a list of
supported languages and the code for each one, see the
Amazon Polly Developer Guide.
$sel:templateDescription:VoiceTemplateResponse', voiceTemplateResponse_templateDescription - The custom description of the message template.
$sel:version:VoiceTemplateResponse', voiceTemplateResponse_version - The unique identifier, as an integer, for the active version of the
message template, or the version of the template that you specified by
using the version parameter in your request.
$sel:voiceId:VoiceTemplateResponse', voiceTemplateResponse_voiceId - The name of the voice that's used when delivering messages that are
based on the message template. For a list of supported voices, see the
Amazon Polly Developer Guide.
$sel:tags:VoiceTemplateResponse', voiceTemplateResponse_tags - A string-to-string map of key-value pairs that identifies the tags that
are associated with the message template. Each tag consists of a
required tag key and an associated tag value.
$sel:lastModifiedDate:VoiceTemplateResponse', voiceTemplateResponse_lastModifiedDate - The date, in ISO 8601 format, when the message template was last
modified.
$sel:creationDate:VoiceTemplateResponse', voiceTemplateResponse_creationDate - The date, in ISO 8601 format, when the message template was created.
$sel:templateName:VoiceTemplateResponse', voiceTemplateResponse_templateName - The name of the message template.
$sel:templateType:VoiceTemplateResponse', voiceTemplateResponse_templateType - The type of channel that the message template is designed for. For a
voice template, this value is VOICE.
voiceTemplateResponse_arn :: Lens' VoiceTemplateResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the message template.
voiceTemplateResponse_body :: Lens' VoiceTemplateResponse (Maybe Text) Source #
The text of the script that's used in messages that are based on the message template, in plain text format.
voiceTemplateResponse_defaultSubstitutions :: Lens' VoiceTemplateResponse (Maybe Text) Source #
The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
voiceTemplateResponse_languageCode :: Lens' VoiceTemplateResponse (Maybe Text) Source #
The code for the language that's used when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
voiceTemplateResponse_templateDescription :: Lens' VoiceTemplateResponse (Maybe Text) Source #
The custom description of the message template.
voiceTemplateResponse_version :: Lens' VoiceTemplateResponse (Maybe Text) Source #
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
voiceTemplateResponse_voiceId :: Lens' VoiceTemplateResponse (Maybe Text) Source #
The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.
voiceTemplateResponse_tags :: Lens' VoiceTemplateResponse (Maybe (HashMap Text Text)) Source #
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
voiceTemplateResponse_lastModifiedDate :: Lens' VoiceTemplateResponse Text Source #
The date, in ISO 8601 format, when the message template was last modified.
voiceTemplateResponse_creationDate :: Lens' VoiceTemplateResponse Text Source #
The date, in ISO 8601 format, when the message template was created.
voiceTemplateResponse_templateName :: Lens' VoiceTemplateResponse Text Source #
The name of the message template.
voiceTemplateResponse_templateType :: Lens' VoiceTemplateResponse TemplateType Source #
The type of channel that the message template is designed for. For a voice template, this value is VOICE.
WaitActivity
data WaitActivity Source #
Specifies the settings for a wait activity in a journey. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
See: newWaitActivity smart constructor.
Constructors
| WaitActivity' | |
Instances
newWaitActivity :: WaitActivity Source #
Create a value of WaitActivity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextActivity:WaitActivity', waitActivity_nextActivity - The unique identifier for the next activity to perform, after performing
the wait activity.
$sel:waitTime:WaitActivity', waitActivity_waitTime - The amount of time to wait or the date and time when the activity moves
participants to the next activity in the journey.
waitActivity_nextActivity :: Lens' WaitActivity (Maybe Text) Source #
The unique identifier for the next activity to perform, after performing the wait activity.
waitActivity_waitTime :: Lens' WaitActivity (Maybe WaitTime) Source #
The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
WaitTime
Specifies a duration or a date and time that indicates when Amazon Pinpoint determines whether an activity's conditions have been met or an activity moves participants to the next activity in a journey.
See: newWaitTime smart constructor.
Constructors
| WaitTime' | |
Fields
| |
Instances
| FromJSON WaitTime Source # | |
| ToJSON WaitTime Source # | |
Defined in Amazonka.Pinpoint.Types.WaitTime | |
| Generic WaitTime Source # | |
| Read WaitTime Source # | |
| Show WaitTime Source # | |
| NFData WaitTime Source # | |
Defined in Amazonka.Pinpoint.Types.WaitTime | |
| Eq WaitTime Source # | |
| Hashable WaitTime Source # | |
Defined in Amazonka.Pinpoint.Types.WaitTime | |
| type Rep WaitTime Source # | |
Defined in Amazonka.Pinpoint.Types.WaitTime type Rep WaitTime = D1 ('MetaData "WaitTime" "Amazonka.Pinpoint.Types.WaitTime" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "WaitTime'" 'PrefixI 'True) (S1 ('MetaSel ('Just "waitFor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "waitUntil") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newWaitTime :: WaitTime Source #
Create a value of WaitTime with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:waitFor:WaitTime', waitTime_waitFor - The amount of time to wait, as a duration in ISO 8601 format, before
determining whether the activity's conditions have been met or moving
participants to the next activity in the journey.
$sel:waitUntil:WaitTime', waitTime_waitUntil - The date and time, in ISO 8601 format, when Amazon Pinpoint determines
whether the activity's conditions have been met or the activity moves
participants to the next activity in the journey.
waitTime_waitFor :: Lens' WaitTime (Maybe Text) Source #
The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
waitTime_waitUntil :: Lens' WaitTime (Maybe Text) Source #
The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
WriteApplicationSettingsRequest
data WriteApplicationSettingsRequest Source #
Specifies the default settings for an application.
See: newWriteApplicationSettingsRequest smart constructor.
Constructors
| WriteApplicationSettingsRequest' | |
Fields
| |
Instances
newWriteApplicationSettingsRequest :: WriteApplicationSettingsRequest Source #
Create a value of WriteApplicationSettingsRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:campaignHook:WriteApplicationSettingsRequest', writeApplicationSettingsRequest_campaignHook - The settings for the AWS Lambda function to invoke by default as a code
hook for campaigns in the application. You can use this hook to
customize segments that are used by campaigns in the application.
To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.
$sel:cloudWatchMetricsEnabled:WriteApplicationSettingsRequest', writeApplicationSettingsRequest_cloudWatchMetricsEnabled - Specifies whether to enable application-related alarms in Amazon
CloudWatch.
$sel:eventTaggingEnabled:WriteApplicationSettingsRequest', writeApplicationSettingsRequest_eventTaggingEnabled - Undocumented member.
$sel:limits:WriteApplicationSettingsRequest', writeApplicationSettingsRequest_limits - The default sending limits for campaigns in the application. To override
these limits and define custom limits for a specific campaign or
journey, use the Campaign resource or the Journey resource,
respectively.
$sel:quietTime:WriteApplicationSettingsRequest', writeApplicationSettingsRequest_quietTime - The default quiet time for campaigns in the application. Quiet time is a
specific time range when messages aren't sent to endpoints, if all the
following conditions are met:
- The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
- The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
- The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.
writeApplicationSettingsRequest_campaignHook :: Lens' WriteApplicationSettingsRequest (Maybe CampaignHook) Source #
The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.
writeApplicationSettingsRequest_cloudWatchMetricsEnabled :: Lens' WriteApplicationSettingsRequest (Maybe Bool) Source #
Specifies whether to enable application-related alarms in Amazon CloudWatch.
writeApplicationSettingsRequest_eventTaggingEnabled :: Lens' WriteApplicationSettingsRequest (Maybe Bool) Source #
Undocumented member.
writeApplicationSettingsRequest_limits :: Lens' WriteApplicationSettingsRequest (Maybe CampaignLimits) Source #
The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.
writeApplicationSettingsRequest_quietTime :: Lens' WriteApplicationSettingsRequest (Maybe QuietTime) Source #
The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:
- The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
- The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).
- The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.
WriteCampaignRequest
data WriteCampaignRequest Source #
Specifies the configuration and other settings for a campaign.
See: newWriteCampaignRequest smart constructor.
Constructors
| WriteCampaignRequest' | |
Fields
| |
Instances
newWriteCampaignRequest :: WriteCampaignRequest Source #
Create a value of WriteCampaignRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:additionalTreatments:WriteCampaignRequest', writeCampaignRequest_additionalTreatments - An array of requests that defines additional treatments for the
campaign, in addition to the default treatment for the campaign.
WriteCampaignRequest, writeCampaignRequest_customDeliveryConfiguration - The delivery configuration settings for sending the campaign through a
custom channel. This object is required if the MessageConfiguration
object for the campaign specifies a CustomMessage object.
$sel:description:WriteCampaignRequest', writeCampaignRequest_description - A custom description of the campaign.
$sel:holdoutPercent:WriteCampaignRequest', writeCampaignRequest_holdoutPercent - The allocated percentage of users (segment members) who shouldn't
receive messages from the campaign.
$sel:hook:WriteCampaignRequest', writeCampaignRequest_hook - The settings for the AWS Lambda function to invoke as a code hook for
the campaign. You can use this hook to customize the segment that's
used by the campaign.
$sel:isPaused:WriteCampaignRequest', writeCampaignRequest_isPaused - Specifies whether to pause the campaign. A paused campaign doesn't run
unless you resume it by changing this value to false.
$sel:limits:WriteCampaignRequest', writeCampaignRequest_limits - The messaging limits for the campaign.
WriteCampaignRequest, writeCampaignRequest_messageConfiguration - The message configuration settings for the campaign.
$sel:name:WriteCampaignRequest', writeCampaignRequest_name - A custom name for the campaign.
$sel:priority:WriteCampaignRequest', writeCampaignRequest_priority - Defines the priority of the campaign, used to decide the order of
messages displayed to user if there are multiple messages scheduled to
be displayed at the same moment.
WriteCampaignRequest, writeCampaignRequest_schedule - The schedule settings for the campaign.
$sel:segmentId:WriteCampaignRequest', writeCampaignRequest_segmentId - The unique identifier for the segment to associate with the campaign.
$sel:segmentVersion:WriteCampaignRequest', writeCampaignRequest_segmentVersion - The version of the segment to associate with the campaign.
WriteCampaignRequest, writeCampaignRequest_templateConfiguration - The message template to use for the campaign.
WriteCampaignRequest, writeCampaignRequest_treatmentDescription - A custom description of the default treatment for the campaign.
WriteCampaignRequest, writeCampaignRequest_treatmentName - A custom name of the default treatment for the campaign, if the campaign
has multiple treatments. A treatment is a variation of a campaign
that's used for A/B testing.
$sel:tags:WriteCampaignRequest', writeCampaignRequest_tags - A string-to-string map of key-value pairs that defines the tags to
associate with the campaign. Each tag consists of a required tag key and
an associated tag value.
writeCampaignRequest_additionalTreatments :: Lens' WriteCampaignRequest (Maybe [WriteTreatmentResource]) Source #
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
writeCampaignRequest_customDeliveryConfiguration :: Lens' WriteCampaignRequest (Maybe CustomDeliveryConfiguration) Source #
The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.
writeCampaignRequest_description :: Lens' WriteCampaignRequest (Maybe Text) Source #
A custom description of the campaign.
writeCampaignRequest_holdoutPercent :: Lens' WriteCampaignRequest (Maybe Int) Source #
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
writeCampaignRequest_hook :: Lens' WriteCampaignRequest (Maybe CampaignHook) Source #
The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
writeCampaignRequest_isPaused :: Lens' WriteCampaignRequest (Maybe Bool) Source #
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
writeCampaignRequest_limits :: Lens' WriteCampaignRequest (Maybe CampaignLimits) Source #
The messaging limits for the campaign.
writeCampaignRequest_messageConfiguration :: Lens' WriteCampaignRequest (Maybe MessageConfiguration) Source #
The message configuration settings for the campaign.
writeCampaignRequest_name :: Lens' WriteCampaignRequest (Maybe Text) Source #
A custom name for the campaign.
writeCampaignRequest_priority :: Lens' WriteCampaignRequest (Maybe Int) Source #
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
writeCampaignRequest_schedule :: Lens' WriteCampaignRequest (Maybe Schedule) Source #
The schedule settings for the campaign.
writeCampaignRequest_segmentId :: Lens' WriteCampaignRequest (Maybe Text) Source #
The unique identifier for the segment to associate with the campaign.
writeCampaignRequest_segmentVersion :: Lens' WriteCampaignRequest (Maybe Int) Source #
The version of the segment to associate with the campaign.
writeCampaignRequest_templateConfiguration :: Lens' WriteCampaignRequest (Maybe TemplateConfiguration) Source #
The message template to use for the campaign.
writeCampaignRequest_treatmentDescription :: Lens' WriteCampaignRequest (Maybe Text) Source #
A custom description of the default treatment for the campaign.
writeCampaignRequest_treatmentName :: Lens' WriteCampaignRequest (Maybe Text) Source #
A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
writeCampaignRequest_tags :: Lens' WriteCampaignRequest (Maybe (HashMap Text Text)) Source #
A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.
WriteEventStream
data WriteEventStream Source #
Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.
See: newWriteEventStream smart constructor.
Constructors
| WriteEventStream' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> WriteEventStream |
Create a value of WriteEventStream with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:roleArn:WriteEventStream', writeEventStream_roleArn - The AWS Identity and Access Management (IAM) role that authorizes Amazon
Pinpoint to publish event data to the stream in your AWS account.
$sel:destinationStreamArn:WriteEventStream', writeEventStream_destinationStreamArn - The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or
Amazon Kinesis Data Firehose delivery stream that you want to publish
event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
writeEventStream_roleArn :: Lens' WriteEventStream Text Source #
The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
writeEventStream_destinationStreamArn :: Lens' WriteEventStream Text Source #
The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
WriteJourneyRequest
data WriteJourneyRequest Source #
Specifies the configuration and other settings for a journey.
See: newWriteJourneyRequest smart constructor.
Constructors
| WriteJourneyRequest' | |
Fields
| |
Instances
newWriteJourneyRequest Source #
Arguments
| :: Text | |
| -> WriteJourneyRequest |
Create a value of WriteJourneyRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:activities:WriteJourneyRequest', writeJourneyRequest_activities - A map that contains a set of Activity objects, one object for each
activity in the journey. For each Activity object, the key is the unique
identifier (string) for an activity and the value is the settings for
the activity. An activity identifier can contain a maximum of 100
characters. The characters must be alphanumeric characters.
$sel:closedDays:WriteJourneyRequest', writeJourneyRequest_closedDays - The time when journey will stop sending messages. QuietTime should be
configured first and SendingSchedule should be set to true.
$sel:creationDate:WriteJourneyRequest', writeJourneyRequest_creationDate - The date, in ISO 8601 format, when the journey was created.
$sel:journeyChannelSettings:WriteJourneyRequest', writeJourneyRequest_journeyChannelSettings - The channel-specific configurations for the journey.
$sel:lastModifiedDate:WriteJourneyRequest', writeJourneyRequest_lastModifiedDate - The date, in ISO 8601 format, when the journey was last modified.
$sel:limits:WriteJourneyRequest', writeJourneyRequest_limits - The messaging and entry limits for the journey.
$sel:localTime:WriteJourneyRequest', writeJourneyRequest_localTime - Specifies whether the journey's scheduled start and end times use each
participant's local time. To base the schedule on each participant's
local time, set this value to true.
$sel:openHours:WriteJourneyRequest', writeJourneyRequest_openHours - The time when journey allow to send messages. QuietTime should be
configured first and SendingSchedule should be set to true.
$sel:quietTime:WriteJourneyRequest', writeJourneyRequest_quietTime - The quiet time settings for the journey. Quiet time is a specific time
range when a journey doesn't send messages to participants, if all the
following conditions are met:
- The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
- The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
- The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
$sel:refreshFrequency:WriteJourneyRequest', writeJourneyRequest_refreshFrequency - The frequency with which Amazon Pinpoint evaluates segment and event
data for the journey, as a duration in ISO 8601 format.
$sel:refreshOnSegmentUpdate:WriteJourneyRequest', writeJourneyRequest_refreshOnSegmentUpdate - Specifies whether a journey should be refreshed on segment update.
$sel:schedule:WriteJourneyRequest', writeJourneyRequest_schedule - The schedule settings for the journey.
$sel:sendingSchedule:WriteJourneyRequest', writeJourneyRequest_sendingSchedule - Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays).
This flag should be set to true in order to allow (OpenHours and
ClosedDays)
$sel:startActivity:WriteJourneyRequest', writeJourneyRequest_startActivity - The unique identifier for the first activity in the journey. The
identifier for this activity can contain a maximum of 128 characters.
The characters must be alphanumeric characters.
$sel:startCondition:WriteJourneyRequest', writeJourneyRequest_startCondition - The segment that defines which users are participants in the journey.
$sel:state:WriteJourneyRequest', writeJourneyRequest_state - The status of the journey. Valid values are:
- DRAFT - Saves the journey and doesn't publish it.
- ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the Journey State resource.
$sel:waitForQuietTime:WriteJourneyRequest', writeJourneyRequest_waitForQuietTime - Specifies whether endpoints in quiet hours should enter a wait till the
end of their quiet hours.
$sel:name:WriteJourneyRequest', writeJourneyRequest_name - The name of the journey. A journey name can contain a maximum of 150
characters. The characters can be alphanumeric characters or symbols,
such as underscores (_) or hyphens (-). A journey name can't contain
any spaces.
writeJourneyRequest_activities :: Lens' WriteJourneyRequest (Maybe (HashMap Text Activity)) Source #
A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.
writeJourneyRequest_closedDays :: Lens' WriteJourneyRequest (Maybe ClosedDays) Source #
The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.
writeJourneyRequest_creationDate :: Lens' WriteJourneyRequest (Maybe Text) Source #
The date, in ISO 8601 format, when the journey was created.
writeJourneyRequest_journeyChannelSettings :: Lens' WriteJourneyRequest (Maybe JourneyChannelSettings) Source #
The channel-specific configurations for the journey.
writeJourneyRequest_lastModifiedDate :: Lens' WriteJourneyRequest (Maybe Text) Source #
The date, in ISO 8601 format, when the journey was last modified.
writeJourneyRequest_limits :: Lens' WriteJourneyRequest (Maybe JourneyLimits) Source #
The messaging and entry limits for the journey.
writeJourneyRequest_localTime :: Lens' WriteJourneyRequest (Maybe Bool) Source #
Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.
writeJourneyRequest_openHours :: Lens' WriteJourneyRequest (Maybe OpenHours) Source #
The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.
writeJourneyRequest_quietTime :: Lens' WriteJourneyRequest (Maybe QuietTime) Source #
The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:
- The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.
- The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.
- The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.
If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
writeJourneyRequest_refreshFrequency :: Lens' WriteJourneyRequest (Maybe Text) Source #
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
writeJourneyRequest_refreshOnSegmentUpdate :: Lens' WriteJourneyRequest (Maybe Bool) Source #
Specifies whether a journey should be refreshed on segment update.
writeJourneyRequest_schedule :: Lens' WriteJourneyRequest (Maybe JourneySchedule) Source #
The schedule settings for the journey.
writeJourneyRequest_sendingSchedule :: Lens' WriteJourneyRequest (Maybe Bool) Source #
Indicates if journey have Advance Quiet Time (OpenHours and ClosedDays). This flag should be set to true in order to allow (OpenHours and ClosedDays)
writeJourneyRequest_startActivity :: Lens' WriteJourneyRequest (Maybe Text) Source #
The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.
writeJourneyRequest_startCondition :: Lens' WriteJourneyRequest (Maybe StartCondition) Source #
The segment that defines which users are participants in the journey.
writeJourneyRequest_state :: Lens' WriteJourneyRequest (Maybe State) Source #
The status of the journey. Valid values are:
- DRAFT - Saves the journey and doesn't publish it.
- ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.
PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the Journey State resource.
writeJourneyRequest_waitForQuietTime :: Lens' WriteJourneyRequest (Maybe Bool) Source #
Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
writeJourneyRequest_name :: Lens' WriteJourneyRequest Text Source #
The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.
WriteSegmentRequest
data WriteSegmentRequest Source #
Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.
See: newWriteSegmentRequest smart constructor.
Constructors
| WriteSegmentRequest' | |
Fields
| |
Instances
newWriteSegmentRequest :: WriteSegmentRequest Source #
Create a value of WriteSegmentRequest with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensions:WriteSegmentRequest', writeSegmentRequest_dimensions - The criteria that define the dimensions for the segment.
$sel:name:WriteSegmentRequest', writeSegmentRequest_name - The name of the segment.
$sel:segmentGroups:WriteSegmentRequest', writeSegmentRequest_segmentGroups - The segment group to use and the dimensions to apply to the group's
base segments in order to build the segment. A segment group can consist
of zero or more base segments. Your request can include only one segment
group.
$sel:tags:WriteSegmentRequest', writeSegmentRequest_tags - A string-to-string map of key-value pairs that defines the tags to
associate with the segment. Each tag consists of a required tag key and
an associated tag value.
writeSegmentRequest_dimensions :: Lens' WriteSegmentRequest (Maybe SegmentDimensions) Source #
The criteria that define the dimensions for the segment.
writeSegmentRequest_name :: Lens' WriteSegmentRequest (Maybe Text) Source #
The name of the segment.
writeSegmentRequest_segmentGroups :: Lens' WriteSegmentRequest (Maybe SegmentGroupList) Source #
The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.
writeSegmentRequest_tags :: Lens' WriteSegmentRequest (Maybe (HashMap Text Text)) Source #
A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.
WriteTreatmentResource
data WriteTreatmentResource Source #
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
See: newWriteTreatmentResource smart constructor.
Constructors
| WriteTreatmentResource' | |
Fields
| |
Instances
newWriteTreatmentResource Source #
Create a value of WriteTreatmentResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customDeliveryConfiguration:WriteTreatmentResource', writeTreatmentResource_customDeliveryConfiguration - The delivery configuration settings for sending the treatment through a
custom channel. This object is required if the MessageConfiguration
object for the treatment specifies a CustomMessage object.
$sel:messageConfiguration:WriteTreatmentResource', writeTreatmentResource_messageConfiguration - The message configuration settings for the treatment.
$sel:schedule:WriteTreatmentResource', writeTreatmentResource_schedule - The schedule settings for the treatment.
$sel:templateConfiguration:WriteTreatmentResource', writeTreatmentResource_templateConfiguration - The message template to use for the treatment.
$sel:treatmentDescription:WriteTreatmentResource', writeTreatmentResource_treatmentDescription - A custom description of the treatment.
$sel:treatmentName:WriteTreatmentResource', writeTreatmentResource_treatmentName - A custom name for the treatment.
$sel:sizePercent:WriteTreatmentResource', writeTreatmentResource_sizePercent - The allocated percentage of users (segment members) to send the
treatment to.
writeTreatmentResource_customDeliveryConfiguration :: Lens' WriteTreatmentResource (Maybe CustomDeliveryConfiguration) Source #
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
writeTreatmentResource_messageConfiguration :: Lens' WriteTreatmentResource (Maybe MessageConfiguration) Source #
The message configuration settings for the treatment.
writeTreatmentResource_schedule :: Lens' WriteTreatmentResource (Maybe Schedule) Source #
The schedule settings for the treatment.
writeTreatmentResource_templateConfiguration :: Lens' WriteTreatmentResource (Maybe TemplateConfiguration) Source #
The message template to use for the treatment.
writeTreatmentResource_treatmentDescription :: Lens' WriteTreatmentResource (Maybe Text) Source #
A custom description of the treatment.
writeTreatmentResource_treatmentName :: Lens' WriteTreatmentResource (Maybe Text) Source #
A custom name for the treatment.
writeTreatmentResource_sizePercent :: Lens' WriteTreatmentResource Int Source #
The allocated percentage of users (segment members) to send the treatment to.