{-# OPTIONS_GHC -fno-warn-duplicate-exports #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} -- | -- Module : Amazonka.PinpointEmail -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- 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. -- -- 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 -- . -- 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 -- -- in the /Amazon Web Services General Reference/. To learn more about AWS -- Regions, see -- -- 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 -- . module Amazonka.PinpointEmail ( -- * Service Configuration defaultService, -- * Errors -- $errors -- ** AccountSuspendedException _AccountSuspendedException, -- ** AlreadyExistsException _AlreadyExistsException, -- ** BadRequestException _BadRequestException, -- ** ConcurrentModificationException _ConcurrentModificationException, -- ** LimitExceededException _LimitExceededException, -- ** MailFromDomainNotVerifiedException _MailFromDomainNotVerifiedException, -- ** MessageRejected _MessageRejected, -- ** NotFoundException _NotFoundException, -- ** SendingPausedException _SendingPausedException, -- ** TooManyRequestsException _TooManyRequestsException, -- * Waiters -- $waiters -- * Operations -- $operations -- ** CreateConfigurationSet CreateConfigurationSet (CreateConfigurationSet'), newCreateConfigurationSet, CreateConfigurationSetResponse (CreateConfigurationSetResponse'), newCreateConfigurationSetResponse, -- ** CreateConfigurationSetEventDestination CreateConfigurationSetEventDestination (CreateConfigurationSetEventDestination'), newCreateConfigurationSetEventDestination, CreateConfigurationSetEventDestinationResponse (CreateConfigurationSetEventDestinationResponse'), newCreateConfigurationSetEventDestinationResponse, -- ** CreateDedicatedIpPool CreateDedicatedIpPool (CreateDedicatedIpPool'), newCreateDedicatedIpPool, CreateDedicatedIpPoolResponse (CreateDedicatedIpPoolResponse'), newCreateDedicatedIpPoolResponse, -- ** CreateDeliverabilityTestReport CreateDeliverabilityTestReport (CreateDeliverabilityTestReport'), newCreateDeliverabilityTestReport, CreateDeliverabilityTestReportResponse (CreateDeliverabilityTestReportResponse'), newCreateDeliverabilityTestReportResponse, -- ** CreateEmailIdentity CreateEmailIdentity (CreateEmailIdentity'), newCreateEmailIdentity, CreateEmailIdentityResponse (CreateEmailIdentityResponse'), newCreateEmailIdentityResponse, -- ** DeleteConfigurationSet DeleteConfigurationSet (DeleteConfigurationSet'), newDeleteConfigurationSet, DeleteConfigurationSetResponse (DeleteConfigurationSetResponse'), newDeleteConfigurationSetResponse, -- ** DeleteConfigurationSetEventDestination DeleteConfigurationSetEventDestination (DeleteConfigurationSetEventDestination'), newDeleteConfigurationSetEventDestination, DeleteConfigurationSetEventDestinationResponse (DeleteConfigurationSetEventDestinationResponse'), newDeleteConfigurationSetEventDestinationResponse, -- ** DeleteDedicatedIpPool DeleteDedicatedIpPool (DeleteDedicatedIpPool'), newDeleteDedicatedIpPool, DeleteDedicatedIpPoolResponse (DeleteDedicatedIpPoolResponse'), newDeleteDedicatedIpPoolResponse, -- ** DeleteEmailIdentity DeleteEmailIdentity (DeleteEmailIdentity'), newDeleteEmailIdentity, DeleteEmailIdentityResponse (DeleteEmailIdentityResponse'), newDeleteEmailIdentityResponse, -- ** GetAccount GetAccount (GetAccount'), newGetAccount, GetAccountResponse (GetAccountResponse'), newGetAccountResponse, -- ** GetBlacklistReports GetBlacklistReports (GetBlacklistReports'), newGetBlacklistReports, GetBlacklistReportsResponse (GetBlacklistReportsResponse'), newGetBlacklistReportsResponse, -- ** GetConfigurationSet GetConfigurationSet (GetConfigurationSet'), newGetConfigurationSet, GetConfigurationSetResponse (GetConfigurationSetResponse'), newGetConfigurationSetResponse, -- ** GetConfigurationSetEventDestinations GetConfigurationSetEventDestinations (GetConfigurationSetEventDestinations'), newGetConfigurationSetEventDestinations, GetConfigurationSetEventDestinationsResponse (GetConfigurationSetEventDestinationsResponse'), newGetConfigurationSetEventDestinationsResponse, -- ** GetDedicatedIp GetDedicatedIp (GetDedicatedIp'), newGetDedicatedIp, GetDedicatedIpResponse (GetDedicatedIpResponse'), newGetDedicatedIpResponse, -- ** GetDedicatedIps (Paginated) GetDedicatedIps (GetDedicatedIps'), newGetDedicatedIps, GetDedicatedIpsResponse (GetDedicatedIpsResponse'), newGetDedicatedIpsResponse, -- ** GetDeliverabilityDashboardOptions GetDeliverabilityDashboardOptions (GetDeliverabilityDashboardOptions'), newGetDeliverabilityDashboardOptions, GetDeliverabilityDashboardOptionsResponse (GetDeliverabilityDashboardOptionsResponse'), newGetDeliverabilityDashboardOptionsResponse, -- ** GetDeliverabilityTestReport GetDeliverabilityTestReport (GetDeliverabilityTestReport'), newGetDeliverabilityTestReport, GetDeliverabilityTestReportResponse (GetDeliverabilityTestReportResponse'), newGetDeliverabilityTestReportResponse, -- ** GetDomainDeliverabilityCampaign GetDomainDeliverabilityCampaign (GetDomainDeliverabilityCampaign'), newGetDomainDeliverabilityCampaign, GetDomainDeliverabilityCampaignResponse (GetDomainDeliverabilityCampaignResponse'), newGetDomainDeliverabilityCampaignResponse, -- ** GetDomainStatisticsReport GetDomainStatisticsReport (GetDomainStatisticsReport'), newGetDomainStatisticsReport, GetDomainStatisticsReportResponse (GetDomainStatisticsReportResponse'), newGetDomainStatisticsReportResponse, -- ** GetEmailIdentity GetEmailIdentity (GetEmailIdentity'), newGetEmailIdentity, GetEmailIdentityResponse (GetEmailIdentityResponse'), newGetEmailIdentityResponse, -- ** ListConfigurationSets (Paginated) ListConfigurationSets (ListConfigurationSets'), newListConfigurationSets, ListConfigurationSetsResponse (ListConfigurationSetsResponse'), newListConfigurationSetsResponse, -- ** ListDedicatedIpPools (Paginated) ListDedicatedIpPools (ListDedicatedIpPools'), newListDedicatedIpPools, ListDedicatedIpPoolsResponse (ListDedicatedIpPoolsResponse'), newListDedicatedIpPoolsResponse, -- ** ListDeliverabilityTestReports (Paginated) ListDeliverabilityTestReports (ListDeliverabilityTestReports'), newListDeliverabilityTestReports, ListDeliverabilityTestReportsResponse (ListDeliverabilityTestReportsResponse'), newListDeliverabilityTestReportsResponse, -- ** ListDomainDeliverabilityCampaigns ListDomainDeliverabilityCampaigns (ListDomainDeliverabilityCampaigns'), newListDomainDeliverabilityCampaigns, ListDomainDeliverabilityCampaignsResponse (ListDomainDeliverabilityCampaignsResponse'), newListDomainDeliverabilityCampaignsResponse, -- ** ListEmailIdentities (Paginated) ListEmailIdentities (ListEmailIdentities'), newListEmailIdentities, ListEmailIdentitiesResponse (ListEmailIdentitiesResponse'), newListEmailIdentitiesResponse, -- ** ListTagsForResource ListTagsForResource (ListTagsForResource'), newListTagsForResource, ListTagsForResourceResponse (ListTagsForResourceResponse'), newListTagsForResourceResponse, -- ** PutAccountDedicatedIpWarmupAttributes PutAccountDedicatedIpWarmupAttributes (PutAccountDedicatedIpWarmupAttributes'), newPutAccountDedicatedIpWarmupAttributes, PutAccountDedicatedIpWarmupAttributesResponse (PutAccountDedicatedIpWarmupAttributesResponse'), newPutAccountDedicatedIpWarmupAttributesResponse, -- ** PutAccountSendingAttributes PutAccountSendingAttributes (PutAccountSendingAttributes'), newPutAccountSendingAttributes, PutAccountSendingAttributesResponse (PutAccountSendingAttributesResponse'), newPutAccountSendingAttributesResponse, -- ** PutConfigurationSetDeliveryOptions PutConfigurationSetDeliveryOptions (PutConfigurationSetDeliveryOptions'), newPutConfigurationSetDeliveryOptions, PutConfigurationSetDeliveryOptionsResponse (PutConfigurationSetDeliveryOptionsResponse'), newPutConfigurationSetDeliveryOptionsResponse, -- ** PutConfigurationSetReputationOptions PutConfigurationSetReputationOptions (PutConfigurationSetReputationOptions'), newPutConfigurationSetReputationOptions, PutConfigurationSetReputationOptionsResponse (PutConfigurationSetReputationOptionsResponse'), newPutConfigurationSetReputationOptionsResponse, -- ** PutConfigurationSetSendingOptions PutConfigurationSetSendingOptions (PutConfigurationSetSendingOptions'), newPutConfigurationSetSendingOptions, PutConfigurationSetSendingOptionsResponse (PutConfigurationSetSendingOptionsResponse'), newPutConfigurationSetSendingOptionsResponse, -- ** PutConfigurationSetTrackingOptions PutConfigurationSetTrackingOptions (PutConfigurationSetTrackingOptions'), newPutConfigurationSetTrackingOptions, PutConfigurationSetTrackingOptionsResponse (PutConfigurationSetTrackingOptionsResponse'), newPutConfigurationSetTrackingOptionsResponse, -- ** PutDedicatedIpInPool PutDedicatedIpInPool (PutDedicatedIpInPool'), newPutDedicatedIpInPool, PutDedicatedIpInPoolResponse (PutDedicatedIpInPoolResponse'), newPutDedicatedIpInPoolResponse, -- ** PutDedicatedIpWarmupAttributes PutDedicatedIpWarmupAttributes (PutDedicatedIpWarmupAttributes'), newPutDedicatedIpWarmupAttributes, PutDedicatedIpWarmupAttributesResponse (PutDedicatedIpWarmupAttributesResponse'), newPutDedicatedIpWarmupAttributesResponse, -- ** PutDeliverabilityDashboardOption PutDeliverabilityDashboardOption (PutDeliverabilityDashboardOption'), newPutDeliverabilityDashboardOption, PutDeliverabilityDashboardOptionResponse (PutDeliverabilityDashboardOptionResponse'), newPutDeliverabilityDashboardOptionResponse, -- ** PutEmailIdentityDkimAttributes PutEmailIdentityDkimAttributes (PutEmailIdentityDkimAttributes'), newPutEmailIdentityDkimAttributes, PutEmailIdentityDkimAttributesResponse (PutEmailIdentityDkimAttributesResponse'), newPutEmailIdentityDkimAttributesResponse, -- ** PutEmailIdentityFeedbackAttributes PutEmailIdentityFeedbackAttributes (PutEmailIdentityFeedbackAttributes'), newPutEmailIdentityFeedbackAttributes, PutEmailIdentityFeedbackAttributesResponse (PutEmailIdentityFeedbackAttributesResponse'), newPutEmailIdentityFeedbackAttributesResponse, -- ** PutEmailIdentityMailFromAttributes PutEmailIdentityMailFromAttributes (PutEmailIdentityMailFromAttributes'), newPutEmailIdentityMailFromAttributes, PutEmailIdentityMailFromAttributesResponse (PutEmailIdentityMailFromAttributesResponse'), newPutEmailIdentityMailFromAttributesResponse, -- ** SendEmail SendEmail (SendEmail'), newSendEmail, SendEmailResponse (SendEmailResponse'), newSendEmailResponse, -- ** TagResource TagResource (TagResource'), newTagResource, TagResourceResponse (TagResourceResponse'), newTagResourceResponse, -- ** UntagResource UntagResource (UntagResource'), newUntagResource, UntagResourceResponse (UntagResourceResponse'), newUntagResourceResponse, -- ** UpdateConfigurationSetEventDestination UpdateConfigurationSetEventDestination (UpdateConfigurationSetEventDestination'), newUpdateConfigurationSetEventDestination, UpdateConfigurationSetEventDestinationResponse (UpdateConfigurationSetEventDestinationResponse'), newUpdateConfigurationSetEventDestinationResponse, -- * Types -- ** BehaviorOnMxFailure BehaviorOnMxFailure (..), -- ** DeliverabilityDashboardAccountStatus DeliverabilityDashboardAccountStatus (..), -- ** DeliverabilityTestStatus DeliverabilityTestStatus (..), -- ** DimensionValueSource DimensionValueSource (..), -- ** DkimStatus DkimStatus (..), -- ** EventType EventType (..), -- ** IdentityType IdentityType (..), -- ** MailFromDomainStatus MailFromDomainStatus (..), -- ** TlsPolicy TlsPolicy (..), -- ** WarmupStatus WarmupStatus (..), -- ** BlacklistEntry BlacklistEntry (BlacklistEntry'), newBlacklistEntry, -- ** Body Body (Body'), newBody, -- ** CloudWatchDestination CloudWatchDestination (CloudWatchDestination'), newCloudWatchDestination, -- ** CloudWatchDimensionConfiguration CloudWatchDimensionConfiguration (CloudWatchDimensionConfiguration'), newCloudWatchDimensionConfiguration, -- ** Content Content (Content'), newContent, -- ** DailyVolume DailyVolume (DailyVolume'), newDailyVolume, -- ** DedicatedIp DedicatedIp (DedicatedIp'), newDedicatedIp, -- ** DeliverabilityTestReport DeliverabilityTestReport (DeliverabilityTestReport'), newDeliverabilityTestReport, -- ** DeliveryOptions DeliveryOptions (DeliveryOptions'), newDeliveryOptions, -- ** Destination Destination (Destination'), newDestination, -- ** DkimAttributes DkimAttributes (DkimAttributes'), newDkimAttributes, -- ** DomainDeliverabilityCampaign DomainDeliverabilityCampaign (DomainDeliverabilityCampaign'), newDomainDeliverabilityCampaign, -- ** DomainDeliverabilityTrackingOption DomainDeliverabilityTrackingOption (DomainDeliverabilityTrackingOption'), newDomainDeliverabilityTrackingOption, -- ** DomainIspPlacement DomainIspPlacement (DomainIspPlacement'), newDomainIspPlacement, -- ** EmailContent EmailContent (EmailContent'), newEmailContent, -- ** EventDestination EventDestination (EventDestination'), newEventDestination, -- ** EventDestinationDefinition EventDestinationDefinition (EventDestinationDefinition'), newEventDestinationDefinition, -- ** IdentityInfo IdentityInfo (IdentityInfo'), newIdentityInfo, -- ** InboxPlacementTrackingOption InboxPlacementTrackingOption (InboxPlacementTrackingOption'), newInboxPlacementTrackingOption, -- ** IspPlacement IspPlacement (IspPlacement'), newIspPlacement, -- ** KinesisFirehoseDestination KinesisFirehoseDestination (KinesisFirehoseDestination'), newKinesisFirehoseDestination, -- ** MailFromAttributes MailFromAttributes (MailFromAttributes'), newMailFromAttributes, -- ** Message Message (Message'), newMessage, -- ** MessageTag MessageTag (MessageTag'), newMessageTag, -- ** OverallVolume OverallVolume (OverallVolume'), newOverallVolume, -- ** PinpointDestination PinpointDestination (PinpointDestination'), newPinpointDestination, -- ** PlacementStatistics PlacementStatistics (PlacementStatistics'), newPlacementStatistics, -- ** RawMessage RawMessage (RawMessage'), newRawMessage, -- ** ReputationOptions ReputationOptions (ReputationOptions'), newReputationOptions, -- ** SendQuota SendQuota (SendQuota'), newSendQuota, -- ** SendingOptions SendingOptions (SendingOptions'), newSendingOptions, -- ** SnsDestination SnsDestination (SnsDestination'), newSnsDestination, -- ** Tag Tag (Tag'), newTag, -- ** Template Template (Template'), newTemplate, -- ** TrackingOptions TrackingOptions (TrackingOptions'), newTrackingOptions, -- ** VolumeStatistics VolumeStatistics (VolumeStatistics'), newVolumeStatistics, ) where import Amazonka.PinpointEmail.CreateConfigurationSet import Amazonka.PinpointEmail.CreateConfigurationSetEventDestination import Amazonka.PinpointEmail.CreateDedicatedIpPool import Amazonka.PinpointEmail.CreateDeliverabilityTestReport import Amazonka.PinpointEmail.CreateEmailIdentity import Amazonka.PinpointEmail.DeleteConfigurationSet import Amazonka.PinpointEmail.DeleteConfigurationSetEventDestination import Amazonka.PinpointEmail.DeleteDedicatedIpPool import Amazonka.PinpointEmail.DeleteEmailIdentity import Amazonka.PinpointEmail.GetAccount import Amazonka.PinpointEmail.GetBlacklistReports import Amazonka.PinpointEmail.GetConfigurationSet import Amazonka.PinpointEmail.GetConfigurationSetEventDestinations import Amazonka.PinpointEmail.GetDedicatedIp import Amazonka.PinpointEmail.GetDedicatedIps import Amazonka.PinpointEmail.GetDeliverabilityDashboardOptions import Amazonka.PinpointEmail.GetDeliverabilityTestReport import Amazonka.PinpointEmail.GetDomainDeliverabilityCampaign import Amazonka.PinpointEmail.GetDomainStatisticsReport import Amazonka.PinpointEmail.GetEmailIdentity import Amazonka.PinpointEmail.Lens import Amazonka.PinpointEmail.ListConfigurationSets import Amazonka.PinpointEmail.ListDedicatedIpPools import Amazonka.PinpointEmail.ListDeliverabilityTestReports import Amazonka.PinpointEmail.ListDomainDeliverabilityCampaigns import Amazonka.PinpointEmail.ListEmailIdentities import Amazonka.PinpointEmail.ListTagsForResource import Amazonka.PinpointEmail.PutAccountDedicatedIpWarmupAttributes import Amazonka.PinpointEmail.PutAccountSendingAttributes import Amazonka.PinpointEmail.PutConfigurationSetDeliveryOptions import Amazonka.PinpointEmail.PutConfigurationSetReputationOptions import Amazonka.PinpointEmail.PutConfigurationSetSendingOptions import Amazonka.PinpointEmail.PutConfigurationSetTrackingOptions import Amazonka.PinpointEmail.PutDedicatedIpInPool import Amazonka.PinpointEmail.PutDedicatedIpWarmupAttributes import Amazonka.PinpointEmail.PutDeliverabilityDashboardOption import Amazonka.PinpointEmail.PutEmailIdentityDkimAttributes import Amazonka.PinpointEmail.PutEmailIdentityFeedbackAttributes import Amazonka.PinpointEmail.PutEmailIdentityMailFromAttributes import Amazonka.PinpointEmail.SendEmail import Amazonka.PinpointEmail.TagResource import Amazonka.PinpointEmail.Types import Amazonka.PinpointEmail.UntagResource import Amazonka.PinpointEmail.UpdateConfigurationSetEventDestination import Amazonka.PinpointEmail.Waiters -- $errors -- Error matchers are designed for use with the functions provided by -- . -- This allows catching (and rethrowing) service specific errors returned -- by 'PinpointEmail'. -- $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. -- $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.