| 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
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- GetConfigurationSet
- PutConfigurationSetTrackingOptions
- PutEmailIdentityDkimAttributes
- PutConfigurationSetDeliveryOptions
- ListDedicatedIpPools (Paginated)
- GetDomainDeliverabilityCampaign
- GetDedicatedIps (Paginated)
- PutConfigurationSetSendingOptions
- CreateDedicatedIpPool
- ListTagsForResource
- PutEmailIdentityFeedbackAttributes
- PutConfigurationSetReputationOptions
- PutDedicatedIpInPool
- PutAccountSendingAttributes
- UpdateConfigurationSetEventDestination
- DeleteConfigurationSetEventDestination
- ListConfigurationSets (Paginated)
- DeleteEmailIdentity
- DeleteConfigurationSet
- CreateEmailIdentity
- GetBlacklistReports
- ListEmailIdentities (Paginated)
- GetDedicatedIp
- GetEmailIdentity
- GetConfigurationSetEventDestinations
- GetAccount
- DeleteDedicatedIpPool
- GetDomainStatisticsReport
- GetDeliverabilityDashboardOptions
- ListDomainDeliverabilityCampaigns
- TagResource
- SendEmail
- PutDedicatedIpWarmupAttributes
- UntagResource
- CreateDeliverabilityTestReport
- PutEmailIdentityMailFromAttributes
- CreateConfigurationSetEventDestination
- ListDeliverabilityTestReports (Paginated)
- CreateConfigurationSet
- GetDeliverabilityTestReport
- PutDeliverabilityDashboardOption
- PutAccountDedicatedIpWarmupAttributes
- Types
- 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
Derived from API version 2018-07-26 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Pinpoint Email Service
Welcome to the Amazon Pinpoint Email API Reference. This guide provides information about the Amazon Pinpoint Email API (version 1.0), including supported operations, data types, parameters, and schemas.
Amazon Pinpoint is an AWS service that you can use to engage with your customers across multiple messaging channels. You can use Amazon Pinpoint to send email, SMS text messages, voice messages, and push notifications. The Amazon Pinpoint Email API provides programmatic access to options that are unique to the email channel and supplement the options provided by the Amazon Pinpoint API.
If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides information about key topics such as Amazon Pinpoint integration with other AWS services and the limits that apply to using the service.
The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Service Endpoints in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions in the Amazon Web Services General Reference.
In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.
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
- data GetConfigurationSet = GetConfigurationSet' Text
- newGetConfigurationSet :: Text -> GetConfigurationSet
- data GetConfigurationSetResponse = GetConfigurationSetResponse' (Maybe SendingOptions) (Maybe Text) (Maybe DeliveryOptions) (Maybe TrackingOptions) (Maybe ReputationOptions) (Maybe [Tag]) Int
- newGetConfigurationSetResponse :: Int -> GetConfigurationSetResponse
- data PutConfigurationSetTrackingOptions = PutConfigurationSetTrackingOptions' (Maybe Text) Text
- newPutConfigurationSetTrackingOptions :: Text -> PutConfigurationSetTrackingOptions
- data PutConfigurationSetTrackingOptionsResponse = PutConfigurationSetTrackingOptionsResponse' Int
- newPutConfigurationSetTrackingOptionsResponse :: Int -> PutConfigurationSetTrackingOptionsResponse
- data PutEmailIdentityDkimAttributes = PutEmailIdentityDkimAttributes' (Maybe Bool) Text
- newPutEmailIdentityDkimAttributes :: Text -> PutEmailIdentityDkimAttributes
- data PutEmailIdentityDkimAttributesResponse = PutEmailIdentityDkimAttributesResponse' Int
- newPutEmailIdentityDkimAttributesResponse :: Int -> PutEmailIdentityDkimAttributesResponse
- data PutConfigurationSetDeliveryOptions = PutConfigurationSetDeliveryOptions' (Maybe Text) (Maybe TlsPolicy) Text
- newPutConfigurationSetDeliveryOptions :: Text -> PutConfigurationSetDeliveryOptions
- data PutConfigurationSetDeliveryOptionsResponse = PutConfigurationSetDeliveryOptionsResponse' Int
- newPutConfigurationSetDeliveryOptionsResponse :: Int -> PutConfigurationSetDeliveryOptionsResponse
- data ListDedicatedIpPools = ListDedicatedIpPools' (Maybe Text) (Maybe Int)
- newListDedicatedIpPools :: ListDedicatedIpPools
- data ListDedicatedIpPoolsResponse = ListDedicatedIpPoolsResponse' (Maybe [Text]) (Maybe Text) Int
- newListDedicatedIpPoolsResponse :: Int -> ListDedicatedIpPoolsResponse
- data GetDomainDeliverabilityCampaign = GetDomainDeliverabilityCampaign' Text
- newGetDomainDeliverabilityCampaign :: Text -> GetDomainDeliverabilityCampaign
- data GetDomainDeliverabilityCampaignResponse = GetDomainDeliverabilityCampaignResponse' Int DomainDeliverabilityCampaign
- newGetDomainDeliverabilityCampaignResponse :: Int -> DomainDeliverabilityCampaign -> GetDomainDeliverabilityCampaignResponse
- data GetDedicatedIps = GetDedicatedIps' (Maybe Text) (Maybe Text) (Maybe Int)
- newGetDedicatedIps :: GetDedicatedIps
- data GetDedicatedIpsResponse = GetDedicatedIpsResponse' (Maybe Text) (Maybe [DedicatedIp]) Int
- newGetDedicatedIpsResponse :: Int -> GetDedicatedIpsResponse
- data PutConfigurationSetSendingOptions = PutConfigurationSetSendingOptions' (Maybe Bool) Text
- newPutConfigurationSetSendingOptions :: Text -> PutConfigurationSetSendingOptions
- data PutConfigurationSetSendingOptionsResponse = PutConfigurationSetSendingOptionsResponse' Int
- newPutConfigurationSetSendingOptionsResponse :: Int -> PutConfigurationSetSendingOptionsResponse
- data CreateDedicatedIpPool = CreateDedicatedIpPool' (Maybe [Tag]) Text
- newCreateDedicatedIpPool :: Text -> CreateDedicatedIpPool
- data CreateDedicatedIpPoolResponse = CreateDedicatedIpPoolResponse' Int
- newCreateDedicatedIpPoolResponse :: Int -> CreateDedicatedIpPoolResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' Int [Tag]
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data PutEmailIdentityFeedbackAttributes = PutEmailIdentityFeedbackAttributes' (Maybe Bool) Text
- newPutEmailIdentityFeedbackAttributes :: Text -> PutEmailIdentityFeedbackAttributes
- data PutEmailIdentityFeedbackAttributesResponse = PutEmailIdentityFeedbackAttributesResponse' Int
- newPutEmailIdentityFeedbackAttributesResponse :: Int -> PutEmailIdentityFeedbackAttributesResponse
- data PutConfigurationSetReputationOptions = PutConfigurationSetReputationOptions' (Maybe Bool) Text
- newPutConfigurationSetReputationOptions :: Text -> PutConfigurationSetReputationOptions
- data PutConfigurationSetReputationOptionsResponse = PutConfigurationSetReputationOptionsResponse' Int
- newPutConfigurationSetReputationOptionsResponse :: Int -> PutConfigurationSetReputationOptionsResponse
- data PutDedicatedIpInPool = PutDedicatedIpInPool' Text Text
- newPutDedicatedIpInPool :: Text -> Text -> PutDedicatedIpInPool
- data PutDedicatedIpInPoolResponse = PutDedicatedIpInPoolResponse' Int
- newPutDedicatedIpInPoolResponse :: Int -> PutDedicatedIpInPoolResponse
- data PutAccountSendingAttributes = PutAccountSendingAttributes' (Maybe Bool)
- newPutAccountSendingAttributes :: PutAccountSendingAttributes
- data PutAccountSendingAttributesResponse = PutAccountSendingAttributesResponse' Int
- newPutAccountSendingAttributesResponse :: Int -> PutAccountSendingAttributesResponse
- data UpdateConfigurationSetEventDestination = UpdateConfigurationSetEventDestination' Text Text EventDestinationDefinition
- newUpdateConfigurationSetEventDestination :: Text -> Text -> EventDestinationDefinition -> UpdateConfigurationSetEventDestination
- data UpdateConfigurationSetEventDestinationResponse = UpdateConfigurationSetEventDestinationResponse' Int
- newUpdateConfigurationSetEventDestinationResponse :: Int -> UpdateConfigurationSetEventDestinationResponse
- data DeleteConfigurationSetEventDestination = DeleteConfigurationSetEventDestination' Text Text
- newDeleteConfigurationSetEventDestination :: Text -> Text -> DeleteConfigurationSetEventDestination
- data DeleteConfigurationSetEventDestinationResponse = DeleteConfigurationSetEventDestinationResponse' Int
- newDeleteConfigurationSetEventDestinationResponse :: Int -> DeleteConfigurationSetEventDestinationResponse
- data ListConfigurationSets = ListConfigurationSets' (Maybe Text) (Maybe Int)
- newListConfigurationSets :: ListConfigurationSets
- data ListConfigurationSetsResponse = ListConfigurationSetsResponse' (Maybe [Text]) (Maybe Text) Int
- newListConfigurationSetsResponse :: Int -> ListConfigurationSetsResponse
- data DeleteEmailIdentity = DeleteEmailIdentity' Text
- newDeleteEmailIdentity :: Text -> DeleteEmailIdentity
- data DeleteEmailIdentityResponse = DeleteEmailIdentityResponse' Int
- newDeleteEmailIdentityResponse :: Int -> DeleteEmailIdentityResponse
- data DeleteConfigurationSet = DeleteConfigurationSet' Text
- newDeleteConfigurationSet :: Text -> DeleteConfigurationSet
- data DeleteConfigurationSetResponse = DeleteConfigurationSetResponse' Int
- newDeleteConfigurationSetResponse :: Int -> DeleteConfigurationSetResponse
- data CreateEmailIdentity = CreateEmailIdentity' (Maybe [Tag]) Text
- newCreateEmailIdentity :: Text -> CreateEmailIdentity
- data CreateEmailIdentityResponse = CreateEmailIdentityResponse' (Maybe DkimAttributes) (Maybe Bool) (Maybe IdentityType) Int
- newCreateEmailIdentityResponse :: Int -> CreateEmailIdentityResponse
- data GetBlacklistReports = GetBlacklistReports' [Text]
- newGetBlacklistReports :: GetBlacklistReports
- data GetBlacklistReportsResponse = GetBlacklistReportsResponse' Int (HashMap Text [BlacklistEntry])
- newGetBlacklistReportsResponse :: Int -> GetBlacklistReportsResponse
- data ListEmailIdentities = ListEmailIdentities' (Maybe Text) (Maybe Int)
- newListEmailIdentities :: ListEmailIdentities
- data ListEmailIdentitiesResponse = ListEmailIdentitiesResponse' (Maybe Text) (Maybe [IdentityInfo]) Int
- newListEmailIdentitiesResponse :: Int -> ListEmailIdentitiesResponse
- data GetDedicatedIp = GetDedicatedIp' Text
- newGetDedicatedIp :: Text -> GetDedicatedIp
- data GetDedicatedIpResponse = GetDedicatedIpResponse' (Maybe DedicatedIp) Int
- newGetDedicatedIpResponse :: Int -> GetDedicatedIpResponse
- data GetEmailIdentity = GetEmailIdentity' Text
- newGetEmailIdentity :: Text -> GetEmailIdentity
- data GetEmailIdentityResponse = GetEmailIdentityResponse' (Maybe DkimAttributes) (Maybe Bool) (Maybe IdentityType) (Maybe MailFromAttributes) (Maybe Bool) (Maybe [Tag]) Int
- newGetEmailIdentityResponse :: Int -> GetEmailIdentityResponse
- data GetConfigurationSetEventDestinations = GetConfigurationSetEventDestinations' Text
- newGetConfigurationSetEventDestinations :: Text -> GetConfigurationSetEventDestinations
- data GetConfigurationSetEventDestinationsResponse = GetConfigurationSetEventDestinationsResponse' (Maybe [EventDestination]) Int
- newGetConfigurationSetEventDestinationsResponse :: Int -> GetConfigurationSetEventDestinationsResponse
- data GetAccount = GetAccount' {
- newGetAccount :: GetAccount
- data GetAccountResponse = GetAccountResponse' (Maybe Text) (Maybe Bool) (Maybe SendQuota) (Maybe Bool) (Maybe Bool) Int
- newGetAccountResponse :: Int -> GetAccountResponse
- data DeleteDedicatedIpPool = DeleteDedicatedIpPool' Text
- newDeleteDedicatedIpPool :: Text -> DeleteDedicatedIpPool
- data DeleteDedicatedIpPoolResponse = DeleteDedicatedIpPoolResponse' Int
- newDeleteDedicatedIpPoolResponse :: Int -> DeleteDedicatedIpPoolResponse
- data GetDomainStatisticsReport = GetDomainStatisticsReport' Text POSIX POSIX
- newGetDomainStatisticsReport :: Text -> UTCTime -> UTCTime -> GetDomainStatisticsReport
- data GetDomainStatisticsReportResponse = GetDomainStatisticsReportResponse' Int OverallVolume [DailyVolume]
- newGetDomainStatisticsReportResponse :: Int -> OverallVolume -> GetDomainStatisticsReportResponse
- data GetDeliverabilityDashboardOptions = GetDeliverabilityDashboardOptions' {
- newGetDeliverabilityDashboardOptions :: GetDeliverabilityDashboardOptions
- data GetDeliverabilityDashboardOptionsResponse = GetDeliverabilityDashboardOptionsResponse' (Maybe DeliverabilityDashboardAccountStatus) (Maybe POSIX) (Maybe [DomainDeliverabilityTrackingOption]) (Maybe [DomainDeliverabilityTrackingOption]) Int Bool
- newGetDeliverabilityDashboardOptionsResponse :: Int -> Bool -> GetDeliverabilityDashboardOptionsResponse
- data ListDomainDeliverabilityCampaigns = ListDomainDeliverabilityCampaigns' (Maybe Text) (Maybe Int) POSIX POSIX Text
- newListDomainDeliverabilityCampaigns :: UTCTime -> UTCTime -> Text -> ListDomainDeliverabilityCampaigns
- data ListDomainDeliverabilityCampaignsResponse = ListDomainDeliverabilityCampaignsResponse' (Maybe Text) Int [DomainDeliverabilityCampaign]
- newListDomainDeliverabilityCampaignsResponse :: Int -> ListDomainDeliverabilityCampaignsResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data SendEmail = SendEmail' (Maybe Text) (Maybe Text) (Maybe [MessageTag]) (Maybe Text) (Maybe [Text]) Destination EmailContent
- newSendEmail :: Destination -> EmailContent -> SendEmail
- data SendEmailResponse = SendEmailResponse' (Maybe Text) Int
- newSendEmailResponse :: Int -> SendEmailResponse
- data PutDedicatedIpWarmupAttributes = PutDedicatedIpWarmupAttributes' Text Int
- newPutDedicatedIpWarmupAttributes :: Text -> Int -> PutDedicatedIpWarmupAttributes
- data PutDedicatedIpWarmupAttributesResponse = PutDedicatedIpWarmupAttributesResponse' Int
- newPutDedicatedIpWarmupAttributesResponse :: Int -> PutDedicatedIpWarmupAttributesResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data CreateDeliverabilityTestReport = CreateDeliverabilityTestReport' (Maybe Text) (Maybe [Tag]) Text EmailContent
- newCreateDeliverabilityTestReport :: Text -> EmailContent -> CreateDeliverabilityTestReport
- data CreateDeliverabilityTestReportResponse = CreateDeliverabilityTestReportResponse' Int Text DeliverabilityTestStatus
- newCreateDeliverabilityTestReportResponse :: Int -> Text -> DeliverabilityTestStatus -> CreateDeliverabilityTestReportResponse
- data PutEmailIdentityMailFromAttributes = PutEmailIdentityMailFromAttributes' (Maybe Text) (Maybe BehaviorOnMxFailure) Text
- newPutEmailIdentityMailFromAttributes :: Text -> PutEmailIdentityMailFromAttributes
- data PutEmailIdentityMailFromAttributesResponse = PutEmailIdentityMailFromAttributesResponse' Int
- newPutEmailIdentityMailFromAttributesResponse :: Int -> PutEmailIdentityMailFromAttributesResponse
- data CreateConfigurationSetEventDestination = CreateConfigurationSetEventDestination' Text Text EventDestinationDefinition
- newCreateConfigurationSetEventDestination :: Text -> Text -> EventDestinationDefinition -> CreateConfigurationSetEventDestination
- data CreateConfigurationSetEventDestinationResponse = CreateConfigurationSetEventDestinationResponse' Int
- newCreateConfigurationSetEventDestinationResponse :: Int -> CreateConfigurationSetEventDestinationResponse
- data ListDeliverabilityTestReports = ListDeliverabilityTestReports' (Maybe Text) (Maybe Int)
- newListDeliverabilityTestReports :: ListDeliverabilityTestReports
- data ListDeliverabilityTestReportsResponse = ListDeliverabilityTestReportsResponse' (Maybe Text) Int [DeliverabilityTestReport]
- newListDeliverabilityTestReportsResponse :: Int -> ListDeliverabilityTestReportsResponse
- data CreateConfigurationSet = CreateConfigurationSet' (Maybe SendingOptions) (Maybe DeliveryOptions) (Maybe TrackingOptions) (Maybe ReputationOptions) (Maybe [Tag]) Text
- newCreateConfigurationSet :: Text -> CreateConfigurationSet
- data CreateConfigurationSetResponse = CreateConfigurationSetResponse' Int
- newCreateConfigurationSetResponse :: Int -> CreateConfigurationSetResponse
- data GetDeliverabilityTestReport = GetDeliverabilityTestReport' Text
- newGetDeliverabilityTestReport :: Text -> GetDeliverabilityTestReport
- data GetDeliverabilityTestReportResponse = GetDeliverabilityTestReportResponse' (Maybe Text) (Maybe [Tag]) Int DeliverabilityTestReport PlacementStatistics [IspPlacement]
- newGetDeliverabilityTestReportResponse :: Int -> DeliverabilityTestReport -> PlacementStatistics -> GetDeliverabilityTestReportResponse
- data PutDeliverabilityDashboardOption = PutDeliverabilityDashboardOption' (Maybe [DomainDeliverabilityTrackingOption]) Bool
- newPutDeliverabilityDashboardOption :: Bool -> PutDeliverabilityDashboardOption
- data PutDeliverabilityDashboardOptionResponse = PutDeliverabilityDashboardOptionResponse' Int
- newPutDeliverabilityDashboardOptionResponse :: Int -> PutDeliverabilityDashboardOptionResponse
- data PutAccountDedicatedIpWarmupAttributes = PutAccountDedicatedIpWarmupAttributes' (Maybe Bool)
- newPutAccountDedicatedIpWarmupAttributes :: PutAccountDedicatedIpWarmupAttributes
- data PutAccountDedicatedIpWarmupAttributesResponse = PutAccountDedicatedIpWarmupAttributesResponse' Int
- newPutAccountDedicatedIpWarmupAttributesResponse :: Int -> PutAccountDedicatedIpWarmupAttributesResponse
- 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' (Maybe POSIX) (Maybe Text) (Maybe Text)
- newBlacklistEntry :: BlacklistEntry
- data Body = Body' (Maybe Content) (Maybe Content)
- newBody :: Body
- data CloudWatchDestination = CloudWatchDestination' [CloudWatchDimensionConfiguration]
- newCloudWatchDestination :: CloudWatchDestination
- data CloudWatchDimensionConfiguration = CloudWatchDimensionConfiguration' Text DimensionValueSource Text
- newCloudWatchDimensionConfiguration :: Text -> DimensionValueSource -> Text -> CloudWatchDimensionConfiguration
- data Content = Content' (Maybe Text) Text
- newContent :: Text -> Content
- data DailyVolume = DailyVolume' (Maybe [DomainIspPlacement]) (Maybe POSIX) (Maybe VolumeStatistics)
- newDailyVolume :: DailyVolume
- data DedicatedIp = DedicatedIp' (Maybe Text) Text WarmupStatus Int
- newDedicatedIp :: Text -> WarmupStatus -> Int -> DedicatedIp
- data DeliverabilityTestReport = DeliverabilityTestReport' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe DeliverabilityTestStatus)
- newDeliverabilityTestReport :: DeliverabilityTestReport
- data DeliveryOptions = DeliveryOptions' (Maybe Text) (Maybe TlsPolicy)
- newDeliveryOptions :: DeliveryOptions
- data Destination = Destination' (Maybe [Text]) (Maybe [Text]) (Maybe [Text])
- newDestination :: Destination
- data DkimAttributes = DkimAttributes' (Maybe DkimStatus) (Maybe [Text]) (Maybe Bool)
- newDkimAttributes :: DkimAttributes
- data DomainDeliverabilityCampaign = DomainDeliverabilityCampaign' (Maybe Integer) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Double) (Maybe Text) (Maybe [Text]) (Maybe POSIX) (Maybe Integer) (Maybe Double) (Maybe Integer) (Maybe Text) (Maybe Double) (Maybe POSIX)
- newDomainDeliverabilityCampaign :: DomainDeliverabilityCampaign
- data DomainDeliverabilityTrackingOption = DomainDeliverabilityTrackingOption' (Maybe Text) (Maybe POSIX) (Maybe InboxPlacementTrackingOption)
- newDomainDeliverabilityTrackingOption :: DomainDeliverabilityTrackingOption
- data DomainIspPlacement = DomainIspPlacement' (Maybe Double) (Maybe Integer) (Maybe Text) (Maybe Double) (Maybe Integer)
- newDomainIspPlacement :: DomainIspPlacement
- data EmailContent = EmailContent' (Maybe RawMessage) (Maybe Message) (Maybe Template)
- newEmailContent :: EmailContent
- data EventDestination = EventDestination' (Maybe PinpointDestination) (Maybe Bool) (Maybe KinesisFirehoseDestination) (Maybe CloudWatchDestination) (Maybe SnsDestination) Text [EventType]
- newEventDestination :: Text -> EventDestination
- data EventDestinationDefinition = EventDestinationDefinition' (Maybe [EventType]) (Maybe PinpointDestination) (Maybe Bool) (Maybe KinesisFirehoseDestination) (Maybe CloudWatchDestination) (Maybe SnsDestination)
- newEventDestinationDefinition :: EventDestinationDefinition
- data IdentityInfo = IdentityInfo' (Maybe IdentityType) (Maybe Text) (Maybe Bool)
- newIdentityInfo :: IdentityInfo
- data InboxPlacementTrackingOption = InboxPlacementTrackingOption' (Maybe [Text]) (Maybe Bool)
- newInboxPlacementTrackingOption :: InboxPlacementTrackingOption
- data IspPlacement = IspPlacement' (Maybe PlacementStatistics) (Maybe Text)
- newIspPlacement :: IspPlacement
- data KinesisFirehoseDestination = KinesisFirehoseDestination' Text Text
- newKinesisFirehoseDestination :: Text -> Text -> KinesisFirehoseDestination
- data MailFromAttributes = MailFromAttributes' Text MailFromDomainStatus BehaviorOnMxFailure
- newMailFromAttributes :: Text -> MailFromDomainStatus -> BehaviorOnMxFailure -> MailFromAttributes
- data Message = Message' Content Body
- newMessage :: Content -> Body -> Message
- data MessageTag = MessageTag' Text Text
- newMessageTag :: Text -> Text -> MessageTag
- data OverallVolume = OverallVolume' (Maybe [DomainIspPlacement]) (Maybe VolumeStatistics) (Maybe Double)
- newOverallVolume :: OverallVolume
- data PinpointDestination = PinpointDestination' (Maybe Text)
- newPinpointDestination :: PinpointDestination
- data PlacementStatistics = PlacementStatistics' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double)
- newPlacementStatistics :: PlacementStatistics
- data RawMessage = RawMessage' Base64
- newRawMessage :: ByteString -> RawMessage
- data ReputationOptions = ReputationOptions' (Maybe POSIX) (Maybe Bool)
- newReputationOptions :: ReputationOptions
- data SendQuota = SendQuota' (Maybe Double) (Maybe Double) (Maybe Double)
- newSendQuota :: SendQuota
- data SendingOptions = SendingOptions' (Maybe Bool)
- newSendingOptions :: SendingOptions
- data SnsDestination = SnsDestination' Text
- newSnsDestination :: Text -> SnsDestination
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data Template = Template' (Maybe Text) (Maybe Text)
- newTemplate :: Template
- data TrackingOptions = TrackingOptions' Text
- newTrackingOptions :: Text -> TrackingOptions
- data VolumeStatistics = VolumeStatistics' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newVolumeStatistics :: VolumeStatistics
Service Configuration
defaultService :: Service Source #
API version 2018-07-26 of the Amazon Pinpoint Email Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by PinpointEmail.
MessageRejected
_MessageRejected :: AsError a => Getting (First ServiceError) a ServiceError Source #
The message can't be sent because it contains invalid content.
MailFromDomainNotVerifiedException
_MailFromDomainNotVerifiedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The message can't be sent because the sending domain isn't verified.
NotFoundException
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource you attempted to access doesn't exist.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Too many requests have been made to the operation.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is being modified by another operation or thread.
AccountSuspendedException
_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
_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
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input you provided is invalid.
AlreadyExistsException
_AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource specified in your request already exists.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There are too many instances of the specified resource type.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
GetConfigurationSet
data GetConfigurationSet Source #
A request to obtain information about a configuration set.
See: newGetConfigurationSet smart constructor.
Constructors
| GetConfigurationSet' Text |
Instances
newGetConfigurationSet Source #
Create a value of GetConfigurationSet 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:configurationSetName:GetConfigurationSet', getConfigurationSet_configurationSetName - The name of the configuration set that you want to obtain more
information about.
data GetConfigurationSetResponse Source #
Information about a configuration set.
See: newGetConfigurationSetResponse smart constructor.
Constructors
| GetConfigurationSetResponse' (Maybe SendingOptions) (Maybe Text) (Maybe DeliveryOptions) (Maybe TrackingOptions) (Maybe ReputationOptions) (Maybe [Tag]) Int |
Instances
newGetConfigurationSetResponse Source #
Create a value of GetConfigurationSetResponse 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:sendingOptions:GetConfigurationSetResponse', getConfigurationSetResponse_sendingOptions - An object that defines whether or not Amazon Pinpoint can send email
that you send using the configuration set.
$sel:configurationSetName:GetConfigurationSet', getConfigurationSetResponse_configurationSetName - The name of the configuration set.
$sel:deliveryOptions:GetConfigurationSetResponse', getConfigurationSetResponse_deliveryOptions - An object that defines the dedicated IP pool that is used to send emails
that you send using the configuration set.
$sel:trackingOptions:GetConfigurationSetResponse', getConfigurationSetResponse_trackingOptions - An object that defines the open and click tracking options for emails
that you send using the configuration set.
$sel:reputationOptions:GetConfigurationSetResponse', getConfigurationSetResponse_reputationOptions - An object that defines whether or not Amazon Pinpoint collects
reputation metrics for the emails that you send that use the
configuration set.
$sel:tags:GetConfigurationSetResponse', getConfigurationSetResponse_tags - An array of objects that define the tags (keys and values) that are
associated with the configuration set.
$sel:httpStatus:GetConfigurationSetResponse', getConfigurationSetResponse_httpStatus - The response's http status code.
PutConfigurationSetTrackingOptions
data PutConfigurationSetTrackingOptions Source #
A request to add a custom domain for tracking open and click events to a configuration set.
See: newPutConfigurationSetTrackingOptions smart constructor.
Constructors
| PutConfigurationSetTrackingOptions' (Maybe Text) Text |
Instances
newPutConfigurationSetTrackingOptions Source #
Arguments
| :: Text |
|
| -> PutConfigurationSetTrackingOptions |
Create a value of PutConfigurationSetTrackingOptions 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:PutConfigurationSetTrackingOptions', putConfigurationSetTrackingOptions_customRedirectDomain - The domain that you want to use to track open and click events.
$sel:configurationSetName:PutConfigurationSetTrackingOptions', putConfigurationSetTrackingOptions_configurationSetName - The name of the configuration set that you want to add a custom tracking
domain to.
data PutConfigurationSetTrackingOptionsResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newPutConfigurationSetTrackingOptionsResponse smart constructor.
Constructors
| PutConfigurationSetTrackingOptionsResponse' Int |
Instances
newPutConfigurationSetTrackingOptionsResponse Source #
Arguments
| :: Int | |
| -> PutConfigurationSetTrackingOptionsResponse |
Create a value of PutConfigurationSetTrackingOptionsResponse 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:httpStatus:PutConfigurationSetTrackingOptionsResponse', putConfigurationSetTrackingOptionsResponse_httpStatus - The response's http status code.
PutEmailIdentityDkimAttributes
data PutEmailIdentityDkimAttributes Source #
A request to enable or disable DKIM signing of email that you send from an email identity.
See: newPutEmailIdentityDkimAttributes smart constructor.
Constructors
| PutEmailIdentityDkimAttributes' (Maybe Bool) Text |
Instances
newPutEmailIdentityDkimAttributes Source #
Create a value of PutEmailIdentityDkimAttributes 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:signingEnabled:PutEmailIdentityDkimAttributes', putEmailIdentityDkimAttributes_signingEnabled - Sets the DKIM signing configuration for the identity.
When you set this value true, then the messages that Amazon Pinpoint
sends from the identity are DKIM-signed. When you set this value to
false, then the messages that Amazon Pinpoint sends from the identity
aren't DKIM-signed.
$sel:emailIdentity:PutEmailIdentityDkimAttributes', putEmailIdentityDkimAttributes_emailIdentity - The email identity that you want to change the DKIM settings for.
data PutEmailIdentityDkimAttributesResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newPutEmailIdentityDkimAttributesResponse smart constructor.
Constructors
| PutEmailIdentityDkimAttributesResponse' Int |
Instances
newPutEmailIdentityDkimAttributesResponse Source #
Arguments
| :: Int | |
| -> PutEmailIdentityDkimAttributesResponse |
Create a value of PutEmailIdentityDkimAttributesResponse 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:httpStatus:PutEmailIdentityDkimAttributesResponse', putEmailIdentityDkimAttributesResponse_httpStatus - The response's http status code.
PutConfigurationSetDeliveryOptions
data PutConfigurationSetDeliveryOptions Source #
A request to associate a configuration set with a dedicated IP pool.
See: newPutConfigurationSetDeliveryOptions smart constructor.
Instances
newPutConfigurationSetDeliveryOptions Source #
Arguments
| :: Text |
|
| -> PutConfigurationSetDeliveryOptions |
Create a value of PutConfigurationSetDeliveryOptions 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:PutConfigurationSetDeliveryOptions', putConfigurationSetDeliveryOptions_sendingPoolName - The name of the dedicated IP pool that you want to associate with the
configuration set.
$sel:tlsPolicy:PutConfigurationSetDeliveryOptions', putConfigurationSetDeliveryOptions_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.
$sel:configurationSetName:PutConfigurationSetDeliveryOptions', putConfigurationSetDeliveryOptions_configurationSetName - The name of the configuration set that you want to associate with a
dedicated IP pool.
data PutConfigurationSetDeliveryOptionsResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newPutConfigurationSetDeliveryOptionsResponse smart constructor.
Constructors
| PutConfigurationSetDeliveryOptionsResponse' Int |
Instances
newPutConfigurationSetDeliveryOptionsResponse Source #
Arguments
| :: Int | |
| -> PutConfigurationSetDeliveryOptionsResponse |
Create a value of PutConfigurationSetDeliveryOptionsResponse 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:httpStatus:PutConfigurationSetDeliveryOptionsResponse', putConfigurationSetDeliveryOptionsResponse_httpStatus - The response's http status code.
ListDedicatedIpPools (Paginated)
data ListDedicatedIpPools Source #
A request to obtain a list of dedicated IP pools.
See: newListDedicatedIpPools smart constructor.
Constructors
| ListDedicatedIpPools' (Maybe Text) (Maybe Int) |
Instances
newListDedicatedIpPools :: ListDedicatedIpPools Source #
Create a value of ListDedicatedIpPools with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDedicatedIpPools', listDedicatedIpPools_nextToken - A token returned from a previous call to ListDedicatedIpPools to
indicate the position in the list of dedicated IP pools.
$sel:pageSize:ListDedicatedIpPools', listDedicatedIpPools_pageSize - The number of results to show in a single call to
ListDedicatedIpPools. If the number of results is larger than the
number you specified in this parameter, then the response includes a
NextToken element, which you can use to obtain additional results.
data ListDedicatedIpPoolsResponse Source #
A list of dedicated IP pools.
See: newListDedicatedIpPoolsResponse smart constructor.
Instances
newListDedicatedIpPoolsResponse Source #
Create a value of ListDedicatedIpPoolsResponse 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:dedicatedIpPools:ListDedicatedIpPoolsResponse', listDedicatedIpPoolsResponse_dedicatedIpPools - A list of all of the dedicated IP pools that are associated with your
Amazon Pinpoint account.
$sel:nextToken:ListDedicatedIpPools', listDedicatedIpPoolsResponse_nextToken - A token that indicates that there are additional IP pools to list. To
view additional IP pools, issue another request to
ListDedicatedIpPools, passing this token in the NextToken parameter.
$sel:httpStatus:ListDedicatedIpPoolsResponse', listDedicatedIpPoolsResponse_httpStatus - The response's http status code.
GetDomainDeliverabilityCampaign
data GetDomainDeliverabilityCampaign Source #
Retrieve all 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: newGetDomainDeliverabilityCampaign smart constructor.
Constructors
| GetDomainDeliverabilityCampaign' Text |
Instances
newGetDomainDeliverabilityCampaign Source #
Create a value of GetDomainDeliverabilityCampaign with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:campaignId:GetDomainDeliverabilityCampaign', getDomainDeliverabilityCampaign_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.
data GetDomainDeliverabilityCampaignResponse Source #
An object that contains all 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: newGetDomainDeliverabilityCampaignResponse smart constructor.
Instances
newGetDomainDeliverabilityCampaignResponse Source #
Arguments
| :: Int | |
| -> DomainDeliverabilityCampaign |
|
| -> GetDomainDeliverabilityCampaignResponse |
Create a value of GetDomainDeliverabilityCampaignResponse 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:httpStatus:GetDomainDeliverabilityCampaignResponse', getDomainDeliverabilityCampaignResponse_httpStatus - The response's http status code.
$sel:domainDeliverabilityCampaign:GetDomainDeliverabilityCampaignResponse', getDomainDeliverabilityCampaignResponse_domainDeliverabilityCampaign - An object that contains the deliverability data for the campaign.
GetDedicatedIps (Paginated)
data GetDedicatedIps Source #
A request to obtain more information about dedicated IP pools.
See: newGetDedicatedIps smart constructor.
Instances
newGetDedicatedIps :: GetDedicatedIps Source #
Create a value of GetDedicatedIps 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:GetDedicatedIps', getDedicatedIps_poolName - The name of the IP pool that the dedicated IP address is associated
with.
$sel:nextToken:GetDedicatedIps', getDedicatedIps_nextToken - A token returned from a previous call to GetDedicatedIps to indicate
the position of the dedicated IP pool in the list of IP pools.
$sel:pageSize:GetDedicatedIps', getDedicatedIps_pageSize - The number of results to show in a single call to
GetDedicatedIpsRequest. If the number of results is larger than the
number you specified in this parameter, then the response includes a
NextToken element, which you can use to obtain additional results.
data GetDedicatedIpsResponse Source #
Information about the dedicated IP addresses that are associated with your Amazon Pinpoint account.
See: newGetDedicatedIpsResponse smart constructor.
Constructors
| GetDedicatedIpsResponse' (Maybe Text) (Maybe [DedicatedIp]) Int |
Instances
newGetDedicatedIpsResponse Source #
Create a value of GetDedicatedIpsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetDedicatedIps', getDedicatedIpsResponse_nextToken - A token that indicates that there are additional dedicated IP addresses
to list. To view additional addresses, issue another request to
GetDedicatedIps, passing this token in the NextToken parameter.
$sel:dedicatedIps:GetDedicatedIpsResponse', getDedicatedIpsResponse_dedicatedIps - A list of dedicated IP addresses that are reserved for use by your
Amazon Pinpoint account.
$sel:httpStatus:GetDedicatedIpsResponse', getDedicatedIpsResponse_httpStatus - The response's http status code.
PutConfigurationSetSendingOptions
data PutConfigurationSetSendingOptions Source #
A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific configuration set.
See: newPutConfigurationSetSendingOptions smart constructor.
Constructors
| PutConfigurationSetSendingOptions' (Maybe Bool) Text |
Instances
newPutConfigurationSetSendingOptions Source #
Arguments
| :: Text |
|
| -> PutConfigurationSetSendingOptions |
Create a value of PutConfigurationSetSendingOptions 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:PutConfigurationSetSendingOptions', putConfigurationSetSendingOptions_sendingEnabled - If true, email sending is enabled for the configuration set. If
false, email sending is disabled for the configuration set.
$sel:configurationSetName:PutConfigurationSetSendingOptions', putConfigurationSetSendingOptions_configurationSetName - The name of the configuration set that you want to enable or disable
email sending for.
data PutConfigurationSetSendingOptionsResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newPutConfigurationSetSendingOptionsResponse smart constructor.
Constructors
| PutConfigurationSetSendingOptionsResponse' Int |
Instances
newPutConfigurationSetSendingOptionsResponse Source #
Arguments
| :: Int | |
| -> PutConfigurationSetSendingOptionsResponse |
Create a value of PutConfigurationSetSendingOptionsResponse 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:httpStatus:PutConfigurationSetSendingOptionsResponse', putConfigurationSetSendingOptionsResponse_httpStatus - The response's http status code.
CreateDedicatedIpPool
data CreateDedicatedIpPool Source #
A request to create a new dedicated IP pool.
See: newCreateDedicatedIpPool smart constructor.
Constructors
| CreateDedicatedIpPool' (Maybe [Tag]) Text |
Instances
newCreateDedicatedIpPool Source #
Create a value of CreateDedicatedIpPool with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateDedicatedIpPool', createDedicatedIpPool_tags - An object that defines the tags (keys and values) that you want to
associate with the pool.
$sel:poolName:CreateDedicatedIpPool', createDedicatedIpPool_poolName - The name of the dedicated IP pool.
data CreateDedicatedIpPoolResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newCreateDedicatedIpPoolResponse smart constructor.
Constructors
| CreateDedicatedIpPoolResponse' Int |
Instances
newCreateDedicatedIpPoolResponse Source #
Create a value of CreateDedicatedIpPoolResponse 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:httpStatus:CreateDedicatedIpPoolResponse', createDedicatedIpPoolResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the resource that you want to retrieve
tag information for.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' Int [Tag] |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - An array that lists all the tags that are associated with the resource.
Each tag consists of a required tag key (Key) and an associated tag
value (Value)
PutEmailIdentityFeedbackAttributes
data PutEmailIdentityFeedbackAttributes Source #
A request to set the attributes that control how bounce and complaint events are processed.
See: newPutEmailIdentityFeedbackAttributes smart constructor.
Constructors
| PutEmailIdentityFeedbackAttributes' (Maybe Bool) Text |
Instances
newPutEmailIdentityFeedbackAttributes Source #
Arguments
| :: Text | |
| -> PutEmailIdentityFeedbackAttributes |
Create a value of PutEmailIdentityFeedbackAttributes 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:emailForwardingEnabled:PutEmailIdentityFeedbackAttributes', putEmailIdentityFeedbackAttributes_emailForwardingEnabled - Sets the feedback forwarding configuration for the identity.
If the value is true, Amazon Pinpoint sends you email notifications
when bounce or complaint events occur. Amazon Pinpoint sends this
notification to the address that you specified in the Return-Path header
of the original email.
When you set this value to false, Amazon Pinpoint sends notifications
through other mechanisms, such as by notifying an Amazon SNS topic or
another event destination. You're required to have a method of tracking
bounces and complaints. If you haven't set up another mechanism for
receiving bounce or complaint notifications, Amazon Pinpoint sends an
email notification when these events occur (even if this setting is
disabled).
$sel:emailIdentity:PutEmailIdentityFeedbackAttributes', putEmailIdentityFeedbackAttributes_emailIdentity - The email identity that you want to configure bounce and complaint
feedback forwarding for.
data PutEmailIdentityFeedbackAttributesResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newPutEmailIdentityFeedbackAttributesResponse smart constructor.
Constructors
| PutEmailIdentityFeedbackAttributesResponse' Int |
Instances
newPutEmailIdentityFeedbackAttributesResponse Source #
Arguments
| :: Int | |
| -> PutEmailIdentityFeedbackAttributesResponse |
Create a value of PutEmailIdentityFeedbackAttributesResponse 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:httpStatus:PutEmailIdentityFeedbackAttributesResponse', putEmailIdentityFeedbackAttributesResponse_httpStatus - The response's http status code.
PutConfigurationSetReputationOptions
data PutConfigurationSetReputationOptions Source #
A request to enable or disable tracking of reputation metrics for a configuration set.
See: newPutConfigurationSetReputationOptions smart constructor.
Constructors
| PutConfigurationSetReputationOptions' (Maybe Bool) Text |
Instances
newPutConfigurationSetReputationOptions Source #
Arguments
| :: Text |
|
| -> PutConfigurationSetReputationOptions |
Create a value of PutConfigurationSetReputationOptions 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:reputationMetricsEnabled:PutConfigurationSetReputationOptions', putConfigurationSetReputationOptions_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.
$sel:configurationSetName:PutConfigurationSetReputationOptions', putConfigurationSetReputationOptions_configurationSetName - The name of the configuration set that you want to enable or disable
reputation metric tracking for.
data PutConfigurationSetReputationOptionsResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newPutConfigurationSetReputationOptionsResponse smart constructor.
Constructors
| PutConfigurationSetReputationOptionsResponse' Int |
Instances
newPutConfigurationSetReputationOptionsResponse Source #
Arguments
| :: Int |
|
| -> PutConfigurationSetReputationOptionsResponse |
Create a value of PutConfigurationSetReputationOptionsResponse 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:httpStatus:PutConfigurationSetReputationOptionsResponse', putConfigurationSetReputationOptionsResponse_httpStatus - The response's http status code.
PutDedicatedIpInPool
data PutDedicatedIpInPool Source #
A request to move a dedicated IP address to a dedicated IP pool.
See: newPutDedicatedIpInPool smart constructor.
Constructors
| PutDedicatedIpInPool' Text Text |
Instances
newPutDedicatedIpInPool Source #
Arguments
| :: Text | |
| -> Text | |
| -> PutDedicatedIpInPool |
Create a value of PutDedicatedIpInPool 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:ip:PutDedicatedIpInPool', putDedicatedIpInPool_ip - The IP address that you want to move to the dedicated IP pool. The value
you specify has to be a dedicated IP address that's associated with
your Amazon Pinpoint account.
$sel:destinationPoolName:PutDedicatedIpInPool', putDedicatedIpInPool_destinationPoolName - The name of the IP pool that you want to add the dedicated IP address
to. You have to specify an IP pool that already exists.
data PutDedicatedIpInPoolResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newPutDedicatedIpInPoolResponse smart constructor.
Constructors
| PutDedicatedIpInPoolResponse' Int |
Instances
newPutDedicatedIpInPoolResponse Source #
Create a value of PutDedicatedIpInPoolResponse 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:httpStatus:PutDedicatedIpInPoolResponse', putDedicatedIpInPoolResponse_httpStatus - The response's http status code.
PutAccountSendingAttributes
data PutAccountSendingAttributes Source #
A request to change the ability of your account to send email.
See: newPutAccountSendingAttributes smart constructor.
Constructors
| PutAccountSendingAttributes' (Maybe Bool) |
Instances
newPutAccountSendingAttributes :: PutAccountSendingAttributes Source #
Create a value of PutAccountSendingAttributes 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:PutAccountSendingAttributes', putAccountSendingAttributes_sendingEnabled - Enables or disables your account's ability to send email. Set to true
to enable email sending, or set to false to disable email sending.
If AWS paused your account's ability to send email, you can't use this operation to resume your account's ability to send email.
data PutAccountSendingAttributesResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newPutAccountSendingAttributesResponse smart constructor.
Constructors
| PutAccountSendingAttributesResponse' Int |
Instances
newPutAccountSendingAttributesResponse Source #
Arguments
| :: Int | |
| -> PutAccountSendingAttributesResponse |
Create a value of PutAccountSendingAttributesResponse 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:httpStatus:PutAccountSendingAttributesResponse', putAccountSendingAttributesResponse_httpStatus - The response's http status code.
UpdateConfigurationSetEventDestination
data UpdateConfigurationSetEventDestination Source #
A request to change the settings for an event destination for a configuration set.
See: newUpdateConfigurationSetEventDestination smart constructor.
Instances
newUpdateConfigurationSetEventDestination Source #
Arguments
Create a value of UpdateConfigurationSetEventDestination 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:configurationSetName:UpdateConfigurationSetEventDestination', updateConfigurationSetEventDestination_configurationSetName - The name of the configuration set that contains the event destination
that you want to modify.
$sel:eventDestinationName:UpdateConfigurationSetEventDestination', updateConfigurationSetEventDestination_eventDestinationName - The name of the event destination that you want to modify.
$sel:eventDestination:UpdateConfigurationSetEventDestination', updateConfigurationSetEventDestination_eventDestination - An object that defines the event destination.
data UpdateConfigurationSetEventDestinationResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newUpdateConfigurationSetEventDestinationResponse smart constructor.
Constructors
| UpdateConfigurationSetEventDestinationResponse' Int |
Instances
newUpdateConfigurationSetEventDestinationResponse Source #
Arguments
| :: Int |
|
| -> UpdateConfigurationSetEventDestinationResponse |
Create a value of UpdateConfigurationSetEventDestinationResponse 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:httpStatus:UpdateConfigurationSetEventDestinationResponse', updateConfigurationSetEventDestinationResponse_httpStatus - The response's http status code.
DeleteConfigurationSetEventDestination
data DeleteConfigurationSetEventDestination Source #
A request to delete an event destination from a configuration set.
See: newDeleteConfigurationSetEventDestination smart constructor.
Constructors
| DeleteConfigurationSetEventDestination' Text Text |
Instances
newDeleteConfigurationSetEventDestination Source #
Arguments
| :: Text |
|
| -> Text |
|
| -> DeleteConfigurationSetEventDestination |
Create a value of DeleteConfigurationSetEventDestination 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:configurationSetName:DeleteConfigurationSetEventDestination', deleteConfigurationSetEventDestination_configurationSetName - The name of the configuration set that contains the event destination
that you want to delete.
$sel:eventDestinationName:DeleteConfigurationSetEventDestination', deleteConfigurationSetEventDestination_eventDestinationName - The name of the event destination that you want to delete.
data DeleteConfigurationSetEventDestinationResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newDeleteConfigurationSetEventDestinationResponse smart constructor.
Constructors
| DeleteConfigurationSetEventDestinationResponse' Int |
Instances
newDeleteConfigurationSetEventDestinationResponse Source #
Arguments
| :: Int |
|
| -> DeleteConfigurationSetEventDestinationResponse |
Create a value of DeleteConfigurationSetEventDestinationResponse 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:httpStatus:DeleteConfigurationSetEventDestinationResponse', deleteConfigurationSetEventDestinationResponse_httpStatus - The response's http status code.
ListConfigurationSets (Paginated)
data ListConfigurationSets Source #
A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.
See: newListConfigurationSets smart constructor.
Constructors
| ListConfigurationSets' (Maybe Text) (Maybe Int) |
Instances
newListConfigurationSets :: ListConfigurationSets Source #
Create a value of ListConfigurationSets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListConfigurationSets', listConfigurationSets_nextToken - A token returned from a previous call to ListConfigurationSets to
indicate the position in the list of configuration sets.
$sel:pageSize:ListConfigurationSets', listConfigurationSets_pageSize - The number of results to show in a single call to
ListConfigurationSets. If the number of results is larger than the
number you specified in this parameter, then the response includes a
NextToken element, which you can use to obtain additional results.
data ListConfigurationSetsResponse Source #
A list of configuration sets in your Amazon Pinpoint account in the current AWS Region.
See: newListConfigurationSetsResponse smart constructor.
Instances
newListConfigurationSetsResponse Source #
Create a value of ListConfigurationSetsResponse 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:configurationSets:ListConfigurationSetsResponse', listConfigurationSetsResponse_configurationSets - An array that contains all of the configuration sets in your Amazon
Pinpoint account in the current AWS Region.
$sel:nextToken:ListConfigurationSets', listConfigurationSetsResponse_nextToken - A token that indicates that there are additional configuration sets to
list. To view additional configuration sets, issue another request to
ListConfigurationSets, and pass this token in the NextToken
parameter.
$sel:httpStatus:ListConfigurationSetsResponse', listConfigurationSetsResponse_httpStatus - The response's http status code.
DeleteEmailIdentity
data DeleteEmailIdentity Source #
A request to delete an existing email identity. When you delete an identity, you lose the ability to use Amazon Pinpoint to send email from that identity. You can restore your ability to send email by completing the verification process for the identity again.
See: newDeleteEmailIdentity smart constructor.
Constructors
| DeleteEmailIdentity' Text |
Instances
newDeleteEmailIdentity Source #
Create a value of DeleteEmailIdentity 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:emailIdentity:DeleteEmailIdentity', deleteEmailIdentity_emailIdentity - The identity (that is, the email address or domain) that you want to
delete from your Amazon Pinpoint account.
data DeleteEmailIdentityResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newDeleteEmailIdentityResponse smart constructor.
Constructors
| DeleteEmailIdentityResponse' Int |
Instances
newDeleteEmailIdentityResponse Source #
Create a value of DeleteEmailIdentityResponse 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:httpStatus:DeleteEmailIdentityResponse', deleteEmailIdentityResponse_httpStatus - The response's http status code.
DeleteConfigurationSet
data DeleteConfigurationSet Source #
A request to delete a configuration set.
See: newDeleteConfigurationSet smart constructor.
Constructors
| DeleteConfigurationSet' Text |
Instances
newDeleteConfigurationSet Source #
Create a value of DeleteConfigurationSet 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:configurationSetName:DeleteConfigurationSet', deleteConfigurationSet_configurationSetName - The name of the configuration set that you want to delete.
data DeleteConfigurationSetResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newDeleteConfigurationSetResponse smart constructor.
Constructors
| DeleteConfigurationSetResponse' Int |
Instances
newDeleteConfigurationSetResponse Source #
Create a value of DeleteConfigurationSetResponse 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:httpStatus:DeleteConfigurationSetResponse', deleteConfigurationSetResponse_httpStatus - The response's http status code.
CreateEmailIdentity
data CreateEmailIdentity Source #
A request to begin the verification process for an email identity (an email address or domain).
See: newCreateEmailIdentity smart constructor.
Constructors
| CreateEmailIdentity' (Maybe [Tag]) Text |
Instances
newCreateEmailIdentity Source #
Create a value of CreateEmailIdentity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateEmailIdentity', createEmailIdentity_tags - An array of objects that define the tags (keys and values) that you want
to associate with the email identity.
$sel:emailIdentity:CreateEmailIdentity', createEmailIdentity_emailIdentity - The email address or domain that you want to verify.
data CreateEmailIdentityResponse Source #
If the email identity is a domain, this object contains tokens that you can use to create a set of CNAME records. To sucessfully verify your domain, you have to add these records to the DNS configuration for your domain.
If the email identity is an email address, this object is empty.
See: newCreateEmailIdentityResponse smart constructor.
Constructors
| CreateEmailIdentityResponse' (Maybe DkimAttributes) (Maybe Bool) (Maybe IdentityType) Int |
Instances
newCreateEmailIdentityResponse Source #
Create a value of CreateEmailIdentityResponse 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:dkimAttributes:CreateEmailIdentityResponse', createEmailIdentityResponse_dkimAttributes - An object that contains information about the DKIM attributes for the
identity. This object includes the tokens that you use to create the
CNAME records that are required to complete the DKIM verification
process.
$sel:verifiedForSendingStatus:CreateEmailIdentityResponse', createEmailIdentityResponse_verifiedForSendingStatus - Specifies whether or not the identity is verified. In Amazon Pinpoint,
you can only send email from verified email addresses or domains. For
more information about verifying identities, see the
Amazon Pinpoint User Guide.
$sel:identityType:CreateEmailIdentityResponse', createEmailIdentityResponse_identityType - The email identity type.
$sel:httpStatus:CreateEmailIdentityResponse', createEmailIdentityResponse_httpStatus - The response's http status code.
GetBlacklistReports
data GetBlacklistReports Source #
A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.
See: newGetBlacklistReports smart constructor.
Constructors
| GetBlacklistReports' [Text] |
Instances
newGetBlacklistReports :: GetBlacklistReports Source #
Create a value of GetBlacklistReports 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:blacklistItemNames:GetBlacklistReports', getBlacklistReports_blacklistItemNames - A list of IP addresses that you want to retrieve blacklist information
about. You can only specify the dedicated IP addresses that you use to
send email using Amazon Pinpoint or Amazon SES.
data GetBlacklistReportsResponse Source #
An object that contains information about blacklist events.
See: newGetBlacklistReportsResponse smart constructor.
Constructors
| GetBlacklistReportsResponse' Int (HashMap Text [BlacklistEntry]) |
Instances
newGetBlacklistReportsResponse Source #
Create a value of GetBlacklistReportsResponse 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:httpStatus:GetBlacklistReportsResponse', getBlacklistReportsResponse_httpStatus - The response's http status code.
$sel:blacklistReport:GetBlacklistReportsResponse', getBlacklistReportsResponse_blacklistReport - An object that contains information about a blacklist that one of your
dedicated IP addresses appears on.
ListEmailIdentities (Paginated)
data ListEmailIdentities Source #
A request to list all of the email identities associated with your Amazon Pinpoint account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.
See: newListEmailIdentities smart constructor.
Constructors
| ListEmailIdentities' (Maybe Text) (Maybe Int) |
Instances
newListEmailIdentities :: ListEmailIdentities Source #
Create a value of ListEmailIdentities with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListEmailIdentities', listEmailIdentities_nextToken - A token returned from a previous call to ListEmailIdentities to
indicate the position in the list of identities.
$sel:pageSize:ListEmailIdentities', listEmailIdentities_pageSize - The number of results to show in a single call to ListEmailIdentities.
If the number of results is larger than the number you specified in this
parameter, then the response includes a NextToken element, which you
can use to obtain additional results.
The value you specify has to be at least 0, and can be no more than 1000.
data ListEmailIdentitiesResponse Source #
A list of all of the identities that you've attempted to verify for use with Amazon Pinpoint, regardless of whether or not those identities were successfully verified.
See: newListEmailIdentitiesResponse smart constructor.
Constructors
| ListEmailIdentitiesResponse' (Maybe Text) (Maybe [IdentityInfo]) Int |
Instances
newListEmailIdentitiesResponse Source #
Create a value of ListEmailIdentitiesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListEmailIdentities', listEmailIdentitiesResponse_nextToken - A token that indicates that there are additional configuration sets to
list. To view additional configuration sets, issue another request to
ListEmailIdentities, and pass this token in the NextToken parameter.
$sel:emailIdentities:ListEmailIdentitiesResponse', listEmailIdentitiesResponse_emailIdentities - An array that includes all of the identities associated with your Amazon
Pinpoint account.
$sel:httpStatus:ListEmailIdentitiesResponse', listEmailIdentitiesResponse_httpStatus - The response's http status code.
GetDedicatedIp
data GetDedicatedIp Source #
A request to obtain more information about a dedicated IP address.
See: newGetDedicatedIp smart constructor.
Constructors
| GetDedicatedIp' Text |
Instances
Arguments
| :: Text | |
| -> GetDedicatedIp |
Create a value of GetDedicatedIp 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:ip:GetDedicatedIp', getDedicatedIp_ip - The IP address that you want to obtain more information about. The value
you specify has to be a dedicated IP address that's assocaited with
your Amazon Pinpoint account.
data GetDedicatedIpResponse Source #
Information about a dedicated IP address.
See: newGetDedicatedIpResponse smart constructor.
Constructors
| GetDedicatedIpResponse' (Maybe DedicatedIp) Int |
Instances
newGetDedicatedIpResponse Source #
Create a value of GetDedicatedIpResponse 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:dedicatedIp:GetDedicatedIpResponse', getDedicatedIpResponse_dedicatedIp - An object that contains information about a dedicated IP address.
$sel:httpStatus:GetDedicatedIpResponse', getDedicatedIpResponse_httpStatus - The response's http status code.
GetEmailIdentity
data GetEmailIdentity Source #
A request to return details about an email identity.
See: newGetEmailIdentity smart constructor.
Constructors
| GetEmailIdentity' Text |
Instances
Arguments
| :: Text | |
| -> GetEmailIdentity |
Create a value of GetEmailIdentity 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:emailIdentity:GetEmailIdentity', getEmailIdentity_emailIdentity - The email identity that you want to retrieve details for.
data GetEmailIdentityResponse Source #
Details about an email identity.
See: newGetEmailIdentityResponse smart constructor.
Constructors
| GetEmailIdentityResponse' (Maybe DkimAttributes) (Maybe Bool) (Maybe IdentityType) (Maybe MailFromAttributes) (Maybe Bool) (Maybe [Tag]) Int |
Instances
newGetEmailIdentityResponse Source #
Create a value of GetEmailIdentityResponse 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:dkimAttributes:GetEmailIdentityResponse', getEmailIdentityResponse_dkimAttributes - An object that contains information about the DKIM attributes for the
identity. This object includes the tokens that you use to create the
CNAME records that are required to complete the DKIM verification
process.
$sel:verifiedForSendingStatus:GetEmailIdentityResponse', getEmailIdentityResponse_verifiedForSendingStatus - Specifies whether or not the identity is verified. In Amazon Pinpoint,
you can only send email from verified email addresses or domains. For
more information about verifying identities, see the
Amazon Pinpoint User Guide.
$sel:identityType:GetEmailIdentityResponse', getEmailIdentityResponse_identityType - The email identity type.
$sel:mailFromAttributes:GetEmailIdentityResponse', getEmailIdentityResponse_mailFromAttributes - An object that contains information about the Mail-From attributes for
the email identity.
$sel:feedbackForwardingStatus:GetEmailIdentityResponse', getEmailIdentityResponse_feedbackForwardingStatus - The feedback forwarding configuration for the identity.
If the value is true, Amazon Pinpoint sends you email notifications
when bounce or complaint events occur. Amazon Pinpoint sends this
notification to the address that you specified in the Return-Path header
of the original email.
When you set this value to false, Amazon Pinpoint sends notifications
through other mechanisms, such as by notifying an Amazon SNS topic or
another event destination. You're required to have a method of tracking
bounces and complaints. If you haven't set up another mechanism for
receiving bounce or complaint notifications, Amazon Pinpoint sends an
email notification when these events occur (even if this setting is
disabled).
$sel:tags:GetEmailIdentityResponse', getEmailIdentityResponse_tags - An array of objects that define the tags (keys and values) that are
associated with the email identity.
$sel:httpStatus:GetEmailIdentityResponse', getEmailIdentityResponse_httpStatus - The response's http status code.
GetConfigurationSetEventDestinations
data GetConfigurationSetEventDestinations Source #
A request to obtain information about the event destinations for a configuration set.
See: newGetConfigurationSetEventDestinations smart constructor.
Constructors
| GetConfigurationSetEventDestinations' Text |
Instances
newGetConfigurationSetEventDestinations Source #
Arguments
| :: Text |
|
| -> GetConfigurationSetEventDestinations |
Create a value of GetConfigurationSetEventDestinations 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:configurationSetName:GetConfigurationSetEventDestinations', getConfigurationSetEventDestinations_configurationSetName - The name of the configuration set that contains the event destination.
data GetConfigurationSetEventDestinationsResponse Source #
Information about an event destination for a configuration set.
See: newGetConfigurationSetEventDestinationsResponse smart constructor.
Constructors
| GetConfigurationSetEventDestinationsResponse' (Maybe [EventDestination]) Int |
Instances
newGetConfigurationSetEventDestinationsResponse Source #
Arguments
| :: Int |
|
| -> GetConfigurationSetEventDestinationsResponse |
Create a value of GetConfigurationSetEventDestinationsResponse 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:eventDestinations:GetConfigurationSetEventDestinationsResponse', getConfigurationSetEventDestinationsResponse_eventDestinations - An array that includes all of the events destinations that have been
configured for the configuration set.
$sel:httpStatus:GetConfigurationSetEventDestinationsResponse', getConfigurationSetEventDestinationsResponse_httpStatus - The response's http status code.
GetAccount
data GetAccount Source #
A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.
See: newGetAccount smart constructor.
Constructors
| GetAccount' | |
Instances
newGetAccount :: GetAccount Source #
Create a value of GetAccount with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetAccountResponse Source #
A list of details about the email-sending capabilities of your Amazon Pinpoint account in the current AWS Region.
See: newGetAccountResponse smart constructor.
Constructors
| GetAccountResponse' (Maybe Text) (Maybe Bool) (Maybe SendQuota) (Maybe Bool) (Maybe Bool) Int |
Instances
newGetAccountResponse Source #
Arguments
| :: Int | |
| -> GetAccountResponse |
Create a value of GetAccountResponse 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:enforcementStatus:GetAccountResponse', getAccountResponse_enforcementStatus - The reputation status of your Amazon Pinpoint account. The status can be
one of the following:
HEALTHY– There are no reputation-related issues that currently impact your account.PROBATION– We've identified some issues with your Amazon Pinpoint account. We're placing your account under review while you work on correcting these issues.SHUTDOWN– Your account's ability to send email is currently paused because of an issue with the email sent from your account. When you correct the issue, you can contact us and request that your account's ability to send email is resumed.
$sel:dedicatedIpAutoWarmupEnabled:GetAccountResponse', getAccountResponse_dedicatedIpAutoWarmupEnabled - Indicates whether or not the automatic warm-up feature is enabled for
dedicated IP addresses that are associated with your account.
$sel:sendQuota:GetAccountResponse', getAccountResponse_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.
$sel:productionAccessEnabled:GetAccountResponse', getAccountResponse_productionAccessEnabled - Indicates whether or not your account has production access in the
current AWS Region.
If the value is false, then your account is in the sandbox. When
your account is in the sandbox, you can only send email to verified
identities. Additionally, the maximum number of emails you can send in a
24-hour period (your sending quota) is 200, and the maximum number of
emails you can send per second (your maximum sending rate) is 1.
If the value is true, then your account has production access. When
your account has production access, you can send email to any address.
The sending quota and maximum sending rate for your account vary based
on your specific use case.
$sel:sendingEnabled:GetAccountResponse', getAccountResponse_sendingEnabled - Indicates whether or not email sending is enabled for your Amazon
Pinpoint account in the current AWS Region.
$sel:httpStatus:GetAccountResponse', getAccountResponse_httpStatus - The response's http status code.
DeleteDedicatedIpPool
data DeleteDedicatedIpPool Source #
A request to delete a dedicated IP pool.
See: newDeleteDedicatedIpPool smart constructor.
Constructors
| DeleteDedicatedIpPool' Text |
Instances
newDeleteDedicatedIpPool Source #
Create a value of DeleteDedicatedIpPool 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:DeleteDedicatedIpPool', deleteDedicatedIpPool_poolName - The name of the dedicated IP pool that you want to delete.
data DeleteDedicatedIpPoolResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newDeleteDedicatedIpPoolResponse smart constructor.
Constructors
| DeleteDedicatedIpPoolResponse' Int |
Instances
newDeleteDedicatedIpPoolResponse Source #
Create a value of DeleteDedicatedIpPoolResponse 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:httpStatus:DeleteDedicatedIpPoolResponse', deleteDedicatedIpPoolResponse_httpStatus - The response's http status code.
GetDomainStatisticsReport
data GetDomainStatisticsReport Source #
A request to obtain deliverability metrics for a domain.
See: newGetDomainStatisticsReport smart constructor.
Constructors
| GetDomainStatisticsReport' Text POSIX POSIX |
Instances
newGetDomainStatisticsReport Source #
Arguments
| :: Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> GetDomainStatisticsReport |
Create a value of GetDomainStatisticsReport 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:GetDomainStatisticsReport', getDomainStatisticsReport_domain - The domain that you want to obtain deliverability metrics for.
$sel:startDate:GetDomainStatisticsReport', getDomainStatisticsReport_startDate - The first day (in Unix time) that you want to obtain domain
deliverability metrics for.
$sel:endDate:GetDomainStatisticsReport', getDomainStatisticsReport_endDate - The last day (in Unix time) that you want to obtain domain
deliverability metrics for. The EndDate that you specify has to be
less than or equal to 30 days after the StartDate.
data GetDomainStatisticsReportResponse Source #
An object that includes statistics that are related to the domain that you specified.
See: newGetDomainStatisticsReportResponse smart constructor.
Constructors
| GetDomainStatisticsReportResponse' Int OverallVolume [DailyVolume] |
Instances
newGetDomainStatisticsReportResponse Source #
Arguments
| :: Int | |
| -> OverallVolume | |
| -> GetDomainStatisticsReportResponse |
Create a value of GetDomainStatisticsReportResponse 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:httpStatus:GetDomainStatisticsReportResponse', getDomainStatisticsReportResponse_httpStatus - The response's http status code.
$sel:overallVolume:GetDomainStatisticsReportResponse', getDomainStatisticsReportResponse_overallVolume - An object that contains deliverability metrics for the domain that you
specified. The data in this object is a summary of all of the data that
was collected from the StartDate to the EndDate.
$sel:dailyVolumes:GetDomainStatisticsReportResponse', getDomainStatisticsReportResponse_dailyVolumes - An object that contains deliverability metrics for the domain that you
specified. This object contains data for each day, starting on the
StartDate and ending on the EndDate.
GetDeliverabilityDashboardOptions
data GetDeliverabilityDashboardOptions Source #
Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
See: newGetDeliverabilityDashboardOptions smart constructor.
Constructors
| GetDeliverabilityDashboardOptions' | |
Instances
newGetDeliverabilityDashboardOptions :: GetDeliverabilityDashboardOptions Source #
Create a value of GetDeliverabilityDashboardOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetDeliverabilityDashboardOptionsResponse Source #
An object that shows the status of the Deliverability dashboard for your Amazon Pinpoint account.
See: newGetDeliverabilityDashboardOptionsResponse smart constructor.
Constructors
Instances
newGetDeliverabilityDashboardOptionsResponse Source #
Arguments
| :: Int | |
| -> Bool |
|
| -> GetDeliverabilityDashboardOptionsResponse |
Create a value of GetDeliverabilityDashboardOptionsResponse 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:accountStatus:GetDeliverabilityDashboardOptionsResponse', getDeliverabilityDashboardOptionsResponse_accountStatus - 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.
$sel:subscriptionExpiryDate:GetDeliverabilityDashboardOptionsResponse', getDeliverabilityDashboardOptionsResponse_subscriptionExpiryDate - The date, in Unix time format, when your current subscription to the
Deliverability dashboard is scheduled to expire, if your subscription is
scheduled to expire at the end of the current calendar month. This value
is null if you have an active subscription that isn’t due to expire at
the end of the month.
$sel:activeSubscribedDomains:GetDeliverabilityDashboardOptionsResponse', getDeliverabilityDashboardOptionsResponse_activeSubscribedDomains - An array of objects, one for each verified domain that you use to send
email and currently has an active Deliverability dashboard subscription
that isn’t scheduled to expire at the end of the current calendar month.
$sel:pendingExpirationSubscribedDomains:GetDeliverabilityDashboardOptionsResponse', getDeliverabilityDashboardOptionsResponse_pendingExpirationSubscribedDomains - An array of objects, one for each verified domain that you use to send
email and currently has an active Deliverability dashboard subscription
that's scheduled to expire at the end of the current calendar month.
$sel:httpStatus:GetDeliverabilityDashboardOptionsResponse', getDeliverabilityDashboardOptionsResponse_httpStatus - The response's http status code.
$sel:dashboardEnabled:GetDeliverabilityDashboardOptionsResponse', getDeliverabilityDashboardOptionsResponse_dashboardEnabled - Specifies whether the Deliverability dashboard is enabled for your
Amazon Pinpoint account. If this value is true, the dashboard is
enabled.
ListDomainDeliverabilityCampaigns
data ListDomainDeliverabilityCampaigns Source #
Retrieve deliverability data for all the campaigns that used a specific
domain to send email during a specified time range. This data is
available for a domain only if you enabled the Deliverability dashboard
(PutDeliverabilityDashboardOption operation) for the domain.
See: newListDomainDeliverabilityCampaigns smart constructor.
Instances
newListDomainDeliverabilityCampaigns Source #
Arguments
| :: UTCTime | |
| -> UTCTime | |
| -> Text | |
| -> ListDomainDeliverabilityCampaigns |
Create a value of ListDomainDeliverabilityCampaigns with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDomainDeliverabilityCampaigns', listDomainDeliverabilityCampaigns_nextToken - A token that’s returned from a previous call to the
ListDomainDeliverabilityCampaigns operation. This token indicates the
position of a campaign in the list of campaigns.
$sel:pageSize:ListDomainDeliverabilityCampaigns', listDomainDeliverabilityCampaigns_pageSize - The maximum number of results to include in response to a single call to
the ListDomainDeliverabilityCampaigns operation. If the number of
results is larger than the number that you specify in this parameter,
the response includes a NextToken element, which you can use to obtain
additional results.
$sel:startDate:ListDomainDeliverabilityCampaigns', listDomainDeliverabilityCampaigns_startDate - The first day, in Unix time format, that you want to obtain
deliverability data for.
$sel:endDate:ListDomainDeliverabilityCampaigns', listDomainDeliverabilityCampaigns_endDate - The last day, in Unix time format, that you want to obtain
deliverability data for. This value has to be less than or equal to 30
days after the value of the StartDate parameter.
$sel:subscribedDomain:ListDomainDeliverabilityCampaigns', listDomainDeliverabilityCampaigns_subscribedDomain - The domain to obtain deliverability data for.
data ListDomainDeliverabilityCampaignsResponse Source #
An array of objects that provide deliverability data for all the
campaigns that used a specific domain to send email during a specified
time range. This data is available for a domain only if you enabled the
Deliverability dashboard (PutDeliverabilityDashboardOption operation)
for the domain.
See: newListDomainDeliverabilityCampaignsResponse smart constructor.
Constructors
| ListDomainDeliverabilityCampaignsResponse' (Maybe Text) Int [DomainDeliverabilityCampaign] |
Instances
newListDomainDeliverabilityCampaignsResponse Source #
Arguments
| :: Int | |
| -> ListDomainDeliverabilityCampaignsResponse |
Create a value of ListDomainDeliverabilityCampaignsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDomainDeliverabilityCampaigns', listDomainDeliverabilityCampaignsResponse_nextToken - A token that’s returned from a previous call to the
ListDomainDeliverabilityCampaigns operation. This token indicates the
position of the campaign in the list of campaigns.
$sel:httpStatus:ListDomainDeliverabilityCampaignsResponse', listDomainDeliverabilityCampaignsResponse_httpStatus - The response's http status code.
$sel:domainDeliverabilityCampaigns:ListDomainDeliverabilityCampaignsResponse', listDomainDeliverabilityCampaignsResponse_domainDeliverabilityCampaigns - An array of responses, one for each campaign that used the domain to
send email during the specified time range.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the resource that you want to add one
or more tags to.
$sel:tags:TagResource', tagResource_tags - A list of the tags that you want to add to the resource. A tag consists
of a required tag key (Key) and an associated tag value (Value). The
maximum length of a tag key is 128 characters. The maximum length of a
tag value is 256 characters.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
SendEmail
A request to send an email message.
See: newSendEmail smart constructor.
Constructors
| SendEmail' (Maybe Text) (Maybe Text) (Maybe [MessageTag]) (Maybe Text) (Maybe [Text]) Destination EmailContent |
Instances
Arguments
| :: Destination | |
| -> EmailContent | |
| -> SendEmail |
Create a value of SendEmail 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:fromEmailAddress:SendEmail', sendEmail_fromEmailAddress - The email address that you want to use as the "From" address for the
email. The address that you specify has to be verified.
$sel:configurationSetName:SendEmail', sendEmail_configurationSetName - The name of the configuration set that you want to use when sending the
email.
$sel:emailTags:SendEmail', sendEmail_emailTags - A list of tags, in the form of name/value pairs, to apply to an email
that you send using the SendEmail operation. Tags correspond to
characteristics of the email that you define, so that you can publish
email sending events.
$sel:feedbackForwardingEmailAddress:SendEmail', sendEmail_feedbackForwardingEmailAddress - The address that Amazon Pinpoint should send bounce and complaint
notifications to.
$sel:replyToAddresses:SendEmail', sendEmail_replyToAddresses - The "Reply-to" email addresses for the message. When the recipient
replies to the message, each Reply-to address receives the reply.
$sel:destination:SendEmail', sendEmail_destination - An object that contains the recipients of the email message.
$sel:content:SendEmail', sendEmail_content - An object that contains the body of the message. You can send either a
Simple message or a Raw message.
data SendEmailResponse Source #
A unique message ID that you receive when Amazon Pinpoint accepts an email for sending.
See: newSendEmailResponse smart constructor.
Constructors
| SendEmailResponse' (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> SendEmailResponse |
Create a value of SendEmailResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:messageId:SendEmailResponse', sendEmailResponse_messageId - A unique identifier for the message that is generated when Amazon
Pinpoint accepts the message.
It is possible for Amazon Pinpoint to accept a message without sending it. This can happen when the message you're trying to send has an attachment doesn't pass a virus check, or when you send a templated email that contains invalid personalization content, for example.
$sel:httpStatus:SendEmailResponse', sendEmailResponse_httpStatus - The response's http status code.
PutDedicatedIpWarmupAttributes
data PutDedicatedIpWarmupAttributes Source #
A request to change the warm-up attributes for a dedicated IP address. This operation is useful when you want to resume the warm-up process for an existing IP address.
See: newPutDedicatedIpWarmupAttributes smart constructor.
Constructors
| PutDedicatedIpWarmupAttributes' Text Int |
Instances
newPutDedicatedIpWarmupAttributes Source #
Arguments
| :: Text | |
| -> Int | |
| -> PutDedicatedIpWarmupAttributes |
Create a value of PutDedicatedIpWarmupAttributes 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:ip:PutDedicatedIpWarmupAttributes', putDedicatedIpWarmupAttributes_ip - The dedicated IP address that you want to update the warm-up attributes
for.
$sel:warmupPercentage:PutDedicatedIpWarmupAttributes', putDedicatedIpWarmupAttributes_warmupPercentage - The warm-up percentage that you want to associate with the dedicated IP
address.
data PutDedicatedIpWarmupAttributesResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newPutDedicatedIpWarmupAttributesResponse smart constructor.
Constructors
| PutDedicatedIpWarmupAttributesResponse' Int |
Instances
newPutDedicatedIpWarmupAttributesResponse Source #
Arguments
| :: Int | |
| -> PutDedicatedIpWarmupAttributesResponse |
Create a value of PutDedicatedIpWarmupAttributesResponse 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:httpStatus:PutDedicatedIpWarmupAttributesResponse', putDedicatedIpWarmupAttributesResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the resource that you want to remove
one or more tags from.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The tags (tag keys) that you want to remove from the resource. When you
specify a tag key, the action removes both that key and its associated
tag value.
To remove more than one tag from the resource, append the TagKeys
parameter and argument for each additional tag to remove, separated by
an ampersand. For example:
/v1/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
CreateDeliverabilityTestReport
data CreateDeliverabilityTestReport Source #
A request to perform a predictive inbox placement test. Predictive inbox
placement tests can help you predict how your messages will be handled
by various email providers around the world. When you perform a
predictive inbox placement test, you provide a sample message that
contains the content that you plan to send to your customers. Amazon
Pinpoint then sends that message to special email addresses spread
across several major email providers. After about 24 hours, the test is
complete, and you can use the GetDeliverabilityTestReport operation to
view the results of the test.
See: newCreateDeliverabilityTestReport smart constructor.
Constructors
| CreateDeliverabilityTestReport' (Maybe Text) (Maybe [Tag]) Text EmailContent |
Instances
newCreateDeliverabilityTestReport Source #
Arguments
| :: Text | |
| -> EmailContent | |
| -> CreateDeliverabilityTestReport |
Create a value of CreateDeliverabilityTestReport 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:reportName:CreateDeliverabilityTestReport', createDeliverabilityTestReport_reportName - A unique name that helps you to identify the predictive inbox placement
test when you retrieve the results.
$sel:tags:CreateDeliverabilityTestReport', createDeliverabilityTestReport_tags - An array of objects that define the tags (keys and values) that you want
to associate with the predictive inbox placement test.
$sel:fromEmailAddress:CreateDeliverabilityTestReport', createDeliverabilityTestReport_fromEmailAddress - The email address that the predictive inbox placement test email was
sent from.
$sel:content:CreateDeliverabilityTestReport', createDeliverabilityTestReport_content - The HTML body of the message that you sent when you performed the
predictive inbox placement test.
data CreateDeliverabilityTestReportResponse Source #
Information about the predictive inbox placement test that you created.
See: newCreateDeliverabilityTestReportResponse smart constructor.
Instances
newCreateDeliverabilityTestReportResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> DeliverabilityTestStatus |
|
| -> CreateDeliverabilityTestReportResponse |
Create a value of CreateDeliverabilityTestReportResponse 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:httpStatus:CreateDeliverabilityTestReportResponse', createDeliverabilityTestReportResponse_httpStatus - The response's http status code.
$sel:reportId:CreateDeliverabilityTestReportResponse', createDeliverabilityTestReportResponse_reportId - A unique string that identifies the predictive inbox placement test.
$sel:deliverabilityTestStatus:CreateDeliverabilityTestReportResponse', createDeliverabilityTestReportResponse_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.
PutEmailIdentityMailFromAttributes
data PutEmailIdentityMailFromAttributes Source #
A request to configure the custom MAIL FROM domain for a verified identity.
See: newPutEmailIdentityMailFromAttributes smart constructor.
Constructors
| PutEmailIdentityMailFromAttributes' (Maybe Text) (Maybe BehaviorOnMxFailure) Text |
Instances
newPutEmailIdentityMailFromAttributes Source #
Arguments
| :: Text | |
| -> PutEmailIdentityMailFromAttributes |
Create a value of PutEmailIdentityMailFromAttributes 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:PutEmailIdentityMailFromAttributes', putEmailIdentityMailFromAttributes_mailFromDomain - The custom MAIL FROM domain that you want the verified identity to use.
The MAIL FROM domain must meet the following criteria:
- It has to be a subdomain of the verified identity.
- It can't be used to receive email.
- It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails.
$sel:behaviorOnMxFailure:PutEmailIdentityMailFromAttributes', putEmailIdentityMailFromAttributes_behaviorOnMxFailure - The action that you want Amazon Pinpoint to take if it can't read the
required MX record when you send an email. 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.
$sel:emailIdentity:PutEmailIdentityMailFromAttributes', putEmailIdentityMailFromAttributes_emailIdentity - The verified email identity that you want to set up the custom MAIL FROM
domain for.
data PutEmailIdentityMailFromAttributesResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newPutEmailIdentityMailFromAttributesResponse smart constructor.
Constructors
| PutEmailIdentityMailFromAttributesResponse' Int |
Instances
newPutEmailIdentityMailFromAttributesResponse Source #
Arguments
| :: Int | |
| -> PutEmailIdentityMailFromAttributesResponse |
Create a value of PutEmailIdentityMailFromAttributesResponse 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:httpStatus:PutEmailIdentityMailFromAttributesResponse', putEmailIdentityMailFromAttributesResponse_httpStatus - The response's http status code.
CreateConfigurationSetEventDestination
data CreateConfigurationSetEventDestination Source #
A request to add an event destination to a configuration set.
See: newCreateConfigurationSetEventDestination smart constructor.
Instances
newCreateConfigurationSetEventDestination Source #
Arguments
Create a value of CreateConfigurationSetEventDestination 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:configurationSetName:CreateConfigurationSetEventDestination', createConfigurationSetEventDestination_configurationSetName - The name of the configuration set that you want to add an event
destination to.
$sel:eventDestinationName:CreateConfigurationSetEventDestination', createConfigurationSetEventDestination_eventDestinationName - A name that identifies the event destination within the configuration
set.
$sel:eventDestination:CreateConfigurationSetEventDestination', createConfigurationSetEventDestination_eventDestination - An object that defines the event destination.
data CreateConfigurationSetEventDestinationResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newCreateConfigurationSetEventDestinationResponse smart constructor.
Constructors
| CreateConfigurationSetEventDestinationResponse' Int |
Instances
newCreateConfigurationSetEventDestinationResponse Source #
Arguments
| :: Int |
|
| -> CreateConfigurationSetEventDestinationResponse |
Create a value of CreateConfigurationSetEventDestinationResponse 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:httpStatus:CreateConfigurationSetEventDestinationResponse', createConfigurationSetEventDestinationResponse_httpStatus - The response's http status code.
ListDeliverabilityTestReports (Paginated)
data ListDeliverabilityTestReports Source #
A request to list all of the predictive inbox placement tests that you've performed.
See: newListDeliverabilityTestReports smart constructor.
Constructors
| ListDeliverabilityTestReports' (Maybe Text) (Maybe Int) |
Instances
newListDeliverabilityTestReports :: ListDeliverabilityTestReports Source #
Create a value of ListDeliverabilityTestReports with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDeliverabilityTestReports', listDeliverabilityTestReports_nextToken - A token returned from a previous call to ListDeliverabilityTestReports
to indicate the position in the list of predictive inbox placement
tests.
$sel:pageSize:ListDeliverabilityTestReports', listDeliverabilityTestReports_pageSize - The number of results to show in a single call to
ListDeliverabilityTestReports. If the number of results is larger than
the number you specified in this parameter, then the response includes a
NextToken element, which you can use to obtain additional results.
The value you specify has to be at least 0, and can be no more than 1000.
data ListDeliverabilityTestReportsResponse Source #
A list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.
See: newListDeliverabilityTestReportsResponse smart constructor.
Constructors
| ListDeliverabilityTestReportsResponse' (Maybe Text) Int [DeliverabilityTestReport] |
Instances
newListDeliverabilityTestReportsResponse Source #
Arguments
| :: Int | |
| -> ListDeliverabilityTestReportsResponse |
Create a value of ListDeliverabilityTestReportsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDeliverabilityTestReports', listDeliverabilityTestReportsResponse_nextToken - A token that indicates that there are additional predictive inbox
placement tests to list. To view additional predictive inbox placement
tests, issue another request to ListDeliverabilityTestReports, and
pass this token in the NextToken parameter.
$sel:httpStatus:ListDeliverabilityTestReportsResponse', listDeliverabilityTestReportsResponse_httpStatus - The response's http status code.
$sel:deliverabilityTestReports:ListDeliverabilityTestReportsResponse', listDeliverabilityTestReportsResponse_deliverabilityTestReports - An object that contains a lists of predictive inbox placement tests that
you've performed.
CreateConfigurationSet
data CreateConfigurationSet Source #
A request to create a configuration set.
See: newCreateConfigurationSet smart constructor.
Constructors
| CreateConfigurationSet' (Maybe SendingOptions) (Maybe DeliveryOptions) (Maybe TrackingOptions) (Maybe ReputationOptions) (Maybe [Tag]) Text |
Instances
newCreateConfigurationSet Source #
Create a value of CreateConfigurationSet 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:sendingOptions:CreateConfigurationSet', createConfigurationSet_sendingOptions - An object that defines whether or not Amazon Pinpoint can send email
that you send using the configuration set.
$sel:deliveryOptions:CreateConfigurationSet', createConfigurationSet_deliveryOptions - An object that defines the dedicated IP pool that is used to send emails
that you send using the configuration set.
$sel:trackingOptions:CreateConfigurationSet', createConfigurationSet_trackingOptions - An object that defines the open and click tracking options for emails
that you send using the configuration set.
$sel:reputationOptions:CreateConfigurationSet', createConfigurationSet_reputationOptions - An object that defines whether or not Amazon Pinpoint collects
reputation metrics for the emails that you send that use the
configuration set.
$sel:tags:CreateConfigurationSet', createConfigurationSet_tags - An array of objects that define the tags (keys and values) that you want
to associate with the configuration set.
$sel:configurationSetName:CreateConfigurationSet', createConfigurationSet_configurationSetName - The name of the configuration set.
data CreateConfigurationSetResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newCreateConfigurationSetResponse smart constructor.
Constructors
| CreateConfigurationSetResponse' Int |
Instances
newCreateConfigurationSetResponse Source #
Create a value of CreateConfigurationSetResponse 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:httpStatus:CreateConfigurationSetResponse', createConfigurationSetResponse_httpStatus - The response's http status code.
GetDeliverabilityTestReport
data GetDeliverabilityTestReport Source #
A request to retrieve the results of a predictive inbox placement test.
See: newGetDeliverabilityTestReport smart constructor.
Constructors
| GetDeliverabilityTestReport' Text |
Instances
newGetDeliverabilityTestReport Source #
Create a value of GetDeliverabilityTestReport 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:reportId:GetDeliverabilityTestReport', getDeliverabilityTestReport_reportId - A unique string that identifies the predictive inbox placement test.
data GetDeliverabilityTestReportResponse Source #
The results of the predictive inbox placement test.
See: newGetDeliverabilityTestReportResponse smart constructor.
Constructors
| GetDeliverabilityTestReportResponse' (Maybe Text) (Maybe [Tag]) Int DeliverabilityTestReport PlacementStatistics [IspPlacement] |
Instances
newGetDeliverabilityTestReportResponse Source #
Arguments
| :: Int | |
| -> DeliverabilityTestReport |
|
| -> PlacementStatistics | |
| -> GetDeliverabilityTestReportResponse |
Create a value of GetDeliverabilityTestReportResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:GetDeliverabilityTestReportResponse', getDeliverabilityTestReportResponse_message - An object that contains the message that you sent when you performed
this predictive inbox placement test.
$sel:tags:GetDeliverabilityTestReportResponse', getDeliverabilityTestReportResponse_tags - An array of objects that define the tags (keys and values) that are
associated with the predictive inbox placement test.
$sel:httpStatus:GetDeliverabilityTestReportResponse', getDeliverabilityTestReportResponse_httpStatus - The response's http status code.
$sel:deliverabilityTestReport:GetDeliverabilityTestReportResponse', getDeliverabilityTestReportResponse_deliverabilityTestReport - An object that contains the results of the predictive inbox placement
test.
$sel:overallPlacement:GetDeliverabilityTestReportResponse', getDeliverabilityTestReportResponse_overallPlacement - An object that specifies how many test messages that were sent during
the predictive inbox placement test were delivered to recipients'
inboxes, how many were sent to recipients' spam folders, and how many
weren't delivered.
$sel:ispPlacements:GetDeliverabilityTestReportResponse', getDeliverabilityTestReportResponse_ispPlacements - An object that describes how the test email was handled by several email
providers, including Gmail, Hotmail, Yahoo, AOL, and others.
PutDeliverabilityDashboardOption
data PutDeliverabilityDashboardOption Source #
Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.
See: newPutDeliverabilityDashboardOption smart constructor.
Constructors
| PutDeliverabilityDashboardOption' (Maybe [DomainDeliverabilityTrackingOption]) Bool |
Instances
newPutDeliverabilityDashboardOption Source #
Arguments
| :: Bool | |
| -> PutDeliverabilityDashboardOption |
Create a value of PutDeliverabilityDashboardOption 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:subscribedDomains:PutDeliverabilityDashboardOption', putDeliverabilityDashboardOption_subscribedDomains - An array of objects, one for each verified domain that you use to send
email and enabled the Deliverability dashboard for.
$sel:dashboardEnabled:PutDeliverabilityDashboardOption', putDeliverabilityDashboardOption_dashboardEnabled - Specifies whether to enable the Deliverability dashboard for your Amazon
Pinpoint account. To enable the dashboard, set this value to true.
data PutDeliverabilityDashboardOptionResponse Source #
A response that indicates whether the Deliverability dashboard is enabled for your Amazon Pinpoint account.
See: newPutDeliverabilityDashboardOptionResponse smart constructor.
Constructors
| PutDeliverabilityDashboardOptionResponse' Int |
Instances
newPutDeliverabilityDashboardOptionResponse Source #
Arguments
| :: Int | |
| -> PutDeliverabilityDashboardOptionResponse |
Create a value of PutDeliverabilityDashboardOptionResponse 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:httpStatus:PutDeliverabilityDashboardOptionResponse', putDeliverabilityDashboardOptionResponse_httpStatus - The response's http status code.
PutAccountDedicatedIpWarmupAttributes
data PutAccountDedicatedIpWarmupAttributes Source #
A request to enable or disable the automatic IP address warm-up feature.
See: newPutAccountDedicatedIpWarmupAttributes smart constructor.
Constructors
| PutAccountDedicatedIpWarmupAttributes' (Maybe Bool) |
Instances
newPutAccountDedicatedIpWarmupAttributes :: PutAccountDedicatedIpWarmupAttributes Source #
Create a value of PutAccountDedicatedIpWarmupAttributes 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:autoWarmupEnabled:PutAccountDedicatedIpWarmupAttributes', putAccountDedicatedIpWarmupAttributes_autoWarmupEnabled - Enables or disables the automatic warm-up feature for dedicated IP
addresses that are associated with your Amazon Pinpoint account in the
current AWS Region. Set to true to enable the automatic warm-up
feature, or set to false to disable it.
data PutAccountDedicatedIpWarmupAttributesResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newPutAccountDedicatedIpWarmupAttributesResponse smart constructor.
Constructors
| PutAccountDedicatedIpWarmupAttributesResponse' Int |
Instances
newPutAccountDedicatedIpWarmupAttributesResponse Source #
Arguments
| :: Int |
|
| -> PutAccountDedicatedIpWarmupAttributesResponse |
Create a value of PutAccountDedicatedIpWarmupAttributesResponse 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:httpStatus:PutAccountDedicatedIpWarmupAttributesResponse', putAccountDedicatedIpWarmupAttributesResponse_httpStatus - The response's http status code.
Types
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.
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.
Body
Represents the body of the email message.
See: newBody smart constructor.
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.
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' [CloudWatchDimensionConfiguration] |
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.
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.
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.
Content
An object that represents the content of the email, and optionally a character set specification.
See: newContent smart constructor.
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.
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' (Maybe [DomainIspPlacement]) (Maybe POSIX) (Maybe VolumeStatistics) |
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.
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' (Maybe Text) Text WarmupStatus Int |
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.
DeliverabilityTestReport
data DeliverabilityTestReport Source #
An object that contains metadata related to a predictive inbox placement test.
See: newDeliverabilityTestReport smart constructor.
Constructors
| DeliverabilityTestReport' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe DeliverabilityTestStatus) |
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.
DeliveryOptions
data DeliveryOptions Source #
Used to associate a configuration set with a dedicated IP pool.
See: newDeliveryOptions smart constructor.
Constructors
| DeliveryOptions' (Maybe Text) (Maybe TlsPolicy) |
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.
Destination
data Destination Source #
An object that describes the recipients for an email.
See: newDestination smart constructor.
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.
DkimAttributes
data DkimAttributes Source #
An object that contains information about the DKIM configuration for an email identity.
See: newDkimAttributes smart constructor.
Constructors
| DkimAttributes' (Maybe DkimStatus) (Maybe [Text]) (Maybe Bool) |
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.
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' (Maybe Integer) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Double) (Maybe Text) (Maybe [Text]) (Maybe POSIX) (Maybe Integer) (Maybe Double) (Maybe Integer) (Maybe Text) (Maybe Double) (Maybe POSIX) |
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.
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' (Maybe Text) (Maybe POSIX) (Maybe InboxPlacementTrackingOption) |
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.
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' (Maybe Double) (Maybe Integer) (Maybe Text) (Maybe Double) (Maybe Integer) |
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.
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' (Maybe RawMessage) (Maybe Message) (Maybe Template) |
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.
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' (Maybe PinpointDestination) (Maybe Bool) (Maybe KinesisFirehoseDestination) (Maybe CloudWatchDestination) (Maybe SnsDestination) Text [EventType] |
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.
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' (Maybe [EventType]) (Maybe PinpointDestination) (Maybe Bool) (Maybe KinesisFirehoseDestination) (Maybe CloudWatchDestination) (Maybe SnsDestination) |
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.
IdentityInfo
data IdentityInfo Source #
Information about an email identity.
See: newIdentityInfo smart constructor.
Constructors
| IdentityInfo' (Maybe IdentityType) (Maybe Text) (Maybe Bool) |
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.
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' (Maybe [Text]) (Maybe Bool) |
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.
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' (Maybe PlacementStatistics) (Maybe Text) |
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.
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' Text Text |
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.
MailFromAttributes
data MailFromAttributes Source #
A list of attributes that are associated with a MAIL FROM domain.
See: newMailFromAttributes smart constructor.
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.
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.
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.
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' Text Text |
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.
OverallVolume
data OverallVolume Source #
An object that contains information about email that was sent from the selected domain.
See: newOverallVolume smart constructor.
Constructors
| OverallVolume' (Maybe [DomainIspPlacement]) (Maybe VolumeStatistics) (Maybe Double) |
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.
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' (Maybe Text) |
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.
PlacementStatistics
data PlacementStatistics Source #
An object that contains inbox placement data for an email provider.
See: newPlacementStatistics smart constructor.
Constructors
| PlacementStatistics' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) |
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.
RawMessage
data RawMessage Source #
The raw email message.
See: newRawMessage smart constructor.
Constructors
| RawMessage' Base64 |
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.
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' (Maybe POSIX) (Maybe Bool) |
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.
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.
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.
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' (Maybe Bool) |
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.
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' Text |
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.
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.
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.
Template
See: newTemplate smart constructor.
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.
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' Text |
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.
VolumeStatistics
data VolumeStatistics Source #
An object that contains information about the amount of email that was delivered to recipients.
See: newVolumeStatistics smart constructor.
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.