| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.PinpointEmail.Types
Contents
- Service Configuration
- Errors
- BehaviorOnMxFailure
- DeliverabilityDashboardAccountStatus
- DeliverabilityTestStatus
- DimensionValueSource
- DkimStatus
- EventType
- IdentityType
- MailFromDomainStatus
- TlsPolicy
- WarmupStatus
- BlacklistEntry
- Body
- CloudWatchDestination
- CloudWatchDimensionConfiguration
- Content
- DailyVolume
- DedicatedIp
- DeliverabilityTestReport
- DeliveryOptions
- Destination
- DkimAttributes
- DomainDeliverabilityCampaign
- DomainDeliverabilityTrackingOption
- DomainIspPlacement
- EmailContent
- EventDestination
- EventDestinationDefinition
- IdentityInfo
- InboxPlacementTrackingOption
- IspPlacement
- KinesisFirehoseDestination
- MailFromAttributes
- Message
- MessageTag
- OverallVolume
- PinpointDestination
- PlacementStatistics
- RawMessage
- ReputationOptions
- SendQuota
- SendingOptions
- SnsDestination
- Tag
- Template
- TrackingOptions
- VolumeStatistics
Description
Synopsis
- defaultService :: Service
- _MessageRejected :: AsError a => Getting (First ServiceError) a ServiceError
- _MailFromDomainNotVerifiedException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccountSuspendedException :: AsError a => Getting (First ServiceError) a ServiceError
- _SendingPausedException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype BehaviorOnMxFailure where
- newtype DeliverabilityDashboardAccountStatus where
- DeliverabilityDashboardAccountStatus' { }
- pattern DeliverabilityDashboardAccountStatus_ACTIVE :: DeliverabilityDashboardAccountStatus
- pattern DeliverabilityDashboardAccountStatus_DISABLED :: DeliverabilityDashboardAccountStatus
- pattern DeliverabilityDashboardAccountStatus_PENDING_EXPIRATION :: DeliverabilityDashboardAccountStatus
- newtype DeliverabilityTestStatus where
- newtype DimensionValueSource where
- newtype DkimStatus where
- DkimStatus' { }
- pattern DkimStatus_FAILED :: DkimStatus
- pattern DkimStatus_NOT_STARTED :: DkimStatus
- pattern DkimStatus_PENDING :: DkimStatus
- pattern DkimStatus_SUCCESS :: DkimStatus
- pattern DkimStatus_TEMPORARY_FAILURE :: DkimStatus
- newtype EventType where
- EventType' { }
- pattern EventType_BOUNCE :: EventType
- pattern EventType_CLICK :: EventType
- pattern EventType_COMPLAINT :: EventType
- pattern EventType_DELIVERY :: EventType
- pattern EventType_OPEN :: EventType
- pattern EventType_REJECT :: EventType
- pattern EventType_RENDERING_FAILURE :: EventType
- pattern EventType_SEND :: EventType
- newtype IdentityType where
- IdentityType' { }
- pattern IdentityType_DOMAIN :: IdentityType
- pattern IdentityType_EMAIL_ADDRESS :: IdentityType
- pattern IdentityType_MANAGED_DOMAIN :: IdentityType
- newtype MailFromDomainStatus where
- newtype TlsPolicy where
- TlsPolicy' { }
- pattern TlsPolicy_OPTIONAL :: TlsPolicy
- pattern TlsPolicy_REQUIRE :: TlsPolicy
- newtype WarmupStatus where
- WarmupStatus' { }
- pattern WarmupStatus_DONE :: WarmupStatus
- pattern WarmupStatus_IN_PROGRESS :: WarmupStatus
- data BlacklistEntry = BlacklistEntry' {
- listingTime :: Maybe POSIX
- rblName :: Maybe Text
- description :: Maybe Text
- newBlacklistEntry :: BlacklistEntry
- blacklistEntry_listingTime :: Lens' BlacklistEntry (Maybe UTCTime)
- blacklistEntry_rblName :: Lens' BlacklistEntry (Maybe Text)
- blacklistEntry_description :: Lens' BlacklistEntry (Maybe Text)
- data Body = Body' {}
- newBody :: Body
- body_text :: Lens' Body (Maybe Content)
- body_html :: Lens' Body (Maybe Content)
- data CloudWatchDestination = CloudWatchDestination' {}
- newCloudWatchDestination :: CloudWatchDestination
- cloudWatchDestination_dimensionConfigurations :: Lens' CloudWatchDestination [CloudWatchDimensionConfiguration]
- data CloudWatchDimensionConfiguration = CloudWatchDimensionConfiguration' {}
- newCloudWatchDimensionConfiguration :: Text -> DimensionValueSource -> Text -> CloudWatchDimensionConfiguration
- cloudWatchDimensionConfiguration_dimensionName :: Lens' CloudWatchDimensionConfiguration Text
- cloudWatchDimensionConfiguration_dimensionValueSource :: Lens' CloudWatchDimensionConfiguration DimensionValueSource
- cloudWatchDimensionConfiguration_defaultDimensionValue :: Lens' CloudWatchDimensionConfiguration Text
- data Content = Content' {}
- newContent :: Text -> Content
- content_charset :: Lens' Content (Maybe Text)
- content_data :: Lens' Content Text
- data DailyVolume = DailyVolume' {}
- newDailyVolume :: DailyVolume
- dailyVolume_domainIspPlacements :: Lens' DailyVolume (Maybe [DomainIspPlacement])
- dailyVolume_startDate :: Lens' DailyVolume (Maybe UTCTime)
- dailyVolume_volumeStatistics :: Lens' DailyVolume (Maybe VolumeStatistics)
- data DedicatedIp = DedicatedIp' {
- poolName :: Maybe Text
- ip :: Text
- warmupStatus :: WarmupStatus
- warmupPercentage :: Int
- newDedicatedIp :: Text -> WarmupStatus -> Int -> DedicatedIp
- dedicatedIp_poolName :: Lens' DedicatedIp (Maybe Text)
- dedicatedIp_ip :: Lens' DedicatedIp Text
- dedicatedIp_warmupStatus :: Lens' DedicatedIp WarmupStatus
- dedicatedIp_warmupPercentage :: Lens' DedicatedIp Int
- data DeliverabilityTestReport = DeliverabilityTestReport' {}
- newDeliverabilityTestReport :: DeliverabilityTestReport
- deliverabilityTestReport_subject :: Lens' DeliverabilityTestReport (Maybe Text)
- deliverabilityTestReport_fromEmailAddress :: Lens' DeliverabilityTestReport (Maybe Text)
- deliverabilityTestReport_createDate :: Lens' DeliverabilityTestReport (Maybe UTCTime)
- deliverabilityTestReport_reportId :: Lens' DeliverabilityTestReport (Maybe Text)
- deliverabilityTestReport_reportName :: Lens' DeliverabilityTestReport (Maybe Text)
- deliverabilityTestReport_deliverabilityTestStatus :: Lens' DeliverabilityTestReport (Maybe DeliverabilityTestStatus)
- data DeliveryOptions = DeliveryOptions' {}
- newDeliveryOptions :: DeliveryOptions
- deliveryOptions_sendingPoolName :: Lens' DeliveryOptions (Maybe Text)
- deliveryOptions_tlsPolicy :: Lens' DeliveryOptions (Maybe TlsPolicy)
- data Destination = Destination' {
- bccAddresses :: Maybe [Text]
- ccAddresses :: Maybe [Text]
- toAddresses :: Maybe [Text]
- newDestination :: Destination
- destination_bccAddresses :: Lens' Destination (Maybe [Text])
- destination_ccAddresses :: Lens' Destination (Maybe [Text])
- destination_toAddresses :: Lens' Destination (Maybe [Text])
- data DkimAttributes = DkimAttributes' {
- status :: Maybe DkimStatus
- tokens :: Maybe [Text]
- signingEnabled :: Maybe Bool
- newDkimAttributes :: DkimAttributes
- dkimAttributes_status :: Lens' DkimAttributes (Maybe DkimStatus)
- dkimAttributes_tokens :: Lens' DkimAttributes (Maybe [Text])
- dkimAttributes_signingEnabled :: Lens' DkimAttributes (Maybe Bool)
- data DomainDeliverabilityCampaign = DomainDeliverabilityCampaign' {
- spamCount :: Maybe Integer
- subject :: Maybe Text
- esps :: Maybe [Text]
- fromAddress :: Maybe Text
- deleteRate :: Maybe Double
- campaignId :: Maybe Text
- sendingIps :: Maybe [Text]
- firstSeenDateTime :: Maybe POSIX
- inboxCount :: Maybe Integer
- readDeleteRate :: Maybe Double
- projectedVolume :: Maybe Integer
- imageUrl :: Maybe Text
- readRate :: Maybe Double
- lastSeenDateTime :: Maybe POSIX
- newDomainDeliverabilityCampaign :: DomainDeliverabilityCampaign
- domainDeliverabilityCampaign_spamCount :: Lens' DomainDeliverabilityCampaign (Maybe Integer)
- domainDeliverabilityCampaign_subject :: Lens' DomainDeliverabilityCampaign (Maybe Text)
- domainDeliverabilityCampaign_esps :: Lens' DomainDeliverabilityCampaign (Maybe [Text])
- domainDeliverabilityCampaign_fromAddress :: Lens' DomainDeliverabilityCampaign (Maybe Text)
- domainDeliverabilityCampaign_deleteRate :: Lens' DomainDeliverabilityCampaign (Maybe Double)
- domainDeliverabilityCampaign_campaignId :: Lens' DomainDeliverabilityCampaign (Maybe Text)
- domainDeliverabilityCampaign_sendingIps :: Lens' DomainDeliverabilityCampaign (Maybe [Text])
- domainDeliverabilityCampaign_firstSeenDateTime :: Lens' DomainDeliverabilityCampaign (Maybe UTCTime)
- domainDeliverabilityCampaign_inboxCount :: Lens' DomainDeliverabilityCampaign (Maybe Integer)
- domainDeliverabilityCampaign_readDeleteRate :: Lens' DomainDeliverabilityCampaign (Maybe Double)
- domainDeliverabilityCampaign_projectedVolume :: Lens' DomainDeliverabilityCampaign (Maybe Integer)
- domainDeliverabilityCampaign_imageUrl :: Lens' DomainDeliverabilityCampaign (Maybe Text)
- domainDeliverabilityCampaign_readRate :: Lens' DomainDeliverabilityCampaign (Maybe Double)
- domainDeliverabilityCampaign_lastSeenDateTime :: Lens' DomainDeliverabilityCampaign (Maybe UTCTime)
- data DomainDeliverabilityTrackingOption = DomainDeliverabilityTrackingOption' {}
- newDomainDeliverabilityTrackingOption :: DomainDeliverabilityTrackingOption
- domainDeliverabilityTrackingOption_domain :: Lens' DomainDeliverabilityTrackingOption (Maybe Text)
- domainDeliverabilityTrackingOption_subscriptionStartDate :: Lens' DomainDeliverabilityTrackingOption (Maybe UTCTime)
- domainDeliverabilityTrackingOption_inboxPlacementTrackingOption :: Lens' DomainDeliverabilityTrackingOption (Maybe InboxPlacementTrackingOption)
- data DomainIspPlacement = DomainIspPlacement' {}
- newDomainIspPlacement :: DomainIspPlacement
- domainIspPlacement_spamPercentage :: Lens' DomainIspPlacement (Maybe Double)
- domainIspPlacement_inboxRawCount :: Lens' DomainIspPlacement (Maybe Integer)
- domainIspPlacement_ispName :: Lens' DomainIspPlacement (Maybe Text)
- domainIspPlacement_inboxPercentage :: Lens' DomainIspPlacement (Maybe Double)
- domainIspPlacement_spamRawCount :: Lens' DomainIspPlacement (Maybe Integer)
- data EmailContent = EmailContent' {}
- newEmailContent :: EmailContent
- emailContent_raw :: Lens' EmailContent (Maybe RawMessage)
- emailContent_simple :: Lens' EmailContent (Maybe Message)
- emailContent_template :: Lens' EmailContent (Maybe Template)
- data EventDestination = EventDestination' {}
- newEventDestination :: Text -> EventDestination
- eventDestination_pinpointDestination :: Lens' EventDestination (Maybe PinpointDestination)
- eventDestination_enabled :: Lens' EventDestination (Maybe Bool)
- eventDestination_kinesisFirehoseDestination :: Lens' EventDestination (Maybe KinesisFirehoseDestination)
- eventDestination_cloudWatchDestination :: Lens' EventDestination (Maybe CloudWatchDestination)
- eventDestination_snsDestination :: Lens' EventDestination (Maybe SnsDestination)
- eventDestination_name :: Lens' EventDestination Text
- eventDestination_matchingEventTypes :: Lens' EventDestination [EventType]
- data EventDestinationDefinition = EventDestinationDefinition' {}
- newEventDestinationDefinition :: EventDestinationDefinition
- eventDestinationDefinition_matchingEventTypes :: Lens' EventDestinationDefinition (Maybe [EventType])
- eventDestinationDefinition_pinpointDestination :: Lens' EventDestinationDefinition (Maybe PinpointDestination)
- eventDestinationDefinition_enabled :: Lens' EventDestinationDefinition (Maybe Bool)
- eventDestinationDefinition_kinesisFirehoseDestination :: Lens' EventDestinationDefinition (Maybe KinesisFirehoseDestination)
- eventDestinationDefinition_cloudWatchDestination :: Lens' EventDestinationDefinition (Maybe CloudWatchDestination)
- eventDestinationDefinition_snsDestination :: Lens' EventDestinationDefinition (Maybe SnsDestination)
- data IdentityInfo = IdentityInfo' {}
- newIdentityInfo :: IdentityInfo
- identityInfo_identityType :: Lens' IdentityInfo (Maybe IdentityType)
- identityInfo_identityName :: Lens' IdentityInfo (Maybe Text)
- identityInfo_sendingEnabled :: Lens' IdentityInfo (Maybe Bool)
- data InboxPlacementTrackingOption = InboxPlacementTrackingOption' {}
- newInboxPlacementTrackingOption :: InboxPlacementTrackingOption
- inboxPlacementTrackingOption_trackedIsps :: Lens' InboxPlacementTrackingOption (Maybe [Text])
- inboxPlacementTrackingOption_global :: Lens' InboxPlacementTrackingOption (Maybe Bool)
- data IspPlacement = IspPlacement' {}
- newIspPlacement :: IspPlacement
- ispPlacement_placementStatistics :: Lens' IspPlacement (Maybe PlacementStatistics)
- ispPlacement_ispName :: Lens' IspPlacement (Maybe Text)
- data KinesisFirehoseDestination = KinesisFirehoseDestination' {}
- newKinesisFirehoseDestination :: Text -> Text -> KinesisFirehoseDestination
- kinesisFirehoseDestination_iamRoleArn :: Lens' KinesisFirehoseDestination Text
- kinesisFirehoseDestination_deliveryStreamArn :: Lens' KinesisFirehoseDestination Text
- data MailFromAttributes = MailFromAttributes' {}
- newMailFromAttributes :: Text -> MailFromDomainStatus -> BehaviorOnMxFailure -> MailFromAttributes
- mailFromAttributes_mailFromDomain :: Lens' MailFromAttributes Text
- mailFromAttributes_mailFromDomainStatus :: Lens' MailFromAttributes MailFromDomainStatus
- mailFromAttributes_behaviorOnMxFailure :: Lens' MailFromAttributes BehaviorOnMxFailure
- data Message = Message' {}
- newMessage :: Content -> Body -> Message
- message_subject :: Lens' Message Content
- message_body :: Lens' Message Body
- data MessageTag = MessageTag' {}
- newMessageTag :: Text -> Text -> MessageTag
- messageTag_name :: Lens' MessageTag Text
- messageTag_value :: Lens' MessageTag Text
- data OverallVolume = OverallVolume' {}
- newOverallVolume :: OverallVolume
- overallVolume_domainIspPlacements :: Lens' OverallVolume (Maybe [DomainIspPlacement])
- overallVolume_volumeStatistics :: Lens' OverallVolume (Maybe VolumeStatistics)
- overallVolume_readRatePercent :: Lens' OverallVolume (Maybe Double)
- data PinpointDestination = PinpointDestination' {}
- newPinpointDestination :: PinpointDestination
- pinpointDestination_applicationArn :: Lens' PinpointDestination (Maybe Text)
- data PlacementStatistics = PlacementStatistics' {}
- newPlacementStatistics :: PlacementStatistics
- placementStatistics_missingPercentage :: Lens' PlacementStatistics (Maybe Double)
- placementStatistics_spamPercentage :: Lens' PlacementStatistics (Maybe Double)
- placementStatistics_spfPercentage :: Lens' PlacementStatistics (Maybe Double)
- placementStatistics_dkimPercentage :: Lens' PlacementStatistics (Maybe Double)
- placementStatistics_inboxPercentage :: Lens' PlacementStatistics (Maybe Double)
- data RawMessage = RawMessage' {}
- newRawMessage :: ByteString -> RawMessage
- rawMessage_data :: Lens' RawMessage ByteString
- data ReputationOptions = ReputationOptions' {}
- newReputationOptions :: ReputationOptions
- reputationOptions_lastFreshStart :: Lens' ReputationOptions (Maybe UTCTime)
- reputationOptions_reputationMetricsEnabled :: Lens' ReputationOptions (Maybe Bool)
- data SendQuota = SendQuota' {}
- newSendQuota :: SendQuota
- sendQuota_maxSendRate :: Lens' SendQuota (Maybe Double)
- sendQuota_sentLast24Hours :: Lens' SendQuota (Maybe Double)
- sendQuota_max24HourSend :: Lens' SendQuota (Maybe Double)
- data SendingOptions = SendingOptions' {}
- newSendingOptions :: SendingOptions
- sendingOptions_sendingEnabled :: Lens' SendingOptions (Maybe Bool)
- data SnsDestination = SnsDestination' {}
- newSnsDestination :: Text -> SnsDestination
- snsDestination_topicArn :: Lens' SnsDestination Text
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data Template = Template' {}
- newTemplate :: Template
- template_templateArn :: Lens' Template (Maybe Text)
- template_templateData :: Lens' Template (Maybe Text)
- data TrackingOptions = TrackingOptions' {}
- newTrackingOptions :: Text -> TrackingOptions
- trackingOptions_customRedirectDomain :: Lens' TrackingOptions Text
- data VolumeStatistics = VolumeStatistics' {}
- newVolumeStatistics :: VolumeStatistics
- volumeStatistics_inboxRawCount :: Lens' VolumeStatistics (Maybe Integer)
- volumeStatistics_projectedSpam :: Lens' VolumeStatistics (Maybe Integer)
- volumeStatistics_projectedInbox :: Lens' VolumeStatistics (Maybe Integer)
- volumeStatistics_spamRawCount :: Lens' VolumeStatistics (Maybe Integer)
Service Configuration
defaultService :: Service Source #
API version 2018-07-26 of the Amazon Pinpoint Email Service SDK configuration.
Errors
_MessageRejected :: AsError a => Getting (First ServiceError) a ServiceError Source #
The message can't be sent because it contains invalid content.
_MailFromDomainNotVerifiedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The message can't be sent because the sending domain isn't verified.
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource you attempted to access doesn't exist.
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Too many requests have been made to the operation.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is being modified by another operation or thread.
_AccountSuspendedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The message can't be sent because the account's ability to send email has been permanently restricted.
_SendingPausedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The message can't be sent because the account's ability to send email is currently paused.
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input you provided is invalid.
_AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource specified in your request already exists.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There are too many instances of the specified resource type.
BehaviorOnMxFailure
newtype BehaviorOnMxFailure Source #
The action that you want Amazon Pinpoint to take if it can't read the
required MX record for a custom MAIL FROM domain. When you set this
value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the
MAIL FROM domain. When you set this value to RejectMessage, Amazon
Pinpoint returns a MailFromDomainNotVerified error, and doesn't
attempt to deliver the email.
These behaviors are taken when the custom MAIL FROM domain configuration
is in the Pending, Failed, and TemporaryFailure states.
Constructors
| BehaviorOnMxFailure' | |
Fields | |
Bundled Patterns
| pattern BehaviorOnMxFailure_REJECT_MESSAGE :: BehaviorOnMxFailure | |
| pattern BehaviorOnMxFailure_USE_DEFAULT_VALUE :: BehaviorOnMxFailure |
Instances
DeliverabilityDashboardAccountStatus
newtype DeliverabilityDashboardAccountStatus Source #
The current status of your Deliverability dashboard subscription. If
this value is PENDING_EXPIRATION, your subscription is scheduled to
expire at the end of the current calendar month.
Constructors
| DeliverabilityDashboardAccountStatus' | |
Bundled Patterns
Instances
DeliverabilityTestStatus
newtype DeliverabilityTestStatus Source #
The status of a predictive inbox placement test. If the status is
IN_PROGRESS, then the predictive inbox placement test is currently
running. Predictive inbox placement tests are usually complete within 24
hours of creating the test. If the status is COMPLETE, then the test
is finished, and you can use the GetDeliverabilityTestReport operation
to view the results of the test.
Constructors
| DeliverabilityTestStatus' | |
Fields | |
Bundled Patterns
| pattern DeliverabilityTestStatus_COMPLETED :: DeliverabilityTestStatus | |
| pattern DeliverabilityTestStatus_IN_PROGRESS :: DeliverabilityTestStatus |
Instances
DimensionValueSource
newtype DimensionValueSource Source #
The location where Amazon Pinpoint finds the value of a dimension to
publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the
message tags that you specify using an X-SES-MESSAGE-TAGS header or a
parameter to the SendEmail/SendRawEmail API, choose messageTag. If
you want Amazon Pinpoint to use your own email headers, choose
emailHeader. If you want Amazon Pinpoint to use link tags, choose
linkTags.
Constructors
| DimensionValueSource' | |
Fields | |
Bundled Patterns
| pattern DimensionValueSource_EMAIL_HEADER :: DimensionValueSource | |
| pattern DimensionValueSource_LINK_TAG :: DimensionValueSource | |
| pattern DimensionValueSource_MESSAGE_TAG :: DimensionValueSource |
Instances
DkimStatus
newtype DkimStatus Source #
The DKIM authentication status of the identity. The status can be one of the following:
PENDING– The DKIM verification process was initiated, and Amazon Pinpoint is still waiting for the required CNAME records to appear in the DNS configuration for the domain.SUCCESS– The DKIM authentication process completed successfully.FAILED– The DKIM authentication process failed. This can happen when Amazon Pinpoint fails to find the required CNAME records in the DNS configuration of the domain.TEMPORARY_FAILURE– A temporary issue is preventing Amazon Pinpoint from determining the DKIM authentication status of the domain.NOT_STARTED– The DKIM verification process hasn't been initiated for the domain.
Constructors
| DkimStatus' | |
Fields | |
Bundled Patterns
| pattern DkimStatus_FAILED :: DkimStatus | |
| pattern DkimStatus_NOT_STARTED :: DkimStatus | |
| pattern DkimStatus_PENDING :: DkimStatus | |
| pattern DkimStatus_SUCCESS :: DkimStatus | |
| pattern DkimStatus_TEMPORARY_FAILURE :: DkimStatus |
Instances
EventType
An email sending event type. For example, email sends, opens, and bounces are all email events.
Constructors
| EventType' | |
Fields | |
Bundled Patterns
| pattern EventType_BOUNCE :: EventType | |
| pattern EventType_CLICK :: EventType | |
| pattern EventType_COMPLAINT :: EventType | |
| pattern EventType_DELIVERY :: EventType | |
| pattern EventType_OPEN :: EventType | |
| pattern EventType_REJECT :: EventType | |
| pattern EventType_RENDERING_FAILURE :: EventType | |
| pattern EventType_SEND :: EventType |
Instances
IdentityType
newtype IdentityType Source #
The email identity type. The identity type can be one of the following:
EMAIL_ADDRESS– The identity is an email address.DOMAIN– The identity is a domain.
Constructors
| IdentityType' | |
Fields | |
Bundled Patterns
| pattern IdentityType_DOMAIN :: IdentityType | |
| pattern IdentityType_EMAIL_ADDRESS :: IdentityType | |
| pattern IdentityType_MANAGED_DOMAIN :: IdentityType |
Instances
MailFromDomainStatus
newtype MailFromDomainStatus Source #
The status of the MAIL FROM domain. This status can have the following values:
PENDING– Amazon Pinpoint hasn't started searching for the MX record yet.SUCCESS– Amazon Pinpoint detected the required MX record for the MAIL FROM domain.FAILED– Amazon Pinpoint can't find the required MX record, or the record no longer exists.TEMPORARY_FAILURE– A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.
Constructors
| MailFromDomainStatus' | |
Fields | |
Bundled Patterns
| pattern MailFromDomainStatus_FAILED :: MailFromDomainStatus | |
| pattern MailFromDomainStatus_PENDING :: MailFromDomainStatus | |
| pattern MailFromDomainStatus_SUCCESS :: MailFromDomainStatus | |
| pattern MailFromDomainStatus_TEMPORARY_FAILURE :: MailFromDomainStatus |
Instances
TlsPolicy
Specifies whether messages that use the configuration set are required
to use Transport Layer Security (TLS). If the value is Require,
messages are only delivered if a TLS connection can be established. If
the value is Optional, messages can be delivered in plain text if a
TLS connection can't be established.
Constructors
| TlsPolicy' | |
Fields | |
Bundled Patterns
| pattern TlsPolicy_OPTIONAL :: TlsPolicy | |
| pattern TlsPolicy_REQUIRE :: TlsPolicy |
Instances
WarmupStatus
newtype WarmupStatus Source #
The warmup status of a dedicated IP.
Constructors
| WarmupStatus' | |
Fields | |
Bundled Patterns
| pattern WarmupStatus_DONE :: WarmupStatus | |
| pattern WarmupStatus_IN_PROGRESS :: WarmupStatus |
Instances
BlacklistEntry
data BlacklistEntry Source #
An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.
See: newBlacklistEntry smart constructor.
Constructors
| BlacklistEntry' | |
Fields
| |
Instances
newBlacklistEntry :: BlacklistEntry Source #
Create a value of BlacklistEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:listingTime:BlacklistEntry', blacklistEntry_listingTime - The time when the blacklisting event occurred, shown in Unix time
format.
$sel:rblName:BlacklistEntry', blacklistEntry_rblName - The name of the blacklist that the IP address appears on.
$sel:description:BlacklistEntry', blacklistEntry_description - Additional information about the blacklisting event, as provided by the
blacklist maintainer.
blacklistEntry_listingTime :: Lens' BlacklistEntry (Maybe UTCTime) Source #
The time when the blacklisting event occurred, shown in Unix time format.
blacklistEntry_rblName :: Lens' BlacklistEntry (Maybe Text) Source #
The name of the blacklist that the IP address appears on.
blacklistEntry_description :: Lens' BlacklistEntry (Maybe Text) Source #
Additional information about the blacklisting event, as provided by the blacklist maintainer.
Body
Represents the body of the email message.
See: newBody smart constructor.
Constructors
| Body' | |
Fields
| |
Instances
| Eq Body Source # | |
| Read Body Source # | |
| Show Body Source # | |
| Generic Body Source # | |
| NFData Body Source # | |
Defined in Amazonka.PinpointEmail.Types.Body | |
| Hashable Body Source # | |
Defined in Amazonka.PinpointEmail.Types.Body | |
| ToJSON Body Source # | |
Defined in Amazonka.PinpointEmail.Types.Body | |
| type Rep Body Source # | |
Defined in Amazonka.PinpointEmail.Types.Body type Rep Body = D1 ('MetaData "Body" "Amazonka.PinpointEmail.Types.Body" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "Body'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Content)) :*: S1 ('MetaSel ('Just "html") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Content)))) | |
Create a value of Body with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:Body', body_text - An object that represents the version of the message that is displayed
in email clients that don't support HTML, or clients where the
recipient has disabled HTML rendering.
$sel:html:Body', body_html - An object that represents the version of the message that is displayed
in email clients that support HTML. HTML messages can include formatted
text, hyperlinks, images, and more.
body_text :: Lens' Body (Maybe Content) Source #
An object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering.
body_html :: Lens' Body (Maybe Content) Source #
An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more.
CloudWatchDestination
data CloudWatchDestination Source #
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
See: newCloudWatchDestination smart constructor.
Constructors
| CloudWatchDestination' | |
Fields
| |
Instances
newCloudWatchDestination :: CloudWatchDestination Source #
Create a value of CloudWatchDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensionConfigurations:CloudWatchDestination', cloudWatchDestination_dimensionConfigurations - An array of objects that define the dimensions to use when you send
email events to Amazon CloudWatch.
cloudWatchDestination_dimensionConfigurations :: Lens' CloudWatchDestination [CloudWatchDimensionConfiguration] Source #
An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
CloudWatchDimensionConfiguration
data CloudWatchDimensionConfiguration Source #
An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.
See: newCloudWatchDimensionConfiguration smart constructor.
Constructors
| CloudWatchDimensionConfiguration' | |
Fields
| |
Instances
newCloudWatchDimensionConfiguration Source #
Arguments
| :: Text | |
| -> DimensionValueSource | |
| -> Text |
|
| -> CloudWatchDimensionConfiguration |
Create a value of CloudWatchDimensionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensionName:CloudWatchDimensionConfiguration', cloudWatchDimensionConfiguration_dimensionName - The name of an Amazon CloudWatch dimension associated with an email
sending metric. The name has to meet the following criteria:
- It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
$sel:dimensionValueSource:CloudWatchDimensionConfiguration', cloudWatchDimensionConfiguration_dimensionValueSource - The location where Amazon Pinpoint finds the value of a dimension to
publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the
message tags that you specify using an X-SES-MESSAGE-TAGS header or a
parameter to the SendEmail/SendRawEmail API, choose messageTag. If
you want Amazon Pinpoint to use your own email headers, choose
emailHeader. If you want Amazon Pinpoint to use link tags, choose
linkTags.
$sel:defaultDimensionValue:CloudWatchDimensionConfiguration', cloudWatchDimensionConfiguration_defaultDimensionValue - The default value of the dimension that is published to Amazon
CloudWatch if you don't provide the value of the dimension when you
send an email. This value has to meet the following criteria:
- It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
cloudWatchDimensionConfiguration_dimensionName :: Lens' CloudWatchDimensionConfiguration Text Source #
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
- It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
cloudWatchDimensionConfiguration_dimensionValueSource :: Lens' CloudWatchDimensionConfiguration DimensionValueSource Source #
The location where Amazon Pinpoint finds the value of a dimension to
publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the
message tags that you specify using an X-SES-MESSAGE-TAGS header or a
parameter to the SendEmail/SendRawEmail API, choose messageTag. If
you want Amazon Pinpoint to use your own email headers, choose
emailHeader. If you want Amazon Pinpoint to use link tags, choose
linkTags.
cloudWatchDimensionConfiguration_defaultDimensionValue :: Lens' CloudWatchDimensionConfiguration Text Source #
The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
- It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
Content
An object that represents the content of the email, and optionally a character set specification.
See: newContent smart constructor.
Constructors
| Content' | |
Fields
| |
Instances
| Eq Content Source # | |
| Read Content Source # | |
| Show Content Source # | |
| Generic Content Source # | |
| NFData Content Source # | |
Defined in Amazonka.PinpointEmail.Types.Content | |
| Hashable Content Source # | |
Defined in Amazonka.PinpointEmail.Types.Content | |
| ToJSON Content Source # | |
Defined in Amazonka.PinpointEmail.Types.Content | |
| type Rep Content Source # | |
Defined in Amazonka.PinpointEmail.Types.Content type Rep Content = D1 ('MetaData "Content" "Amazonka.PinpointEmail.Types.Content" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "Content'" 'PrefixI 'True) (S1 ('MetaSel ('Just "charset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Content with all optional fields omitted.
Use 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:Content', content_charset - The character set for the content. Because of the constraints of the
SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text
includes characters outside of the ASCII range, you have to specify a
character set. For example, you could specify UTF-8, ISO-8859-1, or
Shift_JIS.
$sel:data':Content', content_data - The content of the message itself.
content_charset :: Lens' Content (Maybe Text) Source #
The character set for the content. Because of the constraints of the
SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text
includes characters outside of the ASCII range, you have to specify a
character set. For example, you could specify UTF-8, ISO-8859-1, or
Shift_JIS.
DailyVolume
data DailyVolume Source #
An object that contains information about the volume of email sent on each day of the analysis period.
See: newDailyVolume smart constructor.
Constructors
| DailyVolume' | |
Fields
| |
Instances
newDailyVolume :: DailyVolume Source #
Create a value of DailyVolume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainIspPlacements:DailyVolume', dailyVolume_domainIspPlacements - An object that contains inbox placement metrics for a specified day in
the analysis period, broken out by the recipient's email provider.
$sel:startDate:DailyVolume', dailyVolume_startDate - The date that the DailyVolume metrics apply to, in Unix time.
$sel:volumeStatistics:DailyVolume', dailyVolume_volumeStatistics - An object that contains inbox placement metrics for a specific day in
the analysis period.
dailyVolume_domainIspPlacements :: Lens' DailyVolume (Maybe [DomainIspPlacement]) Source #
An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient's email provider.
dailyVolume_startDate :: Lens' DailyVolume (Maybe UTCTime) Source #
The date that the DailyVolume metrics apply to, in Unix time.
dailyVolume_volumeStatistics :: Lens' DailyVolume (Maybe VolumeStatistics) Source #
An object that contains inbox placement metrics for a specific day in the analysis period.
DedicatedIp
data DedicatedIp Source #
Contains information about a dedicated IP address that is associated with your Amazon Pinpoint account.
See: newDedicatedIp smart constructor.
Constructors
| DedicatedIp' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> WarmupStatus | |
| -> Int | |
| -> DedicatedIp |
Create a value of DedicatedIp with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:poolName:DedicatedIp', dedicatedIp_poolName - The name of the dedicated IP pool that the IP address is associated
with.
$sel:ip:DedicatedIp', dedicatedIp_ip - An IP address that is reserved for use by your Amazon Pinpoint account.
$sel:warmupStatus:DedicatedIp', dedicatedIp_warmupStatus - The warm-up status of a dedicated IP address. The status can have one of
the following values:
IN_PROGRESS– The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.DONE– The dedicated IP warm-up process is complete, and the IP address is ready to use.
$sel:warmupPercentage:DedicatedIp', dedicatedIp_warmupPercentage - Indicates how complete the dedicated IP warm-up process is. When this
value equals 1, the address has completed the warm-up process and is
ready for use.
dedicatedIp_poolName :: Lens' DedicatedIp (Maybe Text) Source #
The name of the dedicated IP pool that the IP address is associated with.
dedicatedIp_ip :: Lens' DedicatedIp Text Source #
An IP address that is reserved for use by your Amazon Pinpoint account.
dedicatedIp_warmupStatus :: Lens' DedicatedIp WarmupStatus Source #
The warm-up status of a dedicated IP address. The status can have one of the following values:
IN_PROGRESS– The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.DONE– The dedicated IP warm-up process is complete, and the IP address is ready to use.
dedicatedIp_warmupPercentage :: Lens' DedicatedIp Int Source #
Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
DeliverabilityTestReport
data DeliverabilityTestReport Source #
An object that contains metadata related to a predictive inbox placement test.
See: newDeliverabilityTestReport smart constructor.
Constructors
| DeliverabilityTestReport' | |
Fields
| |
Instances
newDeliverabilityTestReport :: DeliverabilityTestReport Source #
Create a value of DeliverabilityTestReport with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subject:DeliverabilityTestReport', deliverabilityTestReport_subject - The subject line for an email that you submitted in a predictive inbox
placement test.
$sel:fromEmailAddress:DeliverabilityTestReport', deliverabilityTestReport_fromEmailAddress - The sender address that you specified for the predictive inbox placement
test.
$sel:createDate:DeliverabilityTestReport', deliverabilityTestReport_createDate - The date and time when the predictive inbox placement test was created,
in Unix time format.
$sel:reportId:DeliverabilityTestReport', deliverabilityTestReport_reportId - A unique string that identifies the predictive inbox placement test.
$sel:reportName:DeliverabilityTestReport', deliverabilityTestReport_reportName - A name that helps you identify a predictive inbox placement test report.
$sel:deliverabilityTestStatus:DeliverabilityTestReport', deliverabilityTestReport_deliverabilityTestStatus - The status of the predictive inbox placement test. If the status is
IN_PROGRESS, then the predictive inbox placement test is currently
running. Predictive inbox placement tests are usually complete within 24
hours of creating the test. If the status is COMPLETE, then the test
is finished, and you can use the GetDeliverabilityTestReport to view
the results of the test.
deliverabilityTestReport_subject :: Lens' DeliverabilityTestReport (Maybe Text) Source #
The subject line for an email that you submitted in a predictive inbox placement test.
deliverabilityTestReport_fromEmailAddress :: Lens' DeliverabilityTestReport (Maybe Text) Source #
The sender address that you specified for the predictive inbox placement test.
deliverabilityTestReport_createDate :: Lens' DeliverabilityTestReport (Maybe UTCTime) Source #
The date and time when the predictive inbox placement test was created, in Unix time format.
deliverabilityTestReport_reportId :: Lens' DeliverabilityTestReport (Maybe Text) Source #
A unique string that identifies the predictive inbox placement test.
deliverabilityTestReport_reportName :: Lens' DeliverabilityTestReport (Maybe Text) Source #
A name that helps you identify a predictive inbox placement test report.
deliverabilityTestReport_deliverabilityTestStatus :: Lens' DeliverabilityTestReport (Maybe DeliverabilityTestStatus) Source #
The status of the predictive inbox placement test. If the status is
IN_PROGRESS, then the predictive inbox placement test is currently
running. Predictive inbox placement tests are usually complete within 24
hours of creating the test. If the status is COMPLETE, then the test
is finished, and you can use the GetDeliverabilityTestReport to view
the results of the test.
DeliveryOptions
data DeliveryOptions Source #
Used to associate a configuration set with a dedicated IP pool.
See: newDeliveryOptions smart constructor.
Constructors
| DeliveryOptions' | |
Fields
| |
Instances
newDeliveryOptions :: DeliveryOptions Source #
Create a value of DeliveryOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sendingPoolName:DeliveryOptions', deliveryOptions_sendingPoolName - The name of the dedicated IP pool that you want to associate with the
configuration set.
$sel:tlsPolicy:DeliveryOptions', deliveryOptions_tlsPolicy - Specifies whether messages that use the configuration set are required
to use Transport Layer Security (TLS). If the value is Require,
messages are only delivered if a TLS connection can be established. If
the value is Optional, messages can be delivered in plain text if a
TLS connection can't be established.
deliveryOptions_sendingPoolName :: Lens' DeliveryOptions (Maybe Text) Source #
The name of the dedicated IP pool that you want to associate with the configuration set.
deliveryOptions_tlsPolicy :: Lens' DeliveryOptions (Maybe TlsPolicy) Source #
Specifies whether messages that use the configuration set are required
to use Transport Layer Security (TLS). If the value is Require,
messages are only delivered if a TLS connection can be established. If
the value is Optional, messages can be delivered in plain text if a
TLS connection can't be established.
Destination
data Destination Source #
An object that describes the recipients for an email.
See: newDestination smart constructor.
Constructors
| Destination' | |
Fields
| |
Instances
newDestination :: Destination Source #
Create a value of Destination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bccAddresses:Destination', destination_bccAddresses - An array that contains the email addresses of the "BCC" (blind carbon
copy) recipients for the email.
$sel:ccAddresses:Destination', destination_ccAddresses - An array that contains the email addresses of the "CC" (carbon copy)
recipients for the email.
$sel:toAddresses:Destination', destination_toAddresses - An array that contains the email addresses of the "To" recipients for
the email.
destination_bccAddresses :: Lens' Destination (Maybe [Text]) Source #
An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.
destination_ccAddresses :: Lens' Destination (Maybe [Text]) Source #
An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.
destination_toAddresses :: Lens' Destination (Maybe [Text]) Source #
An array that contains the email addresses of the "To" recipients for the email.
DkimAttributes
data DkimAttributes Source #
An object that contains information about the DKIM configuration for an email identity.
See: newDkimAttributes smart constructor.
Constructors
| DkimAttributes' | |
Fields
| |
Instances
newDkimAttributes :: DkimAttributes Source #
Create a value of DkimAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DkimAttributes', dkimAttributes_status - Describes whether or not Amazon Pinpoint has successfully located the
DKIM records in the DNS records for the domain. The status can be one of
the following:
PENDING– Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.SUCCESS– Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity.FAILED– Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them.TEMPORARY_FAILURE– A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain.NOT_STARTED– Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain.
$sel:tokens:DkimAttributes', dkimAttributes_tokens - A set of unique strings that you use to create a set of CNAME records
that you add to the DNS configuration for your domain. When Amazon
Pinpoint detects these records in the DNS configuration for your domain,
the DKIM authentication process is complete. Amazon Pinpoint usually
detects these records within about 72 hours of adding them to the DNS
configuration for your domain.
$sel:signingEnabled:DkimAttributes', dkimAttributes_signingEnabled - If the value is true, then the messages that Amazon Pinpoint sends
from the identity are DKIM-signed. If the value is false, then the
messages that Amazon Pinpoint sends from the identity aren't
DKIM-signed.
dkimAttributes_status :: Lens' DkimAttributes (Maybe DkimStatus) Source #
Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:
PENDING– Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.SUCCESS– Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity.FAILED– Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them.TEMPORARY_FAILURE– A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain.NOT_STARTED– Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain.
dkimAttributes_tokens :: Lens' DkimAttributes (Maybe [Text]) Source #
A set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.
dkimAttributes_signingEnabled :: Lens' DkimAttributes (Maybe Bool) Source #
If the value is true, then the messages that Amazon Pinpoint sends
from the identity are DKIM-signed. If the value is false, then the
messages that Amazon Pinpoint sends from the identity aren't
DKIM-signed.
DomainDeliverabilityCampaign
data DomainDeliverabilityCampaign Source #
An object that contains the deliverability data for a specific campaign.
This data is available for a campaign only if the campaign sent email by
using a domain that the Deliverability dashboard is enabled for
(PutDeliverabilityDashboardOption operation).
See: newDomainDeliverabilityCampaign smart constructor.
Constructors
| DomainDeliverabilityCampaign' | |
Fields
| |
Instances
newDomainDeliverabilityCampaign :: DomainDeliverabilityCampaign Source #
Create a value of DomainDeliverabilityCampaign with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:spamCount:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_spamCount - The number of email messages that were delivered to recipients' spam or
junk mail folders.
$sel:subject:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_subject - The subject line, or title, of the email message.
$sel:esps:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_esps - The major email providers who handled the email message.
$sel:fromAddress:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_fromAddress - The verified email address that the email message was sent from.
$sel:deleteRate:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_deleteRate - The percentage of email messages that were deleted by recipients,
without being opened first. Due to technical limitations, this value
only includes recipients who opened the message by using an email client
that supports images.
$sel:campaignId:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_campaignId - The unique identifier for the campaign. Amazon Pinpoint automatically
generates and assigns this identifier to a campaign. This value is not
the same as the campaign identifier that Amazon Pinpoint assigns to
campaigns that you create and manage by using the Amazon Pinpoint API or
the Amazon Pinpoint console.
$sel:sendingIps:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_sendingIps - The IP addresses that were used to send the email message.
$sel:firstSeenDateTime:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_firstSeenDateTime - The first time, in Unix time format, when the email message was
delivered to any recipient's inbox. This value can help you determine
how long it took for a campaign to deliver an email message.
$sel:inboxCount:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_inboxCount - The number of email messages that were delivered to recipients’ inboxes.
$sel:readDeleteRate:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_readDeleteRate - The percentage of email messages that were opened and then deleted by
recipients. Due to technical limitations, this value only includes
recipients who opened the message by using an email client that supports
images.
$sel:projectedVolume:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_projectedVolume - The projected number of recipients that the email message was sent to.
$sel:imageUrl:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_imageUrl - The URL of an image that contains a snapshot of the email message that
was sent.
$sel:readRate:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_readRate - The percentage of email messages that were opened by recipients. Due to
technical limitations, this value only includes recipients who opened
the message by using an email client that supports images.
$sel:lastSeenDateTime:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_lastSeenDateTime - The last time, in Unix time format, when the email message was delivered
to any recipient's inbox. This value can help you determine how long it
took for a campaign to deliver an email message.
domainDeliverabilityCampaign_spamCount :: Lens' DomainDeliverabilityCampaign (Maybe Integer) Source #
The number of email messages that were delivered to recipients' spam or junk mail folders.
domainDeliverabilityCampaign_subject :: Lens' DomainDeliverabilityCampaign (Maybe Text) Source #
The subject line, or title, of the email message.
domainDeliverabilityCampaign_esps :: Lens' DomainDeliverabilityCampaign (Maybe [Text]) Source #
The major email providers who handled the email message.
domainDeliverabilityCampaign_fromAddress :: Lens' DomainDeliverabilityCampaign (Maybe Text) Source #
The verified email address that the email message was sent from.
domainDeliverabilityCampaign_deleteRate :: Lens' DomainDeliverabilityCampaign (Maybe Double) Source #
The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
domainDeliverabilityCampaign_campaignId :: Lens' DomainDeliverabilityCampaign (Maybe Text) Source #
The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.
domainDeliverabilityCampaign_sendingIps :: Lens' DomainDeliverabilityCampaign (Maybe [Text]) Source #
The IP addresses that were used to send the email message.
domainDeliverabilityCampaign_firstSeenDateTime :: Lens' DomainDeliverabilityCampaign (Maybe UTCTime) Source #
The first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
domainDeliverabilityCampaign_inboxCount :: Lens' DomainDeliverabilityCampaign (Maybe Integer) Source #
The number of email messages that were delivered to recipients’ inboxes.
domainDeliverabilityCampaign_readDeleteRate :: Lens' DomainDeliverabilityCampaign (Maybe Double) Source #
The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
domainDeliverabilityCampaign_projectedVolume :: Lens' DomainDeliverabilityCampaign (Maybe Integer) Source #
The projected number of recipients that the email message was sent to.
domainDeliverabilityCampaign_imageUrl :: Lens' DomainDeliverabilityCampaign (Maybe Text) Source #
The URL of an image that contains a snapshot of the email message that was sent.
domainDeliverabilityCampaign_readRate :: Lens' DomainDeliverabilityCampaign (Maybe Double) Source #
The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
domainDeliverabilityCampaign_lastSeenDateTime :: Lens' DomainDeliverabilityCampaign (Maybe UTCTime) Source #
The last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
DomainDeliverabilityTrackingOption
data DomainDeliverabilityTrackingOption Source #
An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.
See: newDomainDeliverabilityTrackingOption smart constructor.
Constructors
| DomainDeliverabilityTrackingOption' | |
Fields
| |
Instances
newDomainDeliverabilityTrackingOption :: DomainDeliverabilityTrackingOption Source #
Create a value of DomainDeliverabilityTrackingOption with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domain:DomainDeliverabilityTrackingOption', domainDeliverabilityTrackingOption_domain - A verified domain that’s associated with your AWS account and currently
has an active Deliverability dashboard subscription.
$sel:subscriptionStartDate:DomainDeliverabilityTrackingOption', domainDeliverabilityTrackingOption_subscriptionStartDate - The date, in Unix time format, when you enabled the Deliverability
dashboard for the domain.
$sel:inboxPlacementTrackingOption:DomainDeliverabilityTrackingOption', domainDeliverabilityTrackingOption_inboxPlacementTrackingOption - An object that contains information about the inbox placement data
settings for the domain.
domainDeliverabilityTrackingOption_domain :: Lens' DomainDeliverabilityTrackingOption (Maybe Text) Source #
A verified domain that’s associated with your AWS account and currently has an active Deliverability dashboard subscription.
domainDeliverabilityTrackingOption_subscriptionStartDate :: Lens' DomainDeliverabilityTrackingOption (Maybe UTCTime) Source #
The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.
domainDeliverabilityTrackingOption_inboxPlacementTrackingOption :: Lens' DomainDeliverabilityTrackingOption (Maybe InboxPlacementTrackingOption) Source #
An object that contains information about the inbox placement data settings for the domain.
DomainIspPlacement
data DomainIspPlacement Source #
An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.
See: newDomainIspPlacement smart constructor.
Constructors
| DomainIspPlacement' | |
Fields
| |
Instances
newDomainIspPlacement :: DomainIspPlacement Source #
Create a value of DomainIspPlacement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:spamPercentage:DomainIspPlacement', domainIspPlacement_spamPercentage - The percentage of messages that were sent from the selected domain to
the specified email provider that arrived in recipients' spam or junk
mail folders.
$sel:inboxRawCount:DomainIspPlacement', domainIspPlacement_inboxRawCount - The total number of messages that were sent from the selected domain to
the specified email provider that arrived in recipients' inboxes.
$sel:ispName:DomainIspPlacement', domainIspPlacement_ispName - The name of the email provider that the inbox placement data applies to.
$sel:inboxPercentage:DomainIspPlacement', domainIspPlacement_inboxPercentage - The percentage of messages that were sent from the selected domain to
the specified email provider that arrived in recipients' inboxes.
$sel:spamRawCount:DomainIspPlacement', domainIspPlacement_spamRawCount - The total number of messages that were sent from the selected domain to
the specified email provider that arrived in recipients' spam or junk
mail folders.
domainIspPlacement_spamPercentage :: Lens' DomainIspPlacement (Maybe Double) Source #
The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
domainIspPlacement_inboxRawCount :: Lens' DomainIspPlacement (Maybe Integer) Source #
The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
domainIspPlacement_ispName :: Lens' DomainIspPlacement (Maybe Text) Source #
The name of the email provider that the inbox placement data applies to.
domainIspPlacement_inboxPercentage :: Lens' DomainIspPlacement (Maybe Double) Source #
The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
domainIspPlacement_spamRawCount :: Lens' DomainIspPlacement (Maybe Integer) Source #
The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
EmailContent
data EmailContent Source #
An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.
See: newEmailContent smart constructor.
Constructors
| EmailContent' | |
Fields
| |
Instances
newEmailContent :: EmailContent Source #
Create a value of EmailContent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:raw:EmailContent', emailContent_raw - The raw email message. The message has to meet the following criteria:
- The message has to contain a header and a body, separated by one blank line.
- All of the required header fields must be present in the message.
- Each part of a multipart MIME message must be formatted properly.
- If you include attachments, they must be in a file format that Amazon Pinpoint supports.
- The entire message must be Base64 encoded.
- If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
- The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
$sel:simple:EmailContent', emailContent_simple - The simple email message. The message consists of a subject and a
message body.
$sel:template:EmailContent', emailContent_template - The template to use for the email message.
emailContent_raw :: Lens' EmailContent (Maybe RawMessage) Source #
The raw email message. The message has to meet the following criteria:
- The message has to contain a header and a body, separated by one blank line.
- All of the required header fields must be present in the message.
- Each part of a multipart MIME message must be formatted properly.
- If you include attachments, they must be in a file format that Amazon Pinpoint supports.
- The entire message must be Base64 encoded.
- If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
- The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
emailContent_simple :: Lens' EmailContent (Maybe Message) Source #
The simple email message. The message consists of a subject and a message body.
emailContent_template :: Lens' EmailContent (Maybe Template) Source #
The template to use for the email message.
EventDestination
data EventDestination Source #
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
See: newEventDestination smart constructor.
Constructors
| EventDestination' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> EventDestination |
Create a value of EventDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pinpointDestination:EventDestination', eventDestination_pinpointDestination - An object that defines a Amazon Pinpoint destination for email events.
You can use Amazon Pinpoint events to create attributes in Amazon
Pinpoint projects. You can use these attributes to create segments for
your campaigns.
$sel:enabled:EventDestination', eventDestination_enabled - If true, the event destination is enabled. When the event destination
is enabled, the specified event types are sent to the destinations in
this EventDestinationDefinition.
If false, the event destination is disabled. When the event
destination is disabled, events aren't sent to the specified
destinations.
$sel:kinesisFirehoseDestination:EventDestination', eventDestination_kinesisFirehoseDestination - An object that defines an Amazon Kinesis Data Firehose destination for
email events. You can use Amazon Kinesis Data Firehose to stream data to
other services, such as Amazon S3 and Amazon Redshift.
$sel:cloudWatchDestination:EventDestination', eventDestination_cloudWatchDestination - An object that defines an Amazon CloudWatch destination for email
events. You can use Amazon CloudWatch to monitor and gain insights on
your email sending metrics.
$sel:snsDestination:EventDestination', eventDestination_snsDestination - An object that defines an Amazon SNS destination for email events. You
can use Amazon SNS to send notification when certain email events occur.
$sel:name:EventDestination', eventDestination_name - A name that identifies the event destination.
$sel:matchingEventTypes:EventDestination', eventDestination_matchingEventTypes - The types of events that Amazon Pinpoint sends to the specified event
destinations.
eventDestination_pinpointDestination :: Lens' EventDestination (Maybe PinpointDestination) Source #
An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
eventDestination_enabled :: Lens' EventDestination (Maybe Bool) Source #
If true, the event destination is enabled. When the event destination
is enabled, the specified event types are sent to the destinations in
this EventDestinationDefinition.
If false, the event destination is disabled. When the event
destination is disabled, events aren't sent to the specified
destinations.
eventDestination_kinesisFirehoseDestination :: Lens' EventDestination (Maybe KinesisFirehoseDestination) Source #
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
eventDestination_cloudWatchDestination :: Lens' EventDestination (Maybe CloudWatchDestination) Source #
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
eventDestination_snsDestination :: Lens' EventDestination (Maybe SnsDestination) Source #
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
eventDestination_name :: Lens' EventDestination Text Source #
A name that identifies the event destination.
eventDestination_matchingEventTypes :: Lens' EventDestination [EventType] Source #
The types of events that Amazon Pinpoint sends to the specified event destinations.
EventDestinationDefinition
data EventDestinationDefinition Source #
An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.
See: newEventDestinationDefinition smart constructor.
Constructors
| EventDestinationDefinition' | |
Fields
| |
Instances
newEventDestinationDefinition :: EventDestinationDefinition Source #
Create a value of EventDestinationDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:matchingEventTypes:EventDestinationDefinition', eventDestinationDefinition_matchingEventTypes - An array that specifies which events Amazon Pinpoint should send to the
destinations in this EventDestinationDefinition.
$sel:pinpointDestination:EventDestinationDefinition', eventDestinationDefinition_pinpointDestination - An object that defines a Amazon Pinpoint destination for email events.
You can use Amazon Pinpoint events to create attributes in Amazon
Pinpoint projects. You can use these attributes to create segments for
your campaigns.
$sel:enabled:EventDestinationDefinition', eventDestinationDefinition_enabled - If true, the event destination is enabled. When the event destination
is enabled, the specified event types are sent to the destinations in
this EventDestinationDefinition.
If false, the event destination is disabled. When the event
destination is disabled, events aren't sent to the specified
destinations.
$sel:kinesisFirehoseDestination:EventDestinationDefinition', eventDestinationDefinition_kinesisFirehoseDestination - An object that defines an Amazon Kinesis Data Firehose destination for
email events. You can use Amazon Kinesis Data Firehose to stream data to
other services, such as Amazon S3 and Amazon Redshift.
$sel:cloudWatchDestination:EventDestinationDefinition', eventDestinationDefinition_cloudWatchDestination - An object that defines an Amazon CloudWatch destination for email
events. You can use Amazon CloudWatch to monitor and gain insights on
your email sending metrics.
$sel:snsDestination:EventDestinationDefinition', eventDestinationDefinition_snsDestination - An object that defines an Amazon SNS destination for email events. You
can use Amazon SNS to send notification when certain email events occur.
eventDestinationDefinition_matchingEventTypes :: Lens' EventDestinationDefinition (Maybe [EventType]) Source #
An array that specifies which events Amazon Pinpoint should send to the
destinations in this EventDestinationDefinition.
eventDestinationDefinition_pinpointDestination :: Lens' EventDestinationDefinition (Maybe PinpointDestination) Source #
An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
eventDestinationDefinition_enabled :: Lens' EventDestinationDefinition (Maybe Bool) Source #
If true, the event destination is enabled. When the event destination
is enabled, the specified event types are sent to the destinations in
this EventDestinationDefinition.
If false, the event destination is disabled. When the event
destination is disabled, events aren't sent to the specified
destinations.
eventDestinationDefinition_kinesisFirehoseDestination :: Lens' EventDestinationDefinition (Maybe KinesisFirehoseDestination) Source #
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
eventDestinationDefinition_cloudWatchDestination :: Lens' EventDestinationDefinition (Maybe CloudWatchDestination) Source #
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
eventDestinationDefinition_snsDestination :: Lens' EventDestinationDefinition (Maybe SnsDestination) Source #
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
IdentityInfo
data IdentityInfo Source #
Information about an email identity.
See: newIdentityInfo smart constructor.
Constructors
| IdentityInfo' | |
Fields
| |
Instances
newIdentityInfo :: IdentityInfo Source #
Create a value of IdentityInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:identityType:IdentityInfo', identityInfo_identityType - The email identity type. The identity type can be one of the following:
EMAIL_ADDRESS– The identity is an email address.DOMAIN– The identity is a domain.MANAGED_DOMAIN– The identity is a domain that is managed by AWS.
$sel:identityName:IdentityInfo', identityInfo_identityName - The address or domain of the identity.
$sel:sendingEnabled:IdentityInfo', identityInfo_sendingEnabled - Indicates whether or not you can send email from the identity.
In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon Pinpoint to send email from that identity.
identityInfo_identityType :: Lens' IdentityInfo (Maybe IdentityType) Source #
The email identity type. The identity type can be one of the following:
EMAIL_ADDRESS– The identity is an email address.DOMAIN– The identity is a domain.MANAGED_DOMAIN– The identity is a domain that is managed by AWS.
identityInfo_identityName :: Lens' IdentityInfo (Maybe Text) Source #
The address or domain of the identity.
identityInfo_sendingEnabled :: Lens' IdentityInfo (Maybe Bool) Source #
Indicates whether or not you can send email from the identity.
In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon Pinpoint to send email from that identity.
InboxPlacementTrackingOption
data InboxPlacementTrackingOption Source #
An object that contains information about the inbox placement data
settings for a verified domain that’s associated with your AWS account.
This data is available only if you enabled the Deliverability dashboard
for the domain (PutDeliverabilityDashboardOption operation).
See: newInboxPlacementTrackingOption smart constructor.
Constructors
| InboxPlacementTrackingOption' | |
Instances
newInboxPlacementTrackingOption :: InboxPlacementTrackingOption Source #
Create a value of InboxPlacementTrackingOption with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:trackedIsps:InboxPlacementTrackingOption', inboxPlacementTrackingOption_trackedIsps - An array of strings, one for each major email provider that the inbox
placement data applies to.
$sel:global:InboxPlacementTrackingOption', inboxPlacementTrackingOption_global - Specifies whether inbox placement data is being tracked for the domain.
inboxPlacementTrackingOption_trackedIsps :: Lens' InboxPlacementTrackingOption (Maybe [Text]) Source #
An array of strings, one for each major email provider that the inbox placement data applies to.
inboxPlacementTrackingOption_global :: Lens' InboxPlacementTrackingOption (Maybe Bool) Source #
Specifies whether inbox placement data is being tracked for the domain.
IspPlacement
data IspPlacement Source #
An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.
See: newIspPlacement smart constructor.
Constructors
| IspPlacement' | |
Fields
| |
Instances
newIspPlacement :: IspPlacement Source #
Create a value of IspPlacement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:placementStatistics:IspPlacement', ispPlacement_placementStatistics - An object that contains inbox placement metrics for a specific email
provider.
$sel:ispName:IspPlacement', ispPlacement_ispName - The name of the email provider that the inbox placement data applies to.
ispPlacement_placementStatistics :: Lens' IspPlacement (Maybe PlacementStatistics) Source #
An object that contains inbox placement metrics for a specific email provider.
ispPlacement_ispName :: Lens' IspPlacement (Maybe Text) Source #
The name of the email provider that the inbox placement data applies to.
KinesisFirehoseDestination
data KinesisFirehoseDestination Source #
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
See: newKinesisFirehoseDestination smart constructor.
Constructors
| KinesisFirehoseDestination' | |
Fields
| |
Instances
newKinesisFirehoseDestination Source #
Arguments
| :: Text | |
| -> Text | |
| -> KinesisFirehoseDestination |
Create a value of KinesisFirehoseDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iamRoleArn:KinesisFirehoseDestination', kinesisFirehoseDestination_iamRoleArn - The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses
when sending email events to the Amazon Kinesis Data Firehose stream.
$sel:deliveryStreamArn:KinesisFirehoseDestination', kinesisFirehoseDestination_deliveryStreamArn - The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose
stream that Amazon Pinpoint sends email events to.
kinesisFirehoseDestination_iamRoleArn :: Lens' KinesisFirehoseDestination Text Source #
The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.
kinesisFirehoseDestination_deliveryStreamArn :: Lens' KinesisFirehoseDestination Text Source #
The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.
MailFromAttributes
data MailFromAttributes Source #
A list of attributes that are associated with a MAIL FROM domain.
See: newMailFromAttributes smart constructor.
Constructors
| MailFromAttributes' | |
Fields
| |
Instances
newMailFromAttributes Source #
Arguments
| :: Text | |
| -> MailFromDomainStatus | |
| -> BehaviorOnMxFailure | |
| -> MailFromAttributes |
Create a value of MailFromAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mailFromDomain:MailFromAttributes', mailFromAttributes_mailFromDomain - The name of a domain that an email identity uses as a custom MAIL FROM
domain.
$sel:mailFromDomainStatus:MailFromAttributes', mailFromAttributes_mailFromDomainStatus - The status of the MAIL FROM domain. This status can have the following
values:
PENDING– Amazon Pinpoint hasn't started searching for the MX record yet.SUCCESS– Amazon Pinpoint detected the required MX record for the MAIL FROM domain.FAILED– Amazon Pinpoint can't find the required MX record, or the record no longer exists.TEMPORARY_FAILURE– A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.
$sel:behaviorOnMxFailure:MailFromAttributes', mailFromAttributes_behaviorOnMxFailure - The action that Amazon Pinpoint to takes if it can't read the required
MX record for a custom MAIL FROM domain. When you set this value to
UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM
domain. When you set this value to RejectMessage, Amazon Pinpoint
returns a MailFromDomainNotVerified error, and doesn't attempt to
deliver the email.
These behaviors are taken when the custom MAIL FROM domain configuration
is in the Pending, Failed, and TemporaryFailure states.
mailFromAttributes_mailFromDomain :: Lens' MailFromAttributes Text Source #
The name of a domain that an email identity uses as a custom MAIL FROM domain.
mailFromAttributes_mailFromDomainStatus :: Lens' MailFromAttributes MailFromDomainStatus Source #
The status of the MAIL FROM domain. This status can have the following values:
PENDING– Amazon Pinpoint hasn't started searching for the MX record yet.SUCCESS– Amazon Pinpoint detected the required MX record for the MAIL FROM domain.FAILED– Amazon Pinpoint can't find the required MX record, or the record no longer exists.TEMPORARY_FAILURE– A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.
mailFromAttributes_behaviorOnMxFailure :: Lens' MailFromAttributes BehaviorOnMxFailure Source #
The action that Amazon Pinpoint to takes if it can't read the required
MX record for a custom MAIL FROM domain. When you set this value to
UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM
domain. When you set this value to RejectMessage, Amazon Pinpoint
returns a MailFromDomainNotVerified error, and doesn't attempt to
deliver the email.
These behaviors are taken when the custom MAIL FROM domain configuration
is in the Pending, Failed, and TemporaryFailure states.
Message
Represents the email message that you're sending. The Message object
consists of a subject line and a message body.
See: newMessage smart constructor.
Constructors
| Message' | |
Fields
| |
Instances
| Eq Message Source # | |
| Read Message Source # | |
| Show Message Source # | |
| Generic Message Source # | |
| NFData Message Source # | |
Defined in Amazonka.PinpointEmail.Types.Message | |
| Hashable Message Source # | |
Defined in Amazonka.PinpointEmail.Types.Message | |
| ToJSON Message Source # | |
Defined in Amazonka.PinpointEmail.Types.Message | |
| type Rep Message Source # | |
Defined in Amazonka.PinpointEmail.Types.Message type Rep Message = D1 ('MetaData "Message" "Amazonka.PinpointEmail.Types.Message" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "Message'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Content) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body))) | |
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:subject:Message', message_subject - The subject line of the email. The subject line can only contain 7-bit
ASCII characters. However, you can specify non-ASCII characters in the
subject line by using encoded-word syntax, as described in
RFC 2047.
$sel:body:Message', message_body - The body of the message. You can specify an HTML version of the message,
a text-only version of the message, or both.
message_subject :: Lens' Message Content Source #
The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047.
message_body :: Lens' Message Body Source #
The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.
MessageTag
data MessageTag Source #
Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.
See: newMessageTag smart constructor.
Constructors
| MessageTag' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> MessageTag |
Create a value of MessageTag with all optional fields omitted.
Use 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:MessageTag', messageTag_name - The name of the message tag. The message tag name has to meet the
following criteria:
- It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
$sel:value:MessageTag', messageTag_value - The value of the message tag. The message tag value has to meet the
following criteria:
- It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
messageTag_name :: Lens' MessageTag Text Source #
The name of the message tag. The message tag name has to meet the following criteria:
- It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
messageTag_value :: Lens' MessageTag Text Source #
The value of the message tag. The message tag value has to meet the following criteria:
- It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
OverallVolume
data OverallVolume Source #
An object that contains information about email that was sent from the selected domain.
See: newOverallVolume smart constructor.
Constructors
| OverallVolume' | |
Fields
| |
Instances
newOverallVolume :: OverallVolume Source #
Create a value of OverallVolume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainIspPlacements:OverallVolume', overallVolume_domainIspPlacements - An object that contains inbox and junk mail placement metrics for
individual email providers.
$sel:volumeStatistics:OverallVolume', overallVolume_volumeStatistics - An object that contains information about the numbers of messages that
arrived in recipients' inboxes and junk mail folders.
$sel:readRatePercent:OverallVolume', overallVolume_readRatePercent - The percentage of emails that were sent from the domain that were read
by their recipients.
overallVolume_domainIspPlacements :: Lens' OverallVolume (Maybe [DomainIspPlacement]) Source #
An object that contains inbox and junk mail placement metrics for individual email providers.
overallVolume_volumeStatistics :: Lens' OverallVolume (Maybe VolumeStatistics) Source #
An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.
overallVolume_readRatePercent :: Lens' OverallVolume (Maybe Double) Source #
The percentage of emails that were sent from the domain that were read by their recipients.
PinpointDestination
data PinpointDestination Source #
An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
See: newPinpointDestination smart constructor.
Constructors
| PinpointDestination' | |
Fields
| |
Instances
newPinpointDestination :: PinpointDestination Source #
Create a value of PinpointDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationArn:PinpointDestination', pinpointDestination_applicationArn - The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you
want to send email events to.
pinpointDestination_applicationArn :: Lens' PinpointDestination (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.
PlacementStatistics
data PlacementStatistics Source #
An object that contains inbox placement data for an email provider.
See: newPlacementStatistics smart constructor.
Constructors
| PlacementStatistics' | |
Fields
| |
Instances
newPlacementStatistics :: PlacementStatistics Source #
Create a value of PlacementStatistics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:missingPercentage:PlacementStatistics', placementStatistics_missingPercentage - The percentage of emails that didn't arrive in recipients' inboxes at
all during the predictive inbox placement test.
$sel:spamPercentage:PlacementStatistics', placementStatistics_spamPercentage - The percentage of emails that arrived in recipients' spam or junk mail
folders during the predictive inbox placement test.
$sel:spfPercentage:PlacementStatistics', placementStatistics_spfPercentage - The percentage of emails that were authenticated by using Sender Policy
Framework (SPF) during the predictive inbox placement test.
$sel:dkimPercentage:PlacementStatistics', placementStatistics_dkimPercentage - The percentage of emails that were authenticated by using DomainKeys
Identified Mail (DKIM) during the predictive inbox placement test.
$sel:inboxPercentage:PlacementStatistics', placementStatistics_inboxPercentage - The percentage of emails that arrived in recipients' inboxes during the
predictive inbox placement test.
placementStatistics_missingPercentage :: Lens' PlacementStatistics (Maybe Double) Source #
The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.
placementStatistics_spamPercentage :: Lens' PlacementStatistics (Maybe Double) Source #
The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.
placementStatistics_spfPercentage :: Lens' PlacementStatistics (Maybe Double) Source #
The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.
placementStatistics_dkimPercentage :: Lens' PlacementStatistics (Maybe Double) Source #
The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.
placementStatistics_inboxPercentage :: Lens' PlacementStatistics (Maybe Double) Source #
The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.
RawMessage
data RawMessage Source #
The raw email message.
See: newRawMessage smart constructor.
Constructors
| RawMessage' | |
Fields
| |
Instances
Arguments
| :: ByteString | |
| -> RawMessage |
Create a value of RawMessage with all optional fields omitted.
Use 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':RawMessage', rawMessage_data - The raw email message. The message has to meet the following criteria:
- The message has to contain a header and a body, separated by one blank line.
- All of the required header fields must be present in the message.
- Each part of a multipart MIME message must be formatted properly.
- Attachments must be in a file format that Amazon Pinpoint supports.
- The entire message must be Base64 encoded.
- If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
- The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.--
- - Note: This
Lensautomatically encodes and decodes Base64 data. - - The underlying isomorphism will encode to Base64 representation during
- - serialisation, and decode from Base64 representation during deserialisation.
- - This
Lensaccepts and returns only raw unencoded data.
rawMessage_data :: Lens' RawMessage ByteString Source #
The raw email message. The message has to meet the following criteria:
- The message has to contain a header and a body, separated by one blank line.
- All of the required header fields must be present in the message.
- Each part of a multipart MIME message must be formatted properly.
- Attachments must be in a file format that Amazon Pinpoint supports.
- The entire message must be Base64 encoded.
- If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
- The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.--
- - Note: This
Lensautomatically encodes and decodes Base64 data. - - The underlying isomorphism will encode to Base64 representation during
- - serialisation, and decode from Base64 representation during deserialisation.
- - This
Lensaccepts and returns only raw unencoded data.
ReputationOptions
data ReputationOptions Source #
Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.
See: newReputationOptions smart constructor.
Constructors
| ReputationOptions' | |
Fields
| |
Instances
newReputationOptions :: ReputationOptions Source #
Create a value of ReputationOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastFreshStart:ReputationOptions', reputationOptions_lastFreshStart - The date and time (in Unix time) when the reputation metrics were last
given a fresh start. When your account is given a fresh start, your
reputation metrics are calculated starting from the date of the fresh
start.
$sel:reputationMetricsEnabled:ReputationOptions', reputationOptions_reputationMetricsEnabled - If true, tracking of reputation metrics is enabled for the
configuration set. If false, tracking of reputation metrics is
disabled for the configuration set.
reputationOptions_lastFreshStart :: Lens' ReputationOptions (Maybe UTCTime) Source #
The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.
reputationOptions_reputationMetricsEnabled :: Lens' ReputationOptions (Maybe Bool) Source #
If true, tracking of reputation metrics is enabled for the
configuration set. If false, tracking of reputation metrics is
disabled for the configuration set.
SendQuota
An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.
See: newSendQuota smart constructor.
Constructors
| SendQuota' | |
Fields
| |
Instances
| Eq SendQuota Source # | |
| Read SendQuota Source # | |
| Show SendQuota Source # | |
| Generic SendQuota Source # | |
| NFData SendQuota Source # | |
Defined in Amazonka.PinpointEmail.Types.SendQuota | |
| Hashable SendQuota Source # | |
Defined in Amazonka.PinpointEmail.Types.SendQuota | |
| FromJSON SendQuota Source # | |
| type Rep SendQuota Source # | |
Defined in Amazonka.PinpointEmail.Types.SendQuota type Rep SendQuota = D1 ('MetaData "SendQuota" "Amazonka.PinpointEmail.Types.SendQuota" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "SendQuota'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxSendRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "sentLast24Hours") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "max24HourSend") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))) | |
newSendQuota :: SendQuota Source #
Create a value of SendQuota with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxSendRate:SendQuota', sendQuota_maxSendRate - The maximum number of emails that you can send per second in the current
AWS Region. This value is also called your maximum sending rate or
your maximum TPS (transactions per second) rate.
$sel:sentLast24Hours:SendQuota', sendQuota_sentLast24Hours - The number of emails sent from your Amazon Pinpoint account in the
current AWS Region over the past 24 hours.
$sel:max24HourSend:SendQuota', sendQuota_max24HourSend - The maximum number of emails that you can send in the current AWS Region
over a 24-hour period. This value is also called your sending quota.
sendQuota_maxSendRate :: Lens' SendQuota (Maybe Double) Source #
The maximum number of emails that you can send per second in the current AWS Region. This value is also called your maximum sending rate or your maximum TPS (transactions per second) rate.
sendQuota_sentLast24Hours :: Lens' SendQuota (Maybe Double) Source #
The number of emails sent from your Amazon Pinpoint account in the current AWS Region over the past 24 hours.
sendQuota_max24HourSend :: Lens' SendQuota (Maybe Double) Source #
The maximum number of emails that you can send in the current AWS Region over a 24-hour period. This value is also called your sending quota.
SendingOptions
data SendingOptions Source #
Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.
See: newSendingOptions smart constructor.
Constructors
| SendingOptions' | |
Fields
| |
Instances
newSendingOptions :: SendingOptions Source #
Create a value of SendingOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sendingEnabled:SendingOptions', sendingOptions_sendingEnabled - If true, email sending is enabled for the configuration set. If
false, email sending is disabled for the configuration set.
sendingOptions_sendingEnabled :: Lens' SendingOptions (Maybe Bool) Source #
If true, email sending is enabled for the configuration set. If
false, email sending is disabled for the configuration set.
SnsDestination
data SnsDestination Source #
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
See: newSnsDestination smart constructor.
Constructors
| SnsDestination' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> SnsDestination |
Create a value of SnsDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:topicArn:SnsDestination', snsDestination_topicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to
publish email events to. For more information about Amazon SNS topics,
see the
Amazon SNS Developer Guide.
snsDestination_topicArn :: Lens' SnsDestination Text Source #
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
Tag
An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
- Tag keys and values are case sensitive.
- For each associated resource, each tag key must be unique and it can have only one value.
- The
aws:prefix is reserved for use by AWS; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource. - You can associate tags with public or shared resources, but the tags are available only for your AWS account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified AWS Region for your AWS account.
See: newTag smart constructor.
Constructors
| Tag' | |
Fields
| |
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.PinpointEmail.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.PinpointEmail.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.PinpointEmail.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.PinpointEmail.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.PinpointEmail.Types.Tag" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - One part of a key-value pair that defines a tag. The maximum length of a
tag key is 128 characters. The minimum length is 1 character.
$sel:value:Tag', tag_value - The optional part of a key-value pair that defines a tag. The maximum
length of a tag value is 256 characters. The minimum length is 0
characters. If you don’t want a resource to have a specific tag value,
don’t specify a value for this parameter. Amazon Pinpoint will set the
value to an empty string.
tag_key :: Lens' Tag Text Source #
One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.
tag_value :: Lens' Tag Text Source #
The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.
Template
See: newTemplate smart constructor.
Constructors
| Template' | |
Fields
| |
Instances
| Eq Template Source # | |
| Read Template Source # | |
| Show Template Source # | |
| Generic Template Source # | |
| NFData Template Source # | |
Defined in Amazonka.PinpointEmail.Types.Template | |
| Hashable Template Source # | |
Defined in Amazonka.PinpointEmail.Types.Template | |
| ToJSON Template Source # | |
Defined in Amazonka.PinpointEmail.Types.Template | |
| type Rep Template Source # | |
Defined in Amazonka.PinpointEmail.Types.Template type Rep Template = D1 ('MetaData "Template" "Amazonka.PinpointEmail.Types.Template" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "Template'" 'PrefixI 'True) (S1 ('MetaSel ('Just "templateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateData") '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:templateArn:Template', template_templateArn - The Amazon Resource Name (ARN) of the template.
$sel:templateData:Template', template_templateData - An object that defines the values to use for message variables in the
template. This object is a set of key-value pairs. Each key defines a
message variable in the template. The corresponding value defines the
value to use for that variable.
template_templateArn :: Lens' Template (Maybe Text) Source #
The Amazon Resource Name (ARN) of the template.
template_templateData :: Lens' Template (Maybe Text) Source #
An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.
TrackingOptions
data TrackingOptions Source #
An object that defines the tracking options for a configuration set. When you use Amazon Pinpoint to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.
These images and links include references to a domain operated by AWS. You can optionally configure Amazon Pinpoint to use a domain that you operate for these images and links.
See: newTrackingOptions smart constructor.
Constructors
| TrackingOptions' | |
Fields
| |
Instances
Create a value of TrackingOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customRedirectDomain:TrackingOptions', trackingOptions_customRedirectDomain - The domain that you want to use for tracking open and click events.
trackingOptions_customRedirectDomain :: Lens' TrackingOptions Text Source #
The domain that you want to use for tracking open and click events.
VolumeStatistics
data VolumeStatistics Source #
An object that contains information about the amount of email that was delivered to recipients.
See: newVolumeStatistics smart constructor.
Constructors
| VolumeStatistics' | |
Fields
| |
Instances
newVolumeStatistics :: VolumeStatistics Source #
Create a value of VolumeStatistics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inboxRawCount:VolumeStatistics', volumeStatistics_inboxRawCount - The total number of emails that arrived in recipients' inboxes.
$sel:projectedSpam:VolumeStatistics', volumeStatistics_projectedSpam - An estimate of the percentage of emails sent from the current domain
that will arrive in recipients' spam or junk mail folders.
$sel:projectedInbox:VolumeStatistics', volumeStatistics_projectedInbox - An estimate of the percentage of emails sent from the current domain
that will arrive in recipients' inboxes.
$sel:spamRawCount:VolumeStatistics', volumeStatistics_spamRawCount - The total number of emails that arrived in recipients' spam or junk
mail folders.
volumeStatistics_inboxRawCount :: Lens' VolumeStatistics (Maybe Integer) Source #
The total number of emails that arrived in recipients' inboxes.
volumeStatistics_projectedSpam :: Lens' VolumeStatistics (Maybe Integer) Source #
An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders.
volumeStatistics_projectedInbox :: Lens' VolumeStatistics (Maybe Integer) Source #
An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes.
volumeStatistics_spamRawCount :: Lens' VolumeStatistics (Maybe Integer) Source #
The total number of emails that arrived in recipients' spam or junk mail folders.