| 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.SESV2.Types
Contents
- Service Configuration
- Errors
- BehaviorOnMxFailure
- BulkEmailStatus
- ContactLanguage
- ContactListImportAction
- DataFormat
- DeliverabilityDashboardAccountStatus
- DeliverabilityTestStatus
- DimensionValueSource
- DkimSigningAttributesOrigin
- DkimSigningKeyLength
- DkimStatus
- EventType
- IdentityType
- ImportDestinationType
- JobStatus
- MailFromDomainStatus
- MailType
- ReviewStatus
- SubscriptionStatus
- SuppressionListImportAction
- SuppressionListReason
- TlsPolicy
- WarmupStatus
- AccountDetails
- BlacklistEntry
- Body
- BulkEmailContent
- BulkEmailEntry
- BulkEmailEntryResult
- CloudWatchDestination
- CloudWatchDimensionConfiguration
- Contact
- ContactList
- ContactListDestination
- Content
- CustomVerificationEmailTemplateMetadata
- DailyVolume
- DedicatedIp
- DeliverabilityTestReport
- DeliveryOptions
- Destination
- DkimAttributes
- DkimSigningAttributes
- DomainDeliverabilityCampaign
- DomainDeliverabilityTrackingOption
- DomainIspPlacement
- EmailContent
- EmailTemplateContent
- EmailTemplateMetadata
- EventDestination
- EventDestinationDefinition
- FailureInfo
- IdentityInfo
- ImportDataSource
- ImportDestination
- ImportJobSummary
- InboxPlacementTrackingOption
- IspPlacement
- KinesisFirehoseDestination
- ListContactsFilter
- ListManagementOptions
- MailFromAttributes
- Message
- MessageTag
- OverallVolume
- PinpointDestination
- PlacementStatistics
- RawMessage
- ReplacementEmailContent
- ReplacementTemplate
- ReputationOptions
- ReviewDetails
- SendQuota
- SendingOptions
- SnsDestination
- SuppressedDestination
- SuppressedDestinationAttributes
- SuppressedDestinationSummary
- SuppressionAttributes
- SuppressionListDestination
- SuppressionOptions
- Tag
- Template
- Topic
- TopicFilter
- TopicPreference
- TrackingOptions
- VolumeStatistics
Description
Synopsis
- defaultService :: Service
- _MessageRejected :: AsError a => Getting (First ServiceError) a ServiceError
- _MailFromDomainNotVerifiedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: 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
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccountSuspendedException :: AsError a => Getting (First ServiceError) a ServiceError
- _SendingPausedException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype BehaviorOnMxFailure where
- newtype BulkEmailStatus where
- BulkEmailStatus' { }
- pattern BulkEmailStatus_ACCOUNT_DAILY_QUOTA_EXCEEDED :: BulkEmailStatus
- pattern BulkEmailStatus_ACCOUNT_SENDING_PAUSED :: BulkEmailStatus
- pattern BulkEmailStatus_ACCOUNT_SUSPENDED :: BulkEmailStatus
- pattern BulkEmailStatus_ACCOUNT_THROTTLED :: BulkEmailStatus
- pattern BulkEmailStatus_CONFIGURATION_SET_NOT_FOUND :: BulkEmailStatus
- pattern BulkEmailStatus_CONFIGURATION_SET_SENDING_PAUSED :: BulkEmailStatus
- pattern BulkEmailStatus_FAILED :: BulkEmailStatus
- pattern BulkEmailStatus_INVALID_PARAMETER :: BulkEmailStatus
- pattern BulkEmailStatus_INVALID_SENDING_POOL_NAME :: BulkEmailStatus
- pattern BulkEmailStatus_MAIL_FROM_DOMAIN_NOT_VERIFIED :: BulkEmailStatus
- pattern BulkEmailStatus_MESSAGE_REJECTED :: BulkEmailStatus
- pattern BulkEmailStatus_SUCCESS :: BulkEmailStatus
- pattern BulkEmailStatus_TEMPLATE_NOT_FOUND :: BulkEmailStatus
- pattern BulkEmailStatus_TRANSIENT_FAILURE :: BulkEmailStatus
- newtype ContactLanguage where
- ContactLanguage' { }
- pattern ContactLanguage_EN :: ContactLanguage
- pattern ContactLanguage_JA :: ContactLanguage
- newtype ContactListImportAction where
- newtype DataFormat where
- DataFormat' { }
- pattern DataFormat_CSV :: DataFormat
- pattern DataFormat_JSON :: DataFormat
- newtype DeliverabilityDashboardAccountStatus where
- DeliverabilityDashboardAccountStatus' { }
- pattern DeliverabilityDashboardAccountStatus_ACTIVE :: DeliverabilityDashboardAccountStatus
- pattern DeliverabilityDashboardAccountStatus_DISABLED :: DeliverabilityDashboardAccountStatus
- pattern DeliverabilityDashboardAccountStatus_PENDING_EXPIRATION :: DeliverabilityDashboardAccountStatus
- newtype DeliverabilityTestStatus where
- newtype DimensionValueSource where
- newtype DkimSigningAttributesOrigin where
- newtype DkimSigningKeyLength 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_DELIVERY_DELAY :: EventType
- pattern EventType_OPEN :: EventType
- pattern EventType_REJECT :: EventType
- pattern EventType_RENDERING_FAILURE :: EventType
- pattern EventType_SEND :: EventType
- pattern EventType_SUBSCRIPTION :: EventType
- newtype IdentityType where
- IdentityType' { }
- pattern IdentityType_DOMAIN :: IdentityType
- pattern IdentityType_EMAIL_ADDRESS :: IdentityType
- pattern IdentityType_MANAGED_DOMAIN :: IdentityType
- newtype ImportDestinationType where
- newtype JobStatus where
- JobStatus' { }
- pattern JobStatus_COMPLETED :: JobStatus
- pattern JobStatus_CREATED :: JobStatus
- pattern JobStatus_FAILED :: JobStatus
- pattern JobStatus_PROCESSING :: JobStatus
- newtype MailFromDomainStatus where
- newtype MailType where
- MailType' {
- fromMailType :: Text
- pattern MailType_MARKETING :: MailType
- pattern MailType_TRANSACTIONAL :: MailType
- MailType' {
- newtype ReviewStatus where
- ReviewStatus' { }
- pattern ReviewStatus_DENIED :: ReviewStatus
- pattern ReviewStatus_FAILED :: ReviewStatus
- pattern ReviewStatus_GRANTED :: ReviewStatus
- pattern ReviewStatus_PENDING :: ReviewStatus
- newtype SubscriptionStatus where
- SubscriptionStatus' { }
- pattern SubscriptionStatus_OPT_IN :: SubscriptionStatus
- pattern SubscriptionStatus_OPT_OUT :: SubscriptionStatus
- newtype SuppressionListImportAction where
- newtype SuppressionListReason 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 AccountDetails = AccountDetails' {}
- newAccountDetails :: AccountDetails
- accountDetails_reviewDetails :: Lens' AccountDetails (Maybe ReviewDetails)
- accountDetails_mailType :: Lens' AccountDetails (Maybe MailType)
- accountDetails_useCaseDescription :: Lens' AccountDetails (Maybe Text)
- accountDetails_contactLanguage :: Lens' AccountDetails (Maybe ContactLanguage)
- accountDetails_additionalContactEmailAddresses :: Lens' AccountDetails (Maybe (NonEmpty Text))
- accountDetails_websiteURL :: Lens' AccountDetails (Maybe Text)
- data BlacklistEntry = BlacklistEntry' {
- listingTime :: Maybe POSIX
- rblName :: Maybe Text
- description :: Maybe Text
- newBlacklistEntry :: BlacklistEntry
- blacklistEntry_listingTime :: Lens' BlacklistEntry (Maybe UTCTime)
- blacklistEntry_rblName :: Lens' BlacklistEntry (Maybe Text)
- blacklistEntry_description :: Lens' BlacklistEntry (Maybe Text)
- data Body = Body' {}
- newBody :: Body
- body_text :: Lens' Body (Maybe Content)
- body_html :: Lens' Body (Maybe Content)
- data BulkEmailContent = BulkEmailContent' {}
- newBulkEmailContent :: BulkEmailContent
- bulkEmailContent_template :: Lens' BulkEmailContent (Maybe Template)
- data BulkEmailEntry = BulkEmailEntry' {}
- newBulkEmailEntry :: Destination -> BulkEmailEntry
- bulkEmailEntry_replacementEmailContent :: Lens' BulkEmailEntry (Maybe ReplacementEmailContent)
- bulkEmailEntry_replacementTags :: Lens' BulkEmailEntry (Maybe [MessageTag])
- bulkEmailEntry_destination :: Lens' BulkEmailEntry Destination
- data BulkEmailEntryResult = BulkEmailEntryResult' {}
- newBulkEmailEntryResult :: BulkEmailEntryResult
- bulkEmailEntryResult_status :: Lens' BulkEmailEntryResult (Maybe BulkEmailStatus)
- bulkEmailEntryResult_error :: Lens' BulkEmailEntryResult (Maybe Text)
- bulkEmailEntryResult_messageId :: Lens' BulkEmailEntryResult (Maybe Text)
- data CloudWatchDestination = CloudWatchDestination' {}
- newCloudWatchDestination :: CloudWatchDestination
- cloudWatchDestination_dimensionConfigurations :: Lens' CloudWatchDestination [CloudWatchDimensionConfiguration]
- data CloudWatchDimensionConfiguration = CloudWatchDimensionConfiguration' {}
- newCloudWatchDimensionConfiguration :: Text -> DimensionValueSource -> Text -> CloudWatchDimensionConfiguration
- cloudWatchDimensionConfiguration_dimensionName :: Lens' CloudWatchDimensionConfiguration Text
- cloudWatchDimensionConfiguration_dimensionValueSource :: Lens' CloudWatchDimensionConfiguration DimensionValueSource
- cloudWatchDimensionConfiguration_defaultDimensionValue :: Lens' CloudWatchDimensionConfiguration Text
- data Contact = Contact' {}
- newContact :: Contact
- contact_unsubscribeAll :: Lens' Contact (Maybe Bool)
- contact_topicDefaultPreferences :: Lens' Contact (Maybe [TopicPreference])
- contact_emailAddress :: Lens' Contact (Maybe Text)
- contact_lastUpdatedTimestamp :: Lens' Contact (Maybe UTCTime)
- contact_topicPreferences :: Lens' Contact (Maybe [TopicPreference])
- data ContactList = ContactList' {}
- newContactList :: ContactList
- contactList_contactListName :: Lens' ContactList (Maybe Text)
- contactList_lastUpdatedTimestamp :: Lens' ContactList (Maybe UTCTime)
- data ContactListDestination = ContactListDestination' {}
- newContactListDestination :: Text -> ContactListImportAction -> ContactListDestination
- contactListDestination_contactListName :: Lens' ContactListDestination Text
- contactListDestination_contactListImportAction :: Lens' ContactListDestination ContactListImportAction
- data Content = Content' {}
- newContent :: Text -> Content
- content_charset :: Lens' Content (Maybe Text)
- content_data :: Lens' Content Text
- data CustomVerificationEmailTemplateMetadata = CustomVerificationEmailTemplateMetadata' {}
- newCustomVerificationEmailTemplateMetadata :: CustomVerificationEmailTemplateMetadata
- customVerificationEmailTemplateMetadata_fromEmailAddress :: Lens' CustomVerificationEmailTemplateMetadata (Maybe Text)
- customVerificationEmailTemplateMetadata_templateName :: Lens' CustomVerificationEmailTemplateMetadata (Maybe Text)
- customVerificationEmailTemplateMetadata_failureRedirectionURL :: Lens' CustomVerificationEmailTemplateMetadata (Maybe Text)
- customVerificationEmailTemplateMetadata_templateSubject :: Lens' CustomVerificationEmailTemplateMetadata (Maybe Text)
- customVerificationEmailTemplateMetadata_successRedirectionURL :: Lens' CustomVerificationEmailTemplateMetadata (Maybe Text)
- data DailyVolume = DailyVolume' {}
- newDailyVolume :: DailyVolume
- dailyVolume_domainIspPlacements :: Lens' DailyVolume (Maybe [DomainIspPlacement])
- dailyVolume_startDate :: Lens' DailyVolume (Maybe UTCTime)
- dailyVolume_volumeStatistics :: Lens' DailyVolume (Maybe VolumeStatistics)
- data DedicatedIp = DedicatedIp' {
- poolName :: Maybe Text
- ip :: Text
- warmupStatus :: WarmupStatus
- warmupPercentage :: Int
- newDedicatedIp :: Text -> WarmupStatus -> Int -> DedicatedIp
- dedicatedIp_poolName :: Lens' DedicatedIp (Maybe Text)
- dedicatedIp_ip :: Lens' DedicatedIp Text
- dedicatedIp_warmupStatus :: Lens' DedicatedIp WarmupStatus
- dedicatedIp_warmupPercentage :: Lens' DedicatedIp Int
- data DeliverabilityTestReport = DeliverabilityTestReport' {}
- newDeliverabilityTestReport :: DeliverabilityTestReport
- deliverabilityTestReport_subject :: Lens' DeliverabilityTestReport (Maybe Text)
- deliverabilityTestReport_fromEmailAddress :: Lens' DeliverabilityTestReport (Maybe Text)
- deliverabilityTestReport_createDate :: Lens' DeliverabilityTestReport (Maybe UTCTime)
- deliverabilityTestReport_reportId :: Lens' DeliverabilityTestReport (Maybe Text)
- deliverabilityTestReport_reportName :: Lens' DeliverabilityTestReport (Maybe Text)
- deliverabilityTestReport_deliverabilityTestStatus :: Lens' DeliverabilityTestReport (Maybe DeliverabilityTestStatus)
- data DeliveryOptions = DeliveryOptions' {}
- newDeliveryOptions :: DeliveryOptions
- deliveryOptions_sendingPoolName :: Lens' DeliveryOptions (Maybe Text)
- deliveryOptions_tlsPolicy :: Lens' DeliveryOptions (Maybe TlsPolicy)
- data Destination = Destination' {
- bccAddresses :: Maybe [Text]
- ccAddresses :: Maybe [Text]
- toAddresses :: Maybe [Text]
- newDestination :: Destination
- destination_bccAddresses :: Lens' Destination (Maybe [Text])
- destination_ccAddresses :: Lens' Destination (Maybe [Text])
- destination_toAddresses :: Lens' Destination (Maybe [Text])
- data DkimAttributes = DkimAttributes' {}
- newDkimAttributes :: DkimAttributes
- dkimAttributes_status :: Lens' DkimAttributes (Maybe DkimStatus)
- dkimAttributes_nextSigningKeyLength :: Lens' DkimAttributes (Maybe DkimSigningKeyLength)
- dkimAttributes_tokens :: Lens' DkimAttributes (Maybe [Text])
- dkimAttributes_signingEnabled :: Lens' DkimAttributes (Maybe Bool)
- dkimAttributes_currentSigningKeyLength :: Lens' DkimAttributes (Maybe DkimSigningKeyLength)
- dkimAttributes_lastKeyGenerationTimestamp :: Lens' DkimAttributes (Maybe UTCTime)
- dkimAttributes_signingAttributesOrigin :: Lens' DkimAttributes (Maybe DkimSigningAttributesOrigin)
- data DkimSigningAttributes = DkimSigningAttributes' {}
- newDkimSigningAttributes :: DkimSigningAttributes
- dkimSigningAttributes_nextSigningKeyLength :: Lens' DkimSigningAttributes (Maybe DkimSigningKeyLength)
- dkimSigningAttributes_domainSigningPrivateKey :: Lens' DkimSigningAttributes (Maybe Text)
- dkimSigningAttributes_domainSigningSelector :: Lens' DkimSigningAttributes (Maybe Text)
- data DomainDeliverabilityCampaign = DomainDeliverabilityCampaign' {
- spamCount :: Maybe Integer
- subject :: Maybe Text
- esps :: Maybe [Text]
- fromAddress :: Maybe Text
- deleteRate :: Maybe Double
- campaignId :: Maybe Text
- sendingIps :: Maybe [Text]
- firstSeenDateTime :: Maybe POSIX
- inboxCount :: Maybe Integer
- readDeleteRate :: Maybe Double
- projectedVolume :: Maybe Integer
- imageUrl :: Maybe Text
- readRate :: Maybe Double
- lastSeenDateTime :: Maybe POSIX
- newDomainDeliverabilityCampaign :: DomainDeliverabilityCampaign
- domainDeliverabilityCampaign_spamCount :: Lens' DomainDeliverabilityCampaign (Maybe Integer)
- domainDeliverabilityCampaign_subject :: Lens' DomainDeliverabilityCampaign (Maybe Text)
- domainDeliverabilityCampaign_esps :: Lens' DomainDeliverabilityCampaign (Maybe [Text])
- domainDeliverabilityCampaign_fromAddress :: Lens' DomainDeliverabilityCampaign (Maybe Text)
- domainDeliverabilityCampaign_deleteRate :: Lens' DomainDeliverabilityCampaign (Maybe Double)
- domainDeliverabilityCampaign_campaignId :: Lens' DomainDeliverabilityCampaign (Maybe Text)
- domainDeliverabilityCampaign_sendingIps :: Lens' DomainDeliverabilityCampaign (Maybe [Text])
- domainDeliverabilityCampaign_firstSeenDateTime :: Lens' DomainDeliverabilityCampaign (Maybe UTCTime)
- domainDeliverabilityCampaign_inboxCount :: Lens' DomainDeliverabilityCampaign (Maybe Integer)
- domainDeliverabilityCampaign_readDeleteRate :: Lens' DomainDeliverabilityCampaign (Maybe Double)
- domainDeliverabilityCampaign_projectedVolume :: Lens' DomainDeliverabilityCampaign (Maybe Integer)
- domainDeliverabilityCampaign_imageUrl :: Lens' DomainDeliverabilityCampaign (Maybe Text)
- domainDeliverabilityCampaign_readRate :: Lens' DomainDeliverabilityCampaign (Maybe Double)
- domainDeliverabilityCampaign_lastSeenDateTime :: Lens' DomainDeliverabilityCampaign (Maybe UTCTime)
- data DomainDeliverabilityTrackingOption = DomainDeliverabilityTrackingOption' {}
- newDomainDeliverabilityTrackingOption :: DomainDeliverabilityTrackingOption
- domainDeliverabilityTrackingOption_domain :: Lens' DomainDeliverabilityTrackingOption (Maybe Text)
- domainDeliverabilityTrackingOption_subscriptionStartDate :: Lens' DomainDeliverabilityTrackingOption (Maybe UTCTime)
- domainDeliverabilityTrackingOption_inboxPlacementTrackingOption :: Lens' DomainDeliverabilityTrackingOption (Maybe InboxPlacementTrackingOption)
- data DomainIspPlacement = DomainIspPlacement' {}
- newDomainIspPlacement :: DomainIspPlacement
- domainIspPlacement_spamPercentage :: Lens' DomainIspPlacement (Maybe Double)
- domainIspPlacement_inboxRawCount :: Lens' DomainIspPlacement (Maybe Integer)
- domainIspPlacement_ispName :: Lens' DomainIspPlacement (Maybe Text)
- domainIspPlacement_inboxPercentage :: Lens' DomainIspPlacement (Maybe Double)
- domainIspPlacement_spamRawCount :: Lens' DomainIspPlacement (Maybe Integer)
- data EmailContent = EmailContent' {}
- newEmailContent :: EmailContent
- emailContent_raw :: Lens' EmailContent (Maybe RawMessage)
- emailContent_simple :: Lens' EmailContent (Maybe Message)
- emailContent_template :: Lens' EmailContent (Maybe Template)
- data EmailTemplateContent = EmailTemplateContent' {}
- newEmailTemplateContent :: EmailTemplateContent
- emailTemplateContent_subject :: Lens' EmailTemplateContent (Maybe Text)
- emailTemplateContent_text :: Lens' EmailTemplateContent (Maybe Text)
- emailTemplateContent_html :: Lens' EmailTemplateContent (Maybe Text)
- data EmailTemplateMetadata = EmailTemplateMetadata' {}
- newEmailTemplateMetadata :: EmailTemplateMetadata
- emailTemplateMetadata_templateName :: Lens' EmailTemplateMetadata (Maybe Text)
- emailTemplateMetadata_createdTimestamp :: Lens' EmailTemplateMetadata (Maybe UTCTime)
- data EventDestination = EventDestination' {}
- newEventDestination :: Text -> EventDestination
- eventDestination_pinpointDestination :: Lens' EventDestination (Maybe PinpointDestination)
- eventDestination_enabled :: Lens' EventDestination (Maybe Bool)
- eventDestination_kinesisFirehoseDestination :: Lens' EventDestination (Maybe KinesisFirehoseDestination)
- eventDestination_cloudWatchDestination :: Lens' EventDestination (Maybe CloudWatchDestination)
- eventDestination_snsDestination :: Lens' EventDestination (Maybe SnsDestination)
- eventDestination_name :: Lens' EventDestination Text
- eventDestination_matchingEventTypes :: Lens' EventDestination [EventType]
- data EventDestinationDefinition = EventDestinationDefinition' {}
- newEventDestinationDefinition :: EventDestinationDefinition
- eventDestinationDefinition_matchingEventTypes :: Lens' EventDestinationDefinition (Maybe [EventType])
- eventDestinationDefinition_pinpointDestination :: Lens' EventDestinationDefinition (Maybe PinpointDestination)
- eventDestinationDefinition_enabled :: Lens' EventDestinationDefinition (Maybe Bool)
- eventDestinationDefinition_kinesisFirehoseDestination :: Lens' EventDestinationDefinition (Maybe KinesisFirehoseDestination)
- eventDestinationDefinition_cloudWatchDestination :: Lens' EventDestinationDefinition (Maybe CloudWatchDestination)
- eventDestinationDefinition_snsDestination :: Lens' EventDestinationDefinition (Maybe SnsDestination)
- data FailureInfo = FailureInfo' {}
- newFailureInfo :: FailureInfo
- failureInfo_failedRecordsS3Url :: Lens' FailureInfo (Maybe Text)
- failureInfo_errorMessage :: Lens' FailureInfo (Maybe Text)
- data IdentityInfo = IdentityInfo' {}
- newIdentityInfo :: IdentityInfo
- identityInfo_identityType :: Lens' IdentityInfo (Maybe IdentityType)
- identityInfo_identityName :: Lens' IdentityInfo (Maybe Text)
- identityInfo_sendingEnabled :: Lens' IdentityInfo (Maybe Bool)
- data ImportDataSource = ImportDataSource' {
- s3Url :: Text
- dataFormat :: DataFormat
- newImportDataSource :: Text -> DataFormat -> ImportDataSource
- importDataSource_s3Url :: Lens' ImportDataSource Text
- importDataSource_dataFormat :: Lens' ImportDataSource DataFormat
- data ImportDestination = ImportDestination' {}
- newImportDestination :: ImportDestination
- importDestination_suppressionListDestination :: Lens' ImportDestination (Maybe SuppressionListDestination)
- importDestination_contactListDestination :: Lens' ImportDestination (Maybe ContactListDestination)
- data ImportJobSummary = ImportJobSummary' {}
- newImportJobSummary :: ImportJobSummary
- importJobSummary_jobId :: Lens' ImportJobSummary (Maybe Text)
- importJobSummary_importDestination :: Lens' ImportJobSummary (Maybe ImportDestination)
- importJobSummary_jobStatus :: Lens' ImportJobSummary (Maybe JobStatus)
- importJobSummary_createdTimestamp :: Lens' ImportJobSummary (Maybe UTCTime)
- data InboxPlacementTrackingOption = InboxPlacementTrackingOption' {}
- newInboxPlacementTrackingOption :: InboxPlacementTrackingOption
- inboxPlacementTrackingOption_trackedIsps :: Lens' InboxPlacementTrackingOption (Maybe [Text])
- inboxPlacementTrackingOption_global :: Lens' InboxPlacementTrackingOption (Maybe Bool)
- data IspPlacement = IspPlacement' {}
- newIspPlacement :: IspPlacement
- ispPlacement_placementStatistics :: Lens' IspPlacement (Maybe PlacementStatistics)
- ispPlacement_ispName :: Lens' IspPlacement (Maybe Text)
- data KinesisFirehoseDestination = KinesisFirehoseDestination' {}
- newKinesisFirehoseDestination :: Text -> Text -> KinesisFirehoseDestination
- kinesisFirehoseDestination_iamRoleArn :: Lens' KinesisFirehoseDestination Text
- kinesisFirehoseDestination_deliveryStreamArn :: Lens' KinesisFirehoseDestination Text
- data ListContactsFilter = ListContactsFilter' {}
- newListContactsFilter :: ListContactsFilter
- listContactsFilter_filteredStatus :: Lens' ListContactsFilter (Maybe SubscriptionStatus)
- listContactsFilter_topicFilter :: Lens' ListContactsFilter (Maybe TopicFilter)
- data ListManagementOptions = ListManagementOptions' {}
- newListManagementOptions :: Text -> ListManagementOptions
- listManagementOptions_topicName :: Lens' ListManagementOptions (Maybe Text)
- listManagementOptions_contactListName :: Lens' ListManagementOptions Text
- data MailFromAttributes = MailFromAttributes' {}
- newMailFromAttributes :: Text -> MailFromDomainStatus -> BehaviorOnMxFailure -> MailFromAttributes
- mailFromAttributes_mailFromDomain :: Lens' MailFromAttributes Text
- mailFromAttributes_mailFromDomainStatus :: Lens' MailFromAttributes MailFromDomainStatus
- mailFromAttributes_behaviorOnMxFailure :: Lens' MailFromAttributes BehaviorOnMxFailure
- data Message = Message' {}
- newMessage :: Content -> Body -> Message
- message_subject :: Lens' Message Content
- message_body :: Lens' Message Body
- data MessageTag = MessageTag' {}
- newMessageTag :: Text -> Text -> MessageTag
- messageTag_name :: Lens' MessageTag Text
- messageTag_value :: Lens' MessageTag Text
- data OverallVolume = OverallVolume' {}
- newOverallVolume :: OverallVolume
- overallVolume_domainIspPlacements :: Lens' OverallVolume (Maybe [DomainIspPlacement])
- overallVolume_volumeStatistics :: Lens' OverallVolume (Maybe VolumeStatistics)
- overallVolume_readRatePercent :: Lens' OverallVolume (Maybe Double)
- data PinpointDestination = PinpointDestination' {}
- newPinpointDestination :: PinpointDestination
- pinpointDestination_applicationArn :: Lens' PinpointDestination (Maybe Text)
- data PlacementStatistics = PlacementStatistics' {}
- newPlacementStatistics :: PlacementStatistics
- placementStatistics_missingPercentage :: Lens' PlacementStatistics (Maybe Double)
- placementStatistics_spamPercentage :: Lens' PlacementStatistics (Maybe Double)
- placementStatistics_spfPercentage :: Lens' PlacementStatistics (Maybe Double)
- placementStatistics_dkimPercentage :: Lens' PlacementStatistics (Maybe Double)
- placementStatistics_inboxPercentage :: Lens' PlacementStatistics (Maybe Double)
- data RawMessage = RawMessage' {}
- newRawMessage :: ByteString -> RawMessage
- rawMessage_data :: Lens' RawMessage ByteString
- data ReplacementEmailContent = ReplacementEmailContent' {}
- newReplacementEmailContent :: ReplacementEmailContent
- replacementEmailContent_replacementTemplate :: Lens' ReplacementEmailContent (Maybe ReplacementTemplate)
- data ReplacementTemplate = ReplacementTemplate' {}
- newReplacementTemplate :: ReplacementTemplate
- replacementTemplate_replacementTemplateData :: Lens' ReplacementTemplate (Maybe Text)
- data ReputationOptions = ReputationOptions' {}
- newReputationOptions :: ReputationOptions
- reputationOptions_lastFreshStart :: Lens' ReputationOptions (Maybe UTCTime)
- reputationOptions_reputationMetricsEnabled :: Lens' ReputationOptions (Maybe Bool)
- data ReviewDetails = ReviewDetails' {}
- newReviewDetails :: ReviewDetails
- reviewDetails_status :: Lens' ReviewDetails (Maybe ReviewStatus)
- reviewDetails_caseId :: Lens' ReviewDetails (Maybe Text)
- data SendQuota = SendQuota' {}
- newSendQuota :: SendQuota
- sendQuota_maxSendRate :: Lens' SendQuota (Maybe Double)
- sendQuota_sentLast24Hours :: Lens' SendQuota (Maybe Double)
- sendQuota_max24HourSend :: Lens' SendQuota (Maybe Double)
- data SendingOptions = SendingOptions' {}
- newSendingOptions :: SendingOptions
- sendingOptions_sendingEnabled :: Lens' SendingOptions (Maybe Bool)
- data SnsDestination = SnsDestination' {}
- newSnsDestination :: Text -> SnsDestination
- snsDestination_topicArn :: Lens' SnsDestination Text
- data SuppressedDestination = SuppressedDestination' {}
- newSuppressedDestination :: Text -> SuppressionListReason -> UTCTime -> SuppressedDestination
- suppressedDestination_attributes :: Lens' SuppressedDestination (Maybe SuppressedDestinationAttributes)
- suppressedDestination_emailAddress :: Lens' SuppressedDestination Text
- suppressedDestination_reason :: Lens' SuppressedDestination SuppressionListReason
- suppressedDestination_lastUpdateTime :: Lens' SuppressedDestination UTCTime
- data SuppressedDestinationAttributes = SuppressedDestinationAttributes' {}
- newSuppressedDestinationAttributes :: SuppressedDestinationAttributes
- suppressedDestinationAttributes_feedbackId :: Lens' SuppressedDestinationAttributes (Maybe Text)
- suppressedDestinationAttributes_messageId :: Lens' SuppressedDestinationAttributes (Maybe Text)
- data SuppressedDestinationSummary = SuppressedDestinationSummary' {}
- newSuppressedDestinationSummary :: Text -> SuppressionListReason -> UTCTime -> SuppressedDestinationSummary
- suppressedDestinationSummary_emailAddress :: Lens' SuppressedDestinationSummary Text
- suppressedDestinationSummary_reason :: Lens' SuppressedDestinationSummary SuppressionListReason
- suppressedDestinationSummary_lastUpdateTime :: Lens' SuppressedDestinationSummary UTCTime
- data SuppressionAttributes = SuppressionAttributes' {}
- newSuppressionAttributes :: SuppressionAttributes
- suppressionAttributes_suppressedReasons :: Lens' SuppressionAttributes (Maybe [SuppressionListReason])
- data SuppressionListDestination = SuppressionListDestination' {}
- newSuppressionListDestination :: SuppressionListImportAction -> SuppressionListDestination
- suppressionListDestination_suppressionListImportAction :: Lens' SuppressionListDestination SuppressionListImportAction
- data SuppressionOptions = SuppressionOptions' {}
- newSuppressionOptions :: SuppressionOptions
- suppressionOptions_suppressedReasons :: Lens' SuppressionOptions (Maybe [SuppressionListReason])
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data Template = Template' {}
- newTemplate :: Template
- template_templateName :: Lens' Template (Maybe Text)
- template_templateArn :: Lens' Template (Maybe Text)
- template_templateData :: Lens' Template (Maybe Text)
- data Topic = Topic' {}
- newTopic :: Text -> Text -> SubscriptionStatus -> Topic
- topic_description :: Lens' Topic (Maybe Text)
- topic_topicName :: Lens' Topic Text
- topic_displayName :: Lens' Topic Text
- topic_defaultSubscriptionStatus :: Lens' Topic SubscriptionStatus
- data TopicFilter = TopicFilter' {}
- newTopicFilter :: TopicFilter
- topicFilter_topicName :: Lens' TopicFilter (Maybe Text)
- topicFilter_useDefaultIfPreferenceUnavailable :: Lens' TopicFilter (Maybe Bool)
- data TopicPreference = TopicPreference' {}
- newTopicPreference :: Text -> SubscriptionStatus -> TopicPreference
- topicPreference_topicName :: Lens' TopicPreference Text
- topicPreference_subscriptionStatus :: Lens' TopicPreference SubscriptionStatus
- data TrackingOptions = TrackingOptions' {}
- newTrackingOptions :: Text -> TrackingOptions
- trackingOptions_customRedirectDomain :: Lens' TrackingOptions Text
- data VolumeStatistics = VolumeStatistics' {}
- newVolumeStatistics :: VolumeStatistics
- volumeStatistics_inboxRawCount :: Lens' VolumeStatistics (Maybe Integer)
- volumeStatistics_projectedSpam :: Lens' VolumeStatistics (Maybe Integer)
- volumeStatistics_projectedInbox :: Lens' VolumeStatistics (Maybe Integer)
- volumeStatistics_spamRawCount :: Lens' VolumeStatistics (Maybe Integer)
Service Configuration
defaultService :: Service Source #
API version 2019-09-27 of the Amazon Simple Email Service SDK configuration.
Errors
_MessageRejected :: AsError a => Getting (First ServiceError) a ServiceError Source #
The message can't be sent because it contains invalid content.
_MailFromDomainNotVerifiedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The message can't be sent because the sending domain isn't verified.
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
If there is already an ongoing account details update under review.
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource you attempted to access doesn't exist.
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Too many requests have been made to the operation.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is being modified by another operation or thread.
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified request includes an invalid or expired token.
_AccountSuspendedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The message can't be sent because the account's ability to send email has been permanently restricted.
_SendingPausedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The message can't be sent because the account's ability to send email is currently paused.
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input you provided is invalid.
_AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource specified in your request already exists.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There are too many instances of the specified resource type.
BehaviorOnMxFailure
newtype BehaviorOnMxFailure Source #
The action to take if the required MX record can't be found when you
send an email. When you set this value to UseDefaultValue, the mail is
sent using amazonses.com as the MAIL FROM domain. When you set this
value to RejectMessage, the Amazon SES API v2 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
BulkEmailStatus
newtype BulkEmailStatus Source #
Constructors
| BulkEmailStatus' | |
Fields | |
Bundled Patterns
| pattern BulkEmailStatus_ACCOUNT_DAILY_QUOTA_EXCEEDED :: BulkEmailStatus | |
| pattern BulkEmailStatus_ACCOUNT_SENDING_PAUSED :: BulkEmailStatus | |
| pattern BulkEmailStatus_ACCOUNT_SUSPENDED :: BulkEmailStatus | |
| pattern BulkEmailStatus_ACCOUNT_THROTTLED :: BulkEmailStatus | |
| pattern BulkEmailStatus_CONFIGURATION_SET_NOT_FOUND :: BulkEmailStatus | |
| pattern BulkEmailStatus_CONFIGURATION_SET_SENDING_PAUSED :: BulkEmailStatus | |
| pattern BulkEmailStatus_FAILED :: BulkEmailStatus | |
| pattern BulkEmailStatus_INVALID_PARAMETER :: BulkEmailStatus | |
| pattern BulkEmailStatus_INVALID_SENDING_POOL_NAME :: BulkEmailStatus | |
| pattern BulkEmailStatus_MAIL_FROM_DOMAIN_NOT_VERIFIED :: BulkEmailStatus | |
| pattern BulkEmailStatus_MESSAGE_REJECTED :: BulkEmailStatus | |
| pattern BulkEmailStatus_SUCCESS :: BulkEmailStatus | |
| pattern BulkEmailStatus_TEMPLATE_NOT_FOUND :: BulkEmailStatus | |
| pattern BulkEmailStatus_TRANSIENT_FAILURE :: BulkEmailStatus |
Instances
ContactLanguage
newtype ContactLanguage Source #
Constructors
| ContactLanguage' | |
Fields | |
Bundled Patterns
| pattern ContactLanguage_EN :: ContactLanguage | |
| pattern ContactLanguage_JA :: ContactLanguage |
Instances
ContactListImportAction
newtype ContactListImportAction Source #
Constructors
| ContactListImportAction' | |
Fields | |
Bundled Patterns
| pattern ContactListImportAction_DELETE :: ContactListImportAction | |
| pattern ContactListImportAction_PUT :: ContactListImportAction |
Instances
DataFormat
newtype DataFormat Source #
The data format of the import job's data source.
Constructors
| DataFormat' | |
Fields | |
Bundled Patterns
| pattern DataFormat_CSV :: DataFormat | |
| pattern DataFormat_JSON :: DataFormat |
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 the Amazon SES API v2 finds the value of a dimension
to publish to Amazon CloudWatch. To use the message tags that you
specify using an X-SES-MESSAGE-TAGS header or a parameter to the
SendEmail or SendRawEmail API, choose messageTag. To use your own
email headers, choose emailHeader. 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
DkimSigningAttributesOrigin
newtype DkimSigningAttributesOrigin Source #
Constructors
| DkimSigningAttributesOrigin' | |
Fields | |
Bundled Patterns
| pattern DkimSigningAttributesOrigin_AWS_SES :: DkimSigningAttributesOrigin | |
| pattern DkimSigningAttributesOrigin_EXTERNAL :: DkimSigningAttributesOrigin |
Instances
DkimSigningKeyLength
newtype DkimSigningKeyLength Source #
Constructors
| DkimSigningKeyLength' | |
Fields | |
Bundled Patterns
| pattern DkimSigningKeyLength_RSA_1024_BIT :: DkimSigningKeyLength | |
| pattern DkimSigningKeyLength_RSA_2048_BIT :: DkimSigningKeyLength |
Instances
DkimStatus
newtype DkimStatus Source #
The DKIM authentication status of the identity. The status can be one of the following:
PENDING– The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.SUCCESS– The verification process completed successfully.FAILED– The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.TEMPORARY_FAILURE– A temporary issue is preventing Amazon SES 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_DELIVERY_DELAY :: EventType | |
| pattern EventType_OPEN :: EventType | |
| pattern EventType_REJECT :: EventType | |
| pattern EventType_RENDERING_FAILURE :: EventType | |
| pattern EventType_SEND :: EventType | |
| pattern EventType_SUBSCRIPTION :: EventType |
Instances
IdentityType
newtype IdentityType Source #
Constructors
| IdentityType' | |
Fields | |
Bundled Patterns
| pattern IdentityType_DOMAIN :: IdentityType | |
| pattern IdentityType_EMAIL_ADDRESS :: IdentityType | |
| pattern IdentityType_MANAGED_DOMAIN :: IdentityType |
Instances
ImportDestinationType
newtype ImportDestinationType Source #
The destination of the import job, which can be used to list import jobs
that have a certain ImportDestinationType.
Constructors
| ImportDestinationType' | |
Fields | |
Bundled Patterns
| pattern ImportDestinationType_CONTACT_LIST :: ImportDestinationType | |
| pattern ImportDestinationType_SUPPRESSION_LIST :: ImportDestinationType |
Instances
JobStatus
The status of the import job.
Constructors
| JobStatus' | |
Fields | |
Bundled Patterns
| pattern JobStatus_COMPLETED :: JobStatus | |
| pattern JobStatus_CREATED :: JobStatus | |
| pattern JobStatus_FAILED :: JobStatus | |
| pattern JobStatus_PROCESSING :: JobStatus |
Instances
MailFromDomainStatus
newtype MailFromDomainStatus Source #
The status of the MAIL FROM domain. This status can have the following values:
PENDING– Amazon SES hasn't started searching for the MX record yet.SUCCESS– Amazon SES detected the required MX record for the MAIL FROM domain.FAILED– Amazon SES can't find the required MX record, or the record no longer exists.TEMPORARY_FAILURE– A temporary issue occurred, which prevented Amazon SES 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
MailType
Constructors
| MailType' | |
Fields
| |
Bundled Patterns
| pattern MailType_MARKETING :: MailType | |
| pattern MailType_TRANSACTIONAL :: MailType |
Instances
ReviewStatus
newtype ReviewStatus Source #
Constructors
| ReviewStatus' | |
Fields | |
Bundled Patterns
| pattern ReviewStatus_DENIED :: ReviewStatus | |
| pattern ReviewStatus_FAILED :: ReviewStatus | |
| pattern ReviewStatus_GRANTED :: ReviewStatus | |
| pattern ReviewStatus_PENDING :: ReviewStatus |
Instances
SubscriptionStatus
newtype SubscriptionStatus Source #
Constructors
| SubscriptionStatus' | |
Fields | |
Bundled Patterns
| pattern SubscriptionStatus_OPT_IN :: SubscriptionStatus | |
| pattern SubscriptionStatus_OPT_OUT :: SubscriptionStatus |
Instances
SuppressionListImportAction
newtype SuppressionListImportAction Source #
The type of action to perform on the address. The following are possible values:
- PUT: add the addresses to the suppression list.
- DELETE: remove the address from the suppression list.
Constructors
| SuppressionListImportAction' | |
Fields | |
Bundled Patterns
| pattern SuppressionListImportAction_DELETE :: SuppressionListImportAction | |
| pattern SuppressionListImportAction_PUT :: SuppressionListImportAction |
Instances
SuppressionListReason
newtype SuppressionListReason Source #
The reason that the address was added to the suppression list for your account. The value can be one of the following:
COMPLAINT– Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a complaint.BOUNCE– Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a hard bounce.
Constructors
| SuppressionListReason' | |
Fields | |
Bundled Patterns
| pattern SuppressionListReason_BOUNCE :: SuppressionListReason | |
| pattern SuppressionListReason_COMPLAINT :: SuppressionListReason |
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
AccountDetails
data AccountDetails Source #
An object that contains information about your account details.
See: newAccountDetails smart constructor.
Constructors
| AccountDetails' | |
Fields
| |
Instances
newAccountDetails :: AccountDetails Source #
Create a value of AccountDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reviewDetails:AccountDetails', accountDetails_reviewDetails - Information about the review of the latest details you submitted.
$sel:mailType:AccountDetails', accountDetails_mailType - The type of email your account is sending. The mail type can be one of
the following:
MARKETING– Most of your sending traffic is to keep your customers informed of your latest offering.TRANSACTIONAL– Most of your sending traffic is to communicate during a transaction with a customer.
$sel:useCaseDescription:AccountDetails', accountDetails_useCaseDescription - A description of the types of email that you plan to send.
$sel:contactLanguage:AccountDetails', accountDetails_contactLanguage - The language you would prefer for the case. The contact language can be
one of ENGLISH or JAPANESE.
$sel:additionalContactEmailAddresses:AccountDetails', accountDetails_additionalContactEmailAddresses - Additional email addresses where updates are sent about your account
review process.
$sel:websiteURL:AccountDetails', accountDetails_websiteURL - The URL of your website. This information helps us better understand the
type of content that you plan to send.
accountDetails_reviewDetails :: Lens' AccountDetails (Maybe ReviewDetails) Source #
Information about the review of the latest details you submitted.
accountDetails_mailType :: Lens' AccountDetails (Maybe MailType) Source #
The type of email your account is sending. The mail type can be one of the following:
MARKETING– Most of your sending traffic is to keep your customers informed of your latest offering.TRANSACTIONAL– Most of your sending traffic is to communicate during a transaction with a customer.
accountDetails_useCaseDescription :: Lens' AccountDetails (Maybe Text) Source #
A description of the types of email that you plan to send.
accountDetails_contactLanguage :: Lens' AccountDetails (Maybe ContactLanguage) Source #
The language you would prefer for the case. The contact language can be
one of ENGLISH or JAPANESE.
accountDetails_additionalContactEmailAddresses :: Lens' AccountDetails (Maybe (NonEmpty Text)) Source #
Additional email addresses where updates are sent about your account review process.
accountDetails_websiteURL :: Lens' AccountDetails (Maybe Text) Source #
The URL of your website. This information helps us better understand the type of content that you plan to send.
BlacklistEntry
data BlacklistEntry Source #
An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.
See: newBlacklistEntry smart constructor.
Constructors
| BlacklistEntry' | |
Fields
| |
Instances
newBlacklistEntry :: BlacklistEntry Source #
Create a value of BlacklistEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:listingTime:BlacklistEntry', blacklistEntry_listingTime - The time when the blacklisting event occurred, shown in Unix time
format.
$sel:rblName:BlacklistEntry', blacklistEntry_rblName - The name of the blacklist that the IP address appears on.
$sel:description:BlacklistEntry', blacklistEntry_description - Additional information about the blacklisting event, as provided by the
blacklist maintainer.
blacklistEntry_listingTime :: Lens' BlacklistEntry (Maybe UTCTime) Source #
The time when the blacklisting event occurred, shown in Unix time format.
blacklistEntry_rblName :: Lens' BlacklistEntry (Maybe Text) Source #
The name of the blacklist that the IP address appears on.
blacklistEntry_description :: Lens' BlacklistEntry (Maybe Text) Source #
Additional information about the blacklisting event, as provided by the blacklist maintainer.
Body
Represents the body of the email message.
See: newBody smart constructor.
Constructors
| Body' | |
Fields
| |
Instances
| Eq Body Source # | |
| Read Body Source # | |
| Show Body Source # | |
| Generic Body Source # | |
| NFData Body Source # | |
Defined in Amazonka.SESV2.Types.Body | |
| Hashable Body Source # | |
Defined in Amazonka.SESV2.Types.Body | |
| ToJSON Body Source # | |
Defined in Amazonka.SESV2.Types.Body | |
| type Rep Body Source # | |
Defined in Amazonka.SESV2.Types.Body type Rep Body = D1 ('MetaData "Body" "Amazonka.SESV2.Types.Body" "libZSservicesZSamazonka-sesv2ZSamazonka-sesv2" 'False) (C1 ('MetaCons "Body'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Content)) :*: S1 ('MetaSel ('Just "html") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Content)))) | |
Create a value of Body with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:Body', body_text - An object that represents the version of the message that is displayed
in email clients that don't support HTML, or clients where the
recipient has disabled HTML rendering.
$sel:html:Body', body_html - An object that represents the version of the message that is displayed
in email clients that support HTML. HTML messages can include formatted
text, hyperlinks, images, and more.
body_text :: Lens' Body (Maybe Content) Source #
An object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering.
body_html :: Lens' Body (Maybe Content) Source #
An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more.
BulkEmailContent
data BulkEmailContent Source #
An object that contains the body of the message. You can specify a template message.
See: newBulkEmailContent smart constructor.
Constructors
| BulkEmailContent' | |
Instances
newBulkEmailContent :: BulkEmailContent Source #
Create a value of BulkEmailContent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:template:BulkEmailContent', bulkEmailContent_template - The template to use for the bulk email message.
bulkEmailContent_template :: Lens' BulkEmailContent (Maybe Template) Source #
The template to use for the bulk email message.
BulkEmailEntry
data BulkEmailEntry Source #
See: newBulkEmailEntry smart constructor.
Constructors
| BulkEmailEntry' | |
Fields
| |
Instances
Arguments
| :: Destination | |
| -> BulkEmailEntry |
Create a value of BulkEmailEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:replacementEmailContent:BulkEmailEntry', bulkEmailEntry_replacementEmailContent - The ReplacementEmailContent associated with a BulkEmailEntry.
$sel:replacementTags:BulkEmailEntry', bulkEmailEntry_replacementTags - A list of tags, in the form of name/value pairs, to apply to an email
that you send using the SendBulkTemplatedEmail operation. Tags
correspond to characteristics of the email that you define, so that you
can publish email sending events.
$sel:destination:BulkEmailEntry', bulkEmailEntry_destination - Represents the destination of the message, consisting of To:, CC:, and
BCC: fields.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.
bulkEmailEntry_replacementEmailContent :: Lens' BulkEmailEntry (Maybe ReplacementEmailContent) Source #
The ReplacementEmailContent associated with a BulkEmailEntry.
bulkEmailEntry_replacementTags :: Lens' BulkEmailEntry (Maybe [MessageTag]) Source #
A list of tags, in the form of name/value pairs, to apply to an email
that you send using the SendBulkTemplatedEmail operation. Tags
correspond to characteristics of the email that you define, so that you
can publish email sending events.
bulkEmailEntry_destination :: Lens' BulkEmailEntry Destination Source #
Represents the destination of the message, consisting of To:, CC:, and BCC: fields.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.
BulkEmailEntryResult
data BulkEmailEntryResult Source #
The result of the SendBulkEmail operation of each specified
BulkEmailEntry.
See: newBulkEmailEntryResult smart constructor.
Constructors
| BulkEmailEntryResult' | |
Fields
| |
Instances
newBulkEmailEntryResult :: BulkEmailEntryResult Source #
Create a value of BulkEmailEntryResult with all optional fields omitted.
Use 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:BulkEmailEntryResult', bulkEmailEntryResult_status - The status of a message sent using the SendBulkTemplatedEmail
operation.
Possible values for this parameter include:
- SUCCESS: Amazon SES accepted the message, and will attempt to deliver it to the recipients.
- MESSAGE_REJECTED: The message was rejected because it contained a virus.
- MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not verified.
- CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you specified does not exist.
- TEMPLATE_DOES_NOT_EXIST: The template you specified does not exist.
- ACCOUNT_SUSPENDED: Your account has been shut down because of issues related to your email sending practices.
- ACCOUNT_THROTTLED: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.
- ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.
- INVALID_SENDING_POOL_NAME: The configuration set you specified refers to an IP pool that does not exist.
- ACCOUNT_SENDING_PAUSED: Email sending for the Amazon SES account was disabled using the UpdateAccountSendingEnabled operation.
- CONFIGURATION_SET_SENDING_PAUSED: Email sending for this configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation.
- INVALID_PARAMETER_VALUE: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.
- TRANSIENT_FAILURE: Amazon SES was unable to process your request because of a temporary issue.
- FAILED: Amazon SES was unable to process your request. See the error message for additional information.
$sel:error:BulkEmailEntryResult', bulkEmailEntryResult_error - A description of an error that prevented a message being sent using the
SendBulkTemplatedEmail operation.
$sel:messageId:BulkEmailEntryResult', bulkEmailEntryResult_messageId - The unique message identifier returned from the SendBulkTemplatedEmail
operation.
bulkEmailEntryResult_status :: Lens' BulkEmailEntryResult (Maybe BulkEmailStatus) Source #
The status of a message sent using the SendBulkTemplatedEmail
operation.
Possible values for this parameter include:
- SUCCESS: Amazon SES accepted the message, and will attempt to deliver it to the recipients.
- MESSAGE_REJECTED: The message was rejected because it contained a virus.
- MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not verified.
- CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you specified does not exist.
- TEMPLATE_DOES_NOT_EXIST: The template you specified does not exist.
- ACCOUNT_SUSPENDED: Your account has been shut down because of issues related to your email sending practices.
- ACCOUNT_THROTTLED: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.
- ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.
- INVALID_SENDING_POOL_NAME: The configuration set you specified refers to an IP pool that does not exist.
- ACCOUNT_SENDING_PAUSED: Email sending for the Amazon SES account was disabled using the UpdateAccountSendingEnabled operation.
- CONFIGURATION_SET_SENDING_PAUSED: Email sending for this configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation.
- INVALID_PARAMETER_VALUE: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.
- TRANSIENT_FAILURE: Amazon SES was unable to process your request because of a temporary issue.
- FAILED: Amazon SES was unable to process your request. See the error message for additional information.
bulkEmailEntryResult_error :: Lens' BulkEmailEntryResult (Maybe Text) Source #
A description of an error that prevented a message being sent using the
SendBulkTemplatedEmail operation.
bulkEmailEntryResult_messageId :: Lens' BulkEmailEntryResult (Maybe Text) Source #
The unique message identifier returned from the SendBulkTemplatedEmail
operation.
CloudWatchDestination
data CloudWatchDestination Source #
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
See: newCloudWatchDestination smart constructor.
Constructors
| CloudWatchDestination' | |
Fields
| |
Instances
newCloudWatchDestination :: CloudWatchDestination Source #
Create a value of CloudWatchDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensionConfigurations:CloudWatchDestination', cloudWatchDestination_dimensionConfigurations - An array of objects that define the dimensions to use when you send
email events to Amazon CloudWatch.
cloudWatchDestination_dimensionConfigurations :: Lens' CloudWatchDestination [CloudWatchDimensionConfiguration] Source #
An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
CloudWatchDimensionConfiguration
data CloudWatchDimensionConfiguration Source #
An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.
See: newCloudWatchDimensionConfiguration smart constructor.
Constructors
| CloudWatchDimensionConfiguration' | |
Fields
| |
Instances
newCloudWatchDimensionConfiguration Source #
Arguments
| :: Text | |
| -> DimensionValueSource | |
| -> Text |
|
| -> CloudWatchDimensionConfiguration |
Create a value of CloudWatchDimensionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensionName:CloudWatchDimensionConfiguration', cloudWatchDimensionConfiguration_dimensionName - The name of an Amazon CloudWatch dimension associated with an email
sending metric. The name has to meet the following criteria:
- It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
$sel:dimensionValueSource:CloudWatchDimensionConfiguration', cloudWatchDimensionConfiguration_dimensionValueSource - The location where the Amazon SES API v2 finds the value of a dimension
to publish to Amazon CloudWatch. To use the message tags that you
specify using an X-SES-MESSAGE-TAGS header or a parameter to the
SendEmail or SendRawEmail API, choose messageTag. To use your own
email headers, choose emailHeader. To use link tags, choose
linkTags.
$sel:defaultDimensionValue:CloudWatchDimensionConfiguration', cloudWatchDimensionConfiguration_defaultDimensionValue - The default value of the dimension that is published to Amazon
CloudWatch if you don't provide the value of the dimension when you
send an email. This value has to meet the following criteria:
- It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
cloudWatchDimensionConfiguration_dimensionName :: Lens' CloudWatchDimensionConfiguration Text Source #
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
- It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
cloudWatchDimensionConfiguration_dimensionValueSource :: Lens' CloudWatchDimensionConfiguration DimensionValueSource Source #
The location where the Amazon SES API v2 finds the value of a dimension
to publish to Amazon CloudWatch. To use the message tags that you
specify using an X-SES-MESSAGE-TAGS header or a parameter to the
SendEmail or SendRawEmail API, choose messageTag. To use your own
email headers, choose emailHeader. To use link tags, choose
linkTags.
cloudWatchDimensionConfiguration_defaultDimensionValue :: Lens' CloudWatchDimensionConfiguration Text Source #
The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
- It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
Contact
A contact is the end-user who is receiving the email.
See: newContact smart constructor.
Constructors
| Contact' | |
Fields
| |
Instances
newContact :: Contact Source #
Create a value of Contact with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:unsubscribeAll:Contact', contact_unsubscribeAll - A boolean value status noting if the contact is unsubscribed from all
contact list topics.
$sel:topicDefaultPreferences:Contact', contact_topicDefaultPreferences - The default topic preferences applied to the contact.
$sel:emailAddress:Contact', contact_emailAddress - The contact's email address.
$sel:lastUpdatedTimestamp:Contact', contact_lastUpdatedTimestamp - A timestamp noting the last time the contact's information was updated.
$sel:topicPreferences:Contact', contact_topicPreferences - The contact's preference for being opted-in to or opted-out of a topic.
contact_unsubscribeAll :: Lens' Contact (Maybe Bool) Source #
A boolean value status noting if the contact is unsubscribed from all contact list topics.
contact_topicDefaultPreferences :: Lens' Contact (Maybe [TopicPreference]) Source #
The default topic preferences applied to the contact.
contact_lastUpdatedTimestamp :: Lens' Contact (Maybe UTCTime) Source #
A timestamp noting the last time the contact's information was updated.
contact_topicPreferences :: Lens' Contact (Maybe [TopicPreference]) Source #
The contact's preference for being opted-in to or opted-out of a topic.
ContactList
data ContactList Source #
A list that contains contacts that have subscribed to a particular topic or topics.
See: newContactList smart constructor.
Constructors
| ContactList' | |
Fields
| |
Instances
newContactList :: ContactList Source #
Create a value of ContactList with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contactListName:ContactList', contactList_contactListName - The name of the contact list.
$sel:lastUpdatedTimestamp:ContactList', contactList_lastUpdatedTimestamp - A timestamp noting the last time the contact list was updated.
contactList_contactListName :: Lens' ContactList (Maybe Text) Source #
The name of the contact list.
contactList_lastUpdatedTimestamp :: Lens' ContactList (Maybe UTCTime) Source #
A timestamp noting the last time the contact list was updated.
ContactListDestination
data ContactListDestination Source #
An object that contains details about the action of a contact list.
See: newContactListDestination smart constructor.
Constructors
| ContactListDestination' | |
Fields
| |
Instances
newContactListDestination Source #
Arguments
| :: Text | |
| -> ContactListImportAction | |
| -> ContactListDestination |
Create a value of ContactListDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contactListName:ContactListDestination', contactListDestination_contactListName - The name of the contact list.
$sel:contactListImportAction:ContactListDestination', contactListDestination_contactListImportAction - >The type of action to perform on the addresses. The following are the
possible values:
- PUT: add the addresses to the contact list. If the record already exists, it will override it with the new value.
- DELETE: remove the addresses from the contact list.
contactListDestination_contactListName :: Lens' ContactListDestination Text Source #
The name of the contact list.
contactListDestination_contactListImportAction :: Lens' ContactListDestination ContactListImportAction Source #
The type of action to perform on the addresses. The following are the
possible values:
- PUT: add the addresses to the contact list. If the record already exists, it will override it with the new value.
- DELETE: remove the addresses from the contact list.
Content
An object that represents the content of the email, and optionally a character set specification.
See: newContent smart constructor.
Constructors
| Content' | |
Fields
| |
Instances
| Eq Content Source # | |
| Read Content Source # | |
| Show Content Source # | |
| Generic Content Source # | |
| NFData Content Source # | |
Defined in Amazonka.SESV2.Types.Content | |
| Hashable Content Source # | |
Defined in Amazonka.SESV2.Types.Content | |
| ToJSON Content Source # | |
Defined in Amazonka.SESV2.Types.Content | |
| type Rep Content Source # | |
Defined in Amazonka.SESV2.Types.Content type Rep Content = D1 ('MetaData "Content" "Amazonka.SESV2.Types.Content" "libZSservicesZSamazonka-sesv2ZSamazonka-sesv2" '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 SES uses 7-bit ASCII by default. If the text
includes characters outside of the ASCII range, you have to specify a
character set. For example, you could specify UTF-8, ISO-8859-1, or
Shift_JIS.
$sel:data':Content', content_data - The content of the message itself.
content_charset :: Lens' Content (Maybe Text) Source #
The character set for the content. Because of the constraints of the
SMTP protocol, Amazon SES 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.
CustomVerificationEmailTemplateMetadata
data CustomVerificationEmailTemplateMetadata Source #
Contains information about a custom verification email template.
See: newCustomVerificationEmailTemplateMetadata smart constructor.
Constructors
| CustomVerificationEmailTemplateMetadata' | |
Fields
| |
Instances
newCustomVerificationEmailTemplateMetadata :: CustomVerificationEmailTemplateMetadata Source #
Create a value of CustomVerificationEmailTemplateMetadata with all optional fields omitted.
Use 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:CustomVerificationEmailTemplateMetadata', customVerificationEmailTemplateMetadata_fromEmailAddress - The email address that the custom verification email is sent from.
$sel:templateName:CustomVerificationEmailTemplateMetadata', customVerificationEmailTemplateMetadata_templateName - The name of the custom verification email template.
$sel:failureRedirectionURL:CustomVerificationEmailTemplateMetadata', customVerificationEmailTemplateMetadata_failureRedirectionURL - The URL that the recipient of the verification email is sent to if his
or her address is not successfully verified.
$sel:templateSubject:CustomVerificationEmailTemplateMetadata', customVerificationEmailTemplateMetadata_templateSubject - The subject line of the custom verification email.
$sel:successRedirectionURL:CustomVerificationEmailTemplateMetadata', customVerificationEmailTemplateMetadata_successRedirectionURL - The URL that the recipient of the verification email is sent to if his
or her address is successfully verified.
customVerificationEmailTemplateMetadata_fromEmailAddress :: Lens' CustomVerificationEmailTemplateMetadata (Maybe Text) Source #
The email address that the custom verification email is sent from.
customVerificationEmailTemplateMetadata_templateName :: Lens' CustomVerificationEmailTemplateMetadata (Maybe Text) Source #
The name of the custom verification email template.
customVerificationEmailTemplateMetadata_failureRedirectionURL :: Lens' CustomVerificationEmailTemplateMetadata (Maybe Text) Source #
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
customVerificationEmailTemplateMetadata_templateSubject :: Lens' CustomVerificationEmailTemplateMetadata (Maybe Text) Source #
The subject line of the custom verification email.
customVerificationEmailTemplateMetadata_successRedirectionURL :: Lens' CustomVerificationEmailTemplateMetadata (Maybe Text) Source #
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
DailyVolume
data DailyVolume Source #
An object that contains information about the volume of email sent on each day of the analysis period.
See: newDailyVolume smart constructor.
Constructors
| DailyVolume' | |
Fields
| |
Instances
newDailyVolume :: DailyVolume Source #
Create a value of DailyVolume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainIspPlacements:DailyVolume', dailyVolume_domainIspPlacements - An object that contains inbox placement metrics for a specified day in
the analysis period, broken out by the recipient's email provider.
$sel:startDate:DailyVolume', dailyVolume_startDate - The date that the DailyVolume metrics apply to, in Unix time.
$sel:volumeStatistics:DailyVolume', dailyVolume_volumeStatistics - An object that contains inbox placement metrics for a specific day in
the analysis period.
dailyVolume_domainIspPlacements :: Lens' DailyVolume (Maybe [DomainIspPlacement]) Source #
An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient's email provider.
dailyVolume_startDate :: Lens' DailyVolume (Maybe UTCTime) Source #
The date that the DailyVolume metrics apply to, in Unix time.
dailyVolume_volumeStatistics :: Lens' DailyVolume (Maybe VolumeStatistics) Source #
An object that contains inbox placement metrics for a specific day in the analysis period.
DedicatedIp
data DedicatedIp Source #
Contains information about a dedicated IP address that is associated with your Amazon SES account.
To learn more about requesting dedicated IP addresses, see Requesting and Relinquishing Dedicated IP Addresses in the Amazon SES Developer Guide.
See: newDedicatedIp smart constructor.
Constructors
| DedicatedIp' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> WarmupStatus | |
| -> Int | |
| -> DedicatedIp |
Create a value of DedicatedIp with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:poolName:DedicatedIp', dedicatedIp_poolName - The name of the dedicated IP pool that the IP address is associated
with.
$sel:ip:DedicatedIp', dedicatedIp_ip - An IPv4 address.
$sel:warmupStatus:DedicatedIp', dedicatedIp_warmupStatus - The warm-up status of a dedicated IP address. The status can have one of
the following values:
IN_PROGRESS– The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.DONE– The dedicated IP warm-up process is complete, and the IP address is ready to use.
$sel:warmupPercentage:DedicatedIp', dedicatedIp_warmupPercentage - Indicates how complete the dedicated IP warm-up process is. When this
value equals 1, the address has completed the warm-up process and is
ready for use.
dedicatedIp_poolName :: Lens' DedicatedIp (Maybe Text) Source #
The name of the dedicated IP pool that the IP address is associated with.
dedicatedIp_ip :: Lens' DedicatedIp Text Source #
An IPv4 address.
dedicatedIp_warmupStatus :: Lens' DedicatedIp WarmupStatus Source #
The warm-up status of a dedicated IP address. The status can have one of the following values:
IN_PROGRESS– The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.DONE– The dedicated IP warm-up process is complete, and the IP address is ready to use.
dedicatedIp_warmupPercentage :: Lens' DedicatedIp Int Source #
Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
DeliverabilityTestReport
data DeliverabilityTestReport Source #
An object that contains metadata related to a predictive inbox placement test.
See: newDeliverabilityTestReport smart constructor.
Constructors
| DeliverabilityTestReport' | |
Fields
| |
Instances
newDeliverabilityTestReport :: DeliverabilityTestReport Source #
Create a value of DeliverabilityTestReport with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subject:DeliverabilityTestReport', deliverabilityTestReport_subject - The subject line for an email that you submitted in a predictive inbox
placement test.
$sel:fromEmailAddress:DeliverabilityTestReport', deliverabilityTestReport_fromEmailAddress - The sender address that you specified for the predictive inbox placement
test.
$sel:createDate:DeliverabilityTestReport', deliverabilityTestReport_createDate - The date and time when the predictive inbox placement test was created,
in Unix time format.
$sel:reportId:DeliverabilityTestReport', deliverabilityTestReport_reportId - A unique string that identifies the predictive inbox placement test.
$sel:reportName:DeliverabilityTestReport', deliverabilityTestReport_reportName - A name that helps you identify a predictive inbox placement test report.
$sel:deliverabilityTestStatus:DeliverabilityTestReport', deliverabilityTestReport_deliverabilityTestStatus - The status of the predictive inbox placement test. If the status is
IN_PROGRESS, then the predictive inbox placement test is currently
running. Predictive inbox placement tests are usually complete within 24
hours of creating the test. If the status is COMPLETE, then the test
is finished, and you can use the GetDeliverabilityTestReport to view
the results of the test.
deliverabilityTestReport_subject :: Lens' DeliverabilityTestReport (Maybe Text) Source #
The subject line for an email that you submitted in a predictive inbox placement test.
deliverabilityTestReport_fromEmailAddress :: Lens' DeliverabilityTestReport (Maybe Text) Source #
The sender address that you specified for the predictive inbox placement test.
deliverabilityTestReport_createDate :: Lens' DeliverabilityTestReport (Maybe UTCTime) Source #
The date and time when the predictive inbox placement test was created, in Unix time format.
deliverabilityTestReport_reportId :: Lens' DeliverabilityTestReport (Maybe Text) Source #
A unique string that identifies the predictive inbox placement test.
deliverabilityTestReport_reportName :: Lens' DeliverabilityTestReport (Maybe Text) Source #
A name that helps you identify a predictive inbox placement test report.
deliverabilityTestReport_deliverabilityTestStatus :: Lens' DeliverabilityTestReport (Maybe DeliverabilityTestStatus) Source #
The status of the predictive inbox placement test. If the status is
IN_PROGRESS, then the predictive inbox placement test is currently
running. Predictive inbox placement tests are usually complete within 24
hours of creating the test. If the status is COMPLETE, then the test
is finished, and you can use the GetDeliverabilityTestReport to view
the results of the test.
DeliveryOptions
data DeliveryOptions Source #
Used to associate a configuration set with a dedicated IP pool.
See: newDeliveryOptions smart constructor.
Constructors
| DeliveryOptions' | |
Fields
| |
Instances
newDeliveryOptions :: DeliveryOptions Source #
Create a value of DeliveryOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sendingPoolName:DeliveryOptions', deliveryOptions_sendingPoolName - The name of the dedicated IP pool to associate with the configuration
set.
$sel:tlsPolicy:DeliveryOptions', deliveryOptions_tlsPolicy - Specifies whether messages that use the configuration set are required
to use Transport Layer Security (TLS). If the value is Require,
messages are only delivered if a TLS connection can be established. If
the value is Optional, messages can be delivered in plain text if a
TLS connection can't be established.
deliveryOptions_sendingPoolName :: Lens' DeliveryOptions (Maybe Text) Source #
The name of the dedicated IP pool to associate with the configuration set.
deliveryOptions_tlsPolicy :: Lens' DeliveryOptions (Maybe TlsPolicy) Source #
Specifies whether messages that use the configuration set are required
to use Transport Layer Security (TLS). If the value is Require,
messages are only delivered if a TLS connection can be established. If
the value is Optional, messages can be delivered in plain text if a
TLS connection can't be established.
Destination
data Destination Source #
An object that describes the recipients for an email.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.
See: newDestination smart constructor.
Constructors
| Destination' | |
Fields
| |
Instances
newDestination :: Destination Source #
Create a value of Destination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bccAddresses:Destination', destination_bccAddresses - An array that contains the email addresses of the "BCC" (blind carbon
copy) recipients for the email.
$sel:ccAddresses:Destination', destination_ccAddresses - An array that contains the email addresses of the "CC" (carbon copy)
recipients for the email.
$sel:toAddresses:Destination', destination_toAddresses - An array that contains the email addresses of the "To" recipients for
the email.
destination_bccAddresses :: Lens' Destination (Maybe [Text]) Source #
An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.
destination_ccAddresses :: Lens' Destination (Maybe [Text]) Source #
An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.
destination_toAddresses :: Lens' Destination (Maybe [Text]) Source #
An array that contains the email addresses of the "To" recipients for the email.
DkimAttributes
data DkimAttributes Source #
An object that contains information about the DKIM authentication status for an email identity.
Amazon SES determines the authentication status by searching for specific records in the DNS configuration for the domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain. If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity
See: newDkimAttributes smart constructor.
Constructors
| DkimAttributes' | |
Fields
| |
Instances
newDkimAttributes :: DkimAttributes Source #
Create a value of DkimAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DkimAttributes', dkimAttributes_status - Describes whether or not Amazon SES has successfully located the DKIM
records in the DNS records for the domain. The status can be one of the
following:
PENDING– The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.SUCCESS– The verification process completed successfully.FAILED– The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.TEMPORARY_FAILURE– A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.NOT_STARTED– The DKIM verification process hasn't been initiated for the domain.
$sel:nextSigningKeyLength:DkimAttributes', dkimAttributes_nextSigningKeyLength - [Easy DKIM] The key length of the future DKIM key pair to be generated.
This can be changed at most once per day.
$sel:tokens:DkimAttributes', dkimAttributes_tokens - If you used
Easy DKIM
to configure DKIM authentication for the domain, then this object
contains 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 SES detects these records in the DNS configuration for your
domain, the DKIM authentication process is complete.
If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.
$sel:signingEnabled:DkimAttributes', dkimAttributes_signingEnabled - If the value is true, then the messages that you send from the
identity are signed using DKIM. If the value is false, then the
messages that you send from the identity aren't DKIM-signed.
$sel:currentSigningKeyLength:DkimAttributes', dkimAttributes_currentSigningKeyLength - [Easy DKIM] The key length of the DKIM key pair in use.
$sel:lastKeyGenerationTimestamp:DkimAttributes', dkimAttributes_lastKeyGenerationTimestamp - [Easy DKIM] The last time a key pair was generated for this identity.
$sel:signingAttributesOrigin:DkimAttributes', dkimAttributes_signingAttributesOrigin - A string that indicates how DKIM was configured for the identity. These
are the possible values:
AWS_SES– Indicates that DKIM was configured for the identity by using Easy DKIM.EXTERNAL– Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
dkimAttributes_status :: Lens' DkimAttributes (Maybe DkimStatus) Source #
Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:
PENDING– The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.SUCCESS– The verification process completed successfully.FAILED– The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.TEMPORARY_FAILURE– A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.NOT_STARTED– The DKIM verification process hasn't been initiated for the domain.
dkimAttributes_nextSigningKeyLength :: Lens' DkimAttributes (Maybe DkimSigningKeyLength) Source #
- Easy DKIM
- The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
dkimAttributes_tokens :: Lens' DkimAttributes (Maybe [Text]) Source #
If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains 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 SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.
If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.
dkimAttributes_signingEnabled :: Lens' DkimAttributes (Maybe Bool) Source #
If the value is true, then the messages that you send from the
identity are signed using DKIM. If the value is false, then the
messages that you send from the identity aren't DKIM-signed.
dkimAttributes_currentSigningKeyLength :: Lens' DkimAttributes (Maybe DkimSigningKeyLength) Source #
- Easy DKIM
- The key length of the DKIM key pair in use.
dkimAttributes_lastKeyGenerationTimestamp :: Lens' DkimAttributes (Maybe UTCTime) Source #
- Easy DKIM
- The last time a key pair was generated for this identity.
dkimAttributes_signingAttributesOrigin :: Lens' DkimAttributes (Maybe DkimSigningAttributesOrigin) Source #
A string that indicates how DKIM was configured for the identity. These are the possible values:
AWS_SES– Indicates that DKIM was configured for the identity by using Easy DKIM.EXTERNAL– Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
DkimSigningAttributes
data DkimSigningAttributes Source #
An object that contains configuration for Bring Your Own DKIM (BYODKIM), or, for Easy DKIM
See: newDkimSigningAttributes smart constructor.
Constructors
| DkimSigningAttributes' | |
Fields
| |
Instances
newDkimSigningAttributes :: DkimSigningAttributes Source #
Create a value of DkimSigningAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextSigningKeyLength:DkimSigningAttributes', dkimSigningAttributes_nextSigningKeyLength - [Easy DKIM] The key length of the future DKIM key pair to be generated.
This can be changed at most once per day.
$sel:domainSigningPrivateKey:DkimSigningAttributes', dkimSigningAttributes_domainSigningPrivateKey - [Bring Your Own DKIM] A private key that's used to generate a DKIM
signature.
The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.
$sel:domainSigningSelector:DkimSigningAttributes', dkimSigningAttributes_domainSigningSelector - [Bring Your Own DKIM] A string that's used to identify a public key in
the DNS configuration for a domain.
dkimSigningAttributes_nextSigningKeyLength :: Lens' DkimSigningAttributes (Maybe DkimSigningKeyLength) Source #
- Easy DKIM
- The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
dkimSigningAttributes_domainSigningPrivateKey :: Lens' DkimSigningAttributes (Maybe Text) Source #
- Bring Your Own DKIM
- A private key that's used to generate a DKIM signature.
The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.
dkimSigningAttributes_domainSigningSelector :: Lens' DkimSigningAttributes (Maybe Text) Source #
- Bring Your Own DKIM
- A string that's used to identify a public key in the DNS configuration for a domain.
DomainDeliverabilityCampaign
data DomainDeliverabilityCampaign Source #
An object that contains the deliverability data for a specific campaign.
This data is available for a campaign only if the campaign sent email by
using a domain that the Deliverability dashboard is enabled for
(PutDeliverabilityDashboardOption operation).
See: newDomainDeliverabilityCampaign smart constructor.
Constructors
| DomainDeliverabilityCampaign' | |
Fields
| |
Instances
newDomainDeliverabilityCampaign :: DomainDeliverabilityCampaign Source #
Create a value of DomainDeliverabilityCampaign with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:spamCount:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_spamCount - The number of email messages that were delivered to recipients' spam or
junk mail folders.
$sel:subject:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_subject - The subject line, or title, of the email message.
$sel:esps:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_esps - The major email providers who handled the email message.
$sel:fromAddress:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_fromAddress - The verified email address that the email message was sent from.
$sel:deleteRate:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_deleteRate - The percentage of email messages that were deleted by recipients,
without being opened first. Due to technical limitations, this value
only includes recipients who opened the message by using an email client
that supports images.
$sel:campaignId:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_campaignId - The unique identifier for the campaign. The Deliverability dashboard
automatically generates and assigns this identifier to a campaign.
$sel:sendingIps:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_sendingIps - The IP addresses that were used to send the email message.
$sel:firstSeenDateTime:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_firstSeenDateTime - The first time, in Unix time format, when the email message was
delivered to any recipient's inbox. This value can help you determine
how long it took for a campaign to deliver an email message.
$sel:inboxCount:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_inboxCount - The number of email messages that were delivered to recipients’ inboxes.
$sel:readDeleteRate:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_readDeleteRate - The percentage of email messages that were opened and then deleted by
recipients. Due to technical limitations, this value only includes
recipients who opened the message by using an email client that supports
images.
$sel:projectedVolume:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_projectedVolume - The projected number of recipients that the email message was sent to.
$sel:imageUrl:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_imageUrl - The URL of an image that contains a snapshot of the email message that
was sent.
$sel:readRate:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_readRate - The percentage of email messages that were opened by recipients. Due to
technical limitations, this value only includes recipients who opened
the message by using an email client that supports images.
$sel:lastSeenDateTime:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_lastSeenDateTime - The last time, in Unix time format, when the email message was delivered
to any recipient's inbox. This value can help you determine how long it
took for a campaign to deliver an email message.
domainDeliverabilityCampaign_spamCount :: Lens' DomainDeliverabilityCampaign (Maybe Integer) Source #
The number of email messages that were delivered to recipients' spam or junk mail folders.
domainDeliverabilityCampaign_subject :: Lens' DomainDeliverabilityCampaign (Maybe Text) Source #
The subject line, or title, of the email message.
domainDeliverabilityCampaign_esps :: Lens' DomainDeliverabilityCampaign (Maybe [Text]) Source #
The major email providers who handled the email message.
domainDeliverabilityCampaign_fromAddress :: Lens' DomainDeliverabilityCampaign (Maybe Text) Source #
The verified email address that the email message was sent from.
domainDeliverabilityCampaign_deleteRate :: Lens' DomainDeliverabilityCampaign (Maybe Double) Source #
The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
domainDeliverabilityCampaign_campaignId :: Lens' DomainDeliverabilityCampaign (Maybe Text) Source #
The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
domainDeliverabilityCampaign_sendingIps :: Lens' DomainDeliverabilityCampaign (Maybe [Text]) Source #
The IP addresses that were used to send the email message.
domainDeliverabilityCampaign_firstSeenDateTime :: Lens' DomainDeliverabilityCampaign (Maybe UTCTime) Source #
The first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
domainDeliverabilityCampaign_inboxCount :: Lens' DomainDeliverabilityCampaign (Maybe Integer) Source #
The number of email messages that were delivered to recipients’ inboxes.
domainDeliverabilityCampaign_readDeleteRate :: Lens' DomainDeliverabilityCampaign (Maybe Double) Source #
The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
domainDeliverabilityCampaign_projectedVolume :: Lens' DomainDeliverabilityCampaign (Maybe Integer) Source #
The projected number of recipients that the email message was sent to.
domainDeliverabilityCampaign_imageUrl :: Lens' DomainDeliverabilityCampaign (Maybe Text) Source #
The URL of an image that contains a snapshot of the email message that was sent.
domainDeliverabilityCampaign_readRate :: Lens' DomainDeliverabilityCampaign (Maybe Double) Source #
The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
domainDeliverabilityCampaign_lastSeenDateTime :: Lens' DomainDeliverabilityCampaign (Maybe UTCTime) Source #
The last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
DomainDeliverabilityTrackingOption
data DomainDeliverabilityTrackingOption Source #
An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.
See: newDomainDeliverabilityTrackingOption smart constructor.
Constructors
| DomainDeliverabilityTrackingOption' | |
Fields
| |
Instances
newDomainDeliverabilityTrackingOption :: DomainDeliverabilityTrackingOption Source #
Create a value of DomainDeliverabilityTrackingOption with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domain:DomainDeliverabilityTrackingOption', domainDeliverabilityTrackingOption_domain - A verified domain that’s associated with your Amazon Web Services
account and currently has an active Deliverability dashboard
subscription.
$sel:subscriptionStartDate:DomainDeliverabilityTrackingOption', domainDeliverabilityTrackingOption_subscriptionStartDate - The date, in Unix time format, when you enabled the Deliverability
dashboard for the domain.
$sel:inboxPlacementTrackingOption:DomainDeliverabilityTrackingOption', domainDeliverabilityTrackingOption_inboxPlacementTrackingOption - An object that contains information about the inbox placement data
settings for the domain.
domainDeliverabilityTrackingOption_domain :: Lens' DomainDeliverabilityTrackingOption (Maybe Text) Source #
A verified domain that’s associated with your Amazon Web Services account and currently has an active Deliverability dashboard subscription.
domainDeliverabilityTrackingOption_subscriptionStartDate :: Lens' DomainDeliverabilityTrackingOption (Maybe UTCTime) Source #
The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.
domainDeliverabilityTrackingOption_inboxPlacementTrackingOption :: Lens' DomainDeliverabilityTrackingOption (Maybe InboxPlacementTrackingOption) Source #
An object that contains information about the inbox placement data settings for the domain.
DomainIspPlacement
data DomainIspPlacement Source #
An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.
See: newDomainIspPlacement smart constructor.
Constructors
| DomainIspPlacement' | |
Fields
| |
Instances
newDomainIspPlacement :: DomainIspPlacement Source #
Create a value of DomainIspPlacement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:spamPercentage:DomainIspPlacement', domainIspPlacement_spamPercentage - The percentage of messages that were sent from the selected domain to
the specified email provider that arrived in recipients' spam or junk
mail folders.
$sel:inboxRawCount:DomainIspPlacement', domainIspPlacement_inboxRawCount - The total number of messages that were sent from the selected domain to
the specified email provider that arrived in recipients' inboxes.
$sel:ispName:DomainIspPlacement', domainIspPlacement_ispName - The name of the email provider that the inbox placement data applies to.
$sel:inboxPercentage:DomainIspPlacement', domainIspPlacement_inboxPercentage - The percentage of messages that were sent from the selected domain to
the specified email provider that arrived in recipients' inboxes.
$sel:spamRawCount:DomainIspPlacement', domainIspPlacement_spamRawCount - The total number of messages that were sent from the selected domain to
the specified email provider that arrived in recipients' spam or junk
mail folders.
domainIspPlacement_spamPercentage :: Lens' DomainIspPlacement (Maybe Double) Source #
The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
domainIspPlacement_inboxRawCount :: Lens' DomainIspPlacement (Maybe Integer) Source #
The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
domainIspPlacement_ispName :: Lens' DomainIspPlacement (Maybe Text) Source #
The name of the email provider that the inbox placement data applies to.
domainIspPlacement_inboxPercentage :: Lens' DomainIspPlacement (Maybe Double) Source #
The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
domainIspPlacement_spamRawCount :: Lens' DomainIspPlacement (Maybe Integer) Source #
The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
EmailContent
data EmailContent Source #
An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.
See: newEmailContent smart constructor.
Constructors
| EmailContent' | |
Fields
| |
Instances
newEmailContent :: EmailContent Source #
Create a value of EmailContent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:raw:EmailContent', emailContent_raw - The raw email message. The message has to meet the following criteria:
- The message has to contain a header and a body, separated by one blank line.
- All of the required header fields must be present in the message.
- Each part of a multipart MIME message must be formatted properly.
- If you include attachments, they must be in a file format that the Amazon SES API v2 supports.
- The entire message must be Base64 encoded.
- If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
- The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
$sel:simple:EmailContent', emailContent_simple - The simple email message. The message consists of a subject and a
message body.
$sel:template:EmailContent', emailContent_template - The template to use for the email message.
emailContent_raw :: Lens' EmailContent (Maybe RawMessage) Source #
The raw email message. The message has to meet the following criteria:
- The message has to contain a header and a body, separated by one blank line.
- All of the required header fields must be present in the message.
- Each part of a multipart MIME message must be formatted properly.
- If you include attachments, they must be in a file format that the Amazon SES API v2 supports.
- The entire message must be Base64 encoded.
- If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
- The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
emailContent_simple :: Lens' EmailContent (Maybe Message) Source #
The simple email message. The message consists of a subject and a message body.
emailContent_template :: Lens' EmailContent (Maybe Template) Source #
The template to use for the email message.
EmailTemplateContent
data EmailTemplateContent Source #
The content of the email, composed of a subject line, an HTML part, and a text-only part.
See: newEmailTemplateContent smart constructor.
Constructors
| EmailTemplateContent' | |
Instances
newEmailTemplateContent :: EmailTemplateContent Source #
Create a value of EmailTemplateContent with all optional fields omitted.
Use 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:EmailTemplateContent', emailTemplateContent_subject - The subject line of the email.
$sel:text:EmailTemplateContent', emailTemplateContent_text - The email body that will be visible to recipients whose email clients do
not display HTML.
$sel:html:EmailTemplateContent', emailTemplateContent_html - The HTML body of the email.
emailTemplateContent_subject :: Lens' EmailTemplateContent (Maybe Text) Source #
The subject line of the email.
emailTemplateContent_text :: Lens' EmailTemplateContent (Maybe Text) Source #
The email body that will be visible to recipients whose email clients do not display HTML.
emailTemplateContent_html :: Lens' EmailTemplateContent (Maybe Text) Source #
The HTML body of the email.
EmailTemplateMetadata
data EmailTemplateMetadata Source #
Contains information about an email template.
See: newEmailTemplateMetadata smart constructor.
Constructors
| EmailTemplateMetadata' | |
Fields
| |
Instances
newEmailTemplateMetadata :: EmailTemplateMetadata Source #
Create a value of EmailTemplateMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:templateName:EmailTemplateMetadata', emailTemplateMetadata_templateName - The name of the template.
$sel:createdTimestamp:EmailTemplateMetadata', emailTemplateMetadata_createdTimestamp - The time and date the template was created.
emailTemplateMetadata_templateName :: Lens' EmailTemplateMetadata (Maybe Text) Source #
The name of the template.
emailTemplateMetadata_createdTimestamp :: Lens' EmailTemplateMetadata (Maybe UTCTime) Source #
The time and date the template was created.
EventDestination
data EventDestination Source #
In the Amazon SES API v2, events include message sends, deliveries, opens, clicks, bounces, complaints and delivery delays. /Event destinations/ are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
See: newEventDestination smart constructor.
Constructors
| EventDestination' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> EventDestination |
Create a value of EventDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pinpointDestination:EventDestination', eventDestination_pinpointDestination - An object that defines an Amazon Pinpoint project destination for email
events. You can send email event data to a Amazon Pinpoint project to
view metrics using the Transactional Messaging dashboards that are built
in to Amazon Pinpoint. For more information, see
Transactional Messaging Charts
in the Amazon Pinpoint User Guide.
$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 SES sends to the specified event
destinations.
eventDestination_pinpointDestination :: Lens' EventDestination (Maybe PinpointDestination) Source #
An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
eventDestination_enabled :: Lens' EventDestination (Maybe Bool) Source #
If true, the event destination is enabled. When the event destination
is enabled, the specified event types are sent to the destinations in
this EventDestinationDefinition.
If false, the event destination is disabled. When the event
destination is disabled, events aren't sent to the specified
destinations.
eventDestination_kinesisFirehoseDestination :: Lens' EventDestination (Maybe KinesisFirehoseDestination) Source #
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
eventDestination_cloudWatchDestination :: Lens' EventDestination (Maybe CloudWatchDestination) Source #
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
eventDestination_snsDestination :: Lens' EventDestination (Maybe SnsDestination) Source #
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
eventDestination_name :: Lens' EventDestination Text Source #
A name that identifies the event destination.
eventDestination_matchingEventTypes :: Lens' EventDestination [EventType] Source #
The types of events that Amazon SES sends to the specified event destinations.
EventDestinationDefinition
data EventDestinationDefinition Source #
An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.
See: newEventDestinationDefinition smart constructor.
Constructors
| EventDestinationDefinition' | |
Fields
| |
Instances
newEventDestinationDefinition :: EventDestinationDefinition Source #
Create a value of EventDestinationDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:matchingEventTypes:EventDestinationDefinition', eventDestinationDefinition_matchingEventTypes - An array that specifies which events the Amazon SES API v2 should send
to the destinations in this EventDestinationDefinition.
$sel:pinpointDestination:EventDestinationDefinition', eventDestinationDefinition_pinpointDestination - An object that defines an Amazon Pinpoint project destination for email
events. You can send email event data to a Amazon Pinpoint project to
view metrics using the Transactional Messaging dashboards that are built
in to Amazon Pinpoint. For more information, see
Transactional Messaging Charts
in the Amazon Pinpoint User Guide.
$sel:enabled:EventDestinationDefinition', eventDestinationDefinition_enabled - If true, the event destination is enabled. When the event destination
is enabled, the specified event types are sent to the destinations in
this EventDestinationDefinition.
If false, the event destination is disabled. When the event
destination is disabled, events aren't sent to the specified
destinations.
$sel:kinesisFirehoseDestination:EventDestinationDefinition', eventDestinationDefinition_kinesisFirehoseDestination - An object that defines an Amazon Kinesis Data Firehose destination for
email events. You can use Amazon Kinesis Data Firehose to stream data to
other services, such as Amazon S3 and Amazon Redshift.
$sel:cloudWatchDestination:EventDestinationDefinition', eventDestinationDefinition_cloudWatchDestination - An object that defines an Amazon CloudWatch destination for email
events. You can use Amazon CloudWatch to monitor and gain insights on
your email sending metrics.
$sel:snsDestination:EventDestinationDefinition', eventDestinationDefinition_snsDestination - An object that defines an Amazon SNS destination for email events. You
can use Amazon SNS to send notification when certain email events occur.
eventDestinationDefinition_matchingEventTypes :: Lens' EventDestinationDefinition (Maybe [EventType]) Source #
An array that specifies which events the Amazon SES API v2 should send
to the destinations in this EventDestinationDefinition.
eventDestinationDefinition_pinpointDestination :: Lens' EventDestinationDefinition (Maybe PinpointDestination) Source #
An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
eventDestinationDefinition_enabled :: Lens' EventDestinationDefinition (Maybe Bool) Source #
If true, the event destination is enabled. When the event destination
is enabled, the specified event types are sent to the destinations in
this EventDestinationDefinition.
If false, the event destination is disabled. When the event
destination is disabled, events aren't sent to the specified
destinations.
eventDestinationDefinition_kinesisFirehoseDestination :: Lens' EventDestinationDefinition (Maybe KinesisFirehoseDestination) Source #
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
eventDestinationDefinition_cloudWatchDestination :: Lens' EventDestinationDefinition (Maybe CloudWatchDestination) Source #
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
eventDestinationDefinition_snsDestination :: Lens' EventDestinationDefinition (Maybe SnsDestination) Source #
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
FailureInfo
data FailureInfo Source #
An object that contains the failure details about an import job.
See: newFailureInfo smart constructor.
Constructors
| FailureInfo' | |
Fields
| |
Instances
newFailureInfo :: FailureInfo Source #
Create a value of FailureInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failedRecordsS3Url:FailureInfo', failureInfo_failedRecordsS3Url - An Amazon S3 presigned URL that contains all the failed records and
related information.
$sel:errorMessage:FailureInfo', failureInfo_errorMessage - A message about why the import job failed.
failureInfo_failedRecordsS3Url :: Lens' FailureInfo (Maybe Text) Source #
An Amazon S3 presigned URL that contains all the failed records and related information.
failureInfo_errorMessage :: Lens' FailureInfo (Maybe Text) Source #
A message about why the import job failed.
IdentityInfo
data IdentityInfo Source #
Information about an email identity.
See: newIdentityInfo smart constructor.
Constructors
| IdentityInfo' | |
Fields
| |
Instances
newIdentityInfo :: IdentityInfo Source #
Create a value of IdentityInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:identityType:IdentityInfo', identityInfo_identityType - The email identity type. Note: the MANAGED_DOMAIN type is not
supported for email identity types.
$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.
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 SES to send email from that identity.
identityInfo_identityType :: Lens' IdentityInfo (Maybe IdentityType) Source #
The email identity type. Note: the MANAGED_DOMAIN type is not
supported for email identity types.
identityInfo_identityName :: Lens' IdentityInfo (Maybe Text) Source #
The address or domain of the identity.
identityInfo_sendingEnabled :: Lens' IdentityInfo (Maybe Bool) Source #
Indicates whether or not you can send email from the identity.
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 SES to send email from that identity.
ImportDataSource
data ImportDataSource Source #
An object that contains details about the data source of the import job.
See: newImportDataSource smart constructor.
Constructors
| ImportDataSource' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DataFormat | |
| -> ImportDataSource |
Create a value of ImportDataSource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Url:ImportDataSource', importDataSource_s3Url - An Amazon S3 URL in the format s3://<bucket_name>/<object>.
$sel:dataFormat:ImportDataSource', importDataSource_dataFormat - The data format of the import job's data source.
importDataSource_s3Url :: Lens' ImportDataSource Text Source #
An Amazon S3 URL in the format s3://<bucket_name>/<object>.
importDataSource_dataFormat :: Lens' ImportDataSource DataFormat Source #
The data format of the import job's data source.
ImportDestination
data ImportDestination Source #
An object that contains details about the resource destination the import job is going to target.
See: newImportDestination smart constructor.
Constructors
| ImportDestination' | |
Fields
| |
Instances
newImportDestination :: ImportDestination Source #
Create a value of ImportDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:suppressionListDestination:ImportDestination', importDestination_suppressionListDestination - An object that contains the action of the import job towards suppression
list.
$sel:contactListDestination:ImportDestination', importDestination_contactListDestination - An object that contains the action of the import job towards a contact
list.
importDestination_suppressionListDestination :: Lens' ImportDestination (Maybe SuppressionListDestination) Source #
An object that contains the action of the import job towards suppression list.
importDestination_contactListDestination :: Lens' ImportDestination (Maybe ContactListDestination) Source #
An object that contains the action of the import job towards a contact list.
ImportJobSummary
data ImportJobSummary Source #
A summary of the import job.
See: newImportJobSummary smart constructor.
Constructors
| ImportJobSummary' | |
Fields
| |
Instances
newImportJobSummary :: ImportJobSummary Source #
Create a value of ImportJobSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:ImportJobSummary', importJobSummary_jobId - Undocumented member.
$sel:importDestination:ImportJobSummary', importJobSummary_importDestination - Undocumented member.
$sel:jobStatus:ImportJobSummary', importJobSummary_jobStatus - Undocumented member.
$sel:createdTimestamp:ImportJobSummary', importJobSummary_createdTimestamp - The date and time when the import job was created.
importJobSummary_jobId :: Lens' ImportJobSummary (Maybe Text) Source #
Undocumented member.
importJobSummary_importDestination :: Lens' ImportJobSummary (Maybe ImportDestination) Source #
Undocumented member.
importJobSummary_jobStatus :: Lens' ImportJobSummary (Maybe JobStatus) Source #
Undocumented member.
importJobSummary_createdTimestamp :: Lens' ImportJobSummary (Maybe UTCTime) Source #
The date and time when the import job was created.
InboxPlacementTrackingOption
data InboxPlacementTrackingOption Source #
An object that contains information about the inbox placement data settings for a verified domain that’s associated with your Amazon Web Services account. This data is available only if you enabled the Deliverability dashboard for the domain.
See: newInboxPlacementTrackingOption smart constructor.
Constructors
| InboxPlacementTrackingOption' | |
Instances
newInboxPlacementTrackingOption :: InboxPlacementTrackingOption Source #
Create a value of InboxPlacementTrackingOption with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:trackedIsps:InboxPlacementTrackingOption', inboxPlacementTrackingOption_trackedIsps - An array of strings, one for each major email provider that the inbox
placement data applies to.
$sel:global:InboxPlacementTrackingOption', inboxPlacementTrackingOption_global - Specifies whether inbox placement data is being tracked for the domain.
inboxPlacementTrackingOption_trackedIsps :: Lens' InboxPlacementTrackingOption (Maybe [Text]) Source #
An array of strings, one for each major email provider that the inbox placement data applies to.
inboxPlacementTrackingOption_global :: Lens' InboxPlacementTrackingOption (Maybe Bool) Source #
Specifies whether inbox placement data is being tracked for the domain.
IspPlacement
data IspPlacement Source #
An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.
See: newIspPlacement smart constructor.
Constructors
| IspPlacement' | |
Fields
| |
Instances
newIspPlacement :: IspPlacement Source #
Create a value of IspPlacement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:placementStatistics:IspPlacement', ispPlacement_placementStatistics - An object that contains inbox placement metrics for a specific email
provider.
$sel:ispName:IspPlacement', ispPlacement_ispName - The name of the email provider that the inbox placement data applies to.
ispPlacement_placementStatistics :: Lens' IspPlacement (Maybe PlacementStatistics) Source #
An object that contains inbox placement metrics for a specific email provider.
ispPlacement_ispName :: Lens' IspPlacement (Maybe Text) Source #
The name of the email provider that the inbox placement data applies to.
KinesisFirehoseDestination
data KinesisFirehoseDestination Source #
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
See: newKinesisFirehoseDestination smart constructor.
Constructors
| KinesisFirehoseDestination' | |
Fields
| |
Instances
newKinesisFirehoseDestination Source #
Arguments
| :: Text | |
| -> Text | |
| -> KinesisFirehoseDestination |
Create a value of KinesisFirehoseDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iamRoleArn:KinesisFirehoseDestination', kinesisFirehoseDestination_iamRoleArn - The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API
v2 uses to send 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 the Amazon SES API v2 sends email events to.
kinesisFirehoseDestination_iamRoleArn :: Lens' KinesisFirehoseDestination Text Source #
The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email events to the Amazon Kinesis Data Firehose stream.
kinesisFirehoseDestination_deliveryStreamArn :: Lens' KinesisFirehoseDestination Text Source #
The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email events to.
ListContactsFilter
data ListContactsFilter Source #
A filter that can be applied to a list of contacts.
See: newListContactsFilter smart constructor.
Constructors
| ListContactsFilter' | |
Fields
| |
Instances
newListContactsFilter :: ListContactsFilter Source #
Create a value of ListContactsFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filteredStatus:ListContactsFilter', listContactsFilter_filteredStatus - The status by which you are filtering: OPT_IN or OPT_OUT.
$sel:topicFilter:ListContactsFilter', listContactsFilter_topicFilter - Used for filtering by a specific topic preference.
listContactsFilter_filteredStatus :: Lens' ListContactsFilter (Maybe SubscriptionStatus) Source #
The status by which you are filtering: OPT_IN or OPT_OUT.
listContactsFilter_topicFilter :: Lens' ListContactsFilter (Maybe TopicFilter) Source #
Used for filtering by a specific topic preference.
ListManagementOptions
data ListManagementOptions Source #
An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
See: newListManagementOptions smart constructor.
Constructors
| ListManagementOptions' | |
Fields
| |
Instances
newListManagementOptions Source #
Create a value of ListManagementOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:topicName:ListManagementOptions', listManagementOptions_topicName - The name of the topic.
$sel:contactListName:ListManagementOptions', listManagementOptions_contactListName - The name of the contact list.
listManagementOptions_topicName :: Lens' ListManagementOptions (Maybe Text) Source #
The name of the topic.
listManagementOptions_contactListName :: Lens' ListManagementOptions Text Source #
The name of the contact list.
MailFromAttributes
data MailFromAttributes Source #
A list of attributes that are associated with a MAIL FROM domain.
See: newMailFromAttributes smart constructor.
Constructors
| MailFromAttributes' | |
Fields
| |
Instances
newMailFromAttributes Source #
Arguments
| :: Text | |
| -> MailFromDomainStatus | |
| -> BehaviorOnMxFailure | |
| -> MailFromAttributes |
Create a value of MailFromAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mailFromDomain:MailFromAttributes', mailFromAttributes_mailFromDomain - The name of a domain that an email identity uses as a custom MAIL FROM
domain.
$sel:mailFromDomainStatus:MailFromAttributes', mailFromAttributes_mailFromDomainStatus - The status of the MAIL FROM domain. This status can have the following
values:
PENDING– Amazon SES hasn't started searching for the MX record yet.SUCCESS– Amazon SES detected the required MX record for the MAIL FROM domain.FAILED– Amazon SES can't find the required MX record, or the record no longer exists.TEMPORARY_FAILURE– A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.
$sel:behaviorOnMxFailure:MailFromAttributes', mailFromAttributes_behaviorOnMxFailure - The action to take if the required MX record can't be found when you
send an email. When you set this value to UseDefaultValue, the mail is
sent using amazonses.com as the MAIL FROM domain. When you set this
value to RejectMessage, the Amazon SES API v2 returns a
MailFromDomainNotVerified error, and doesn't attempt to deliver the
email.
These behaviors are taken when the custom MAIL FROM domain configuration
is in the Pending, Failed, and TemporaryFailure states.
mailFromAttributes_mailFromDomain :: Lens' MailFromAttributes Text Source #
The name of a domain that an email identity uses as a custom MAIL FROM domain.
mailFromAttributes_mailFromDomainStatus :: Lens' MailFromAttributes MailFromDomainStatus Source #
The status of the MAIL FROM domain. This status can have the following values:
PENDING– Amazon SES hasn't started searching for the MX record yet.SUCCESS– Amazon SES detected the required MX record for the MAIL FROM domain.FAILED– Amazon SES can't find the required MX record, or the record no longer exists.TEMPORARY_FAILURE– A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.
mailFromAttributes_behaviorOnMxFailure :: Lens' MailFromAttributes BehaviorOnMxFailure Source #
The action to take if the required MX record can't be found when you
send an email. When you set this value to UseDefaultValue, the mail is
sent using amazonses.com as the MAIL FROM domain. When you set this
value to RejectMessage, the Amazon SES API v2 returns a
MailFromDomainNotVerified error, and doesn't attempt to deliver the
email.
These behaviors are taken when the custom MAIL FROM domain configuration
is in the Pending, Failed, and TemporaryFailure states.
Message
Represents the email message that you're sending. The Message object
consists of a subject line and a message body.
See: newMessage smart constructor.
Constructors
| Message' | |
Fields
| |
Instances
| Eq Message Source # | |
| Read Message Source # | |
| Show Message Source # | |
| Generic Message Source # | |
| NFData Message Source # | |
Defined in Amazonka.SESV2.Types.Message | |
| Hashable Message Source # | |
Defined in Amazonka.SESV2.Types.Message | |
| ToJSON Message Source # | |
Defined in Amazonka.SESV2.Types.Message | |
| type Rep Message Source # | |
Defined in Amazonka.SESV2.Types.Message type Rep Message = D1 ('MetaData "Message" "Amazonka.SESV2.Types.Message" "libZSservicesZSamazonka-sesv2ZSamazonka-sesv2" 'False) (C1 ('MetaCons "Message'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Content) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body))) | |
Create a value of Message with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subject:Message', message_subject - The subject line of the email. The subject line can only contain 7-bit
ASCII characters. However, you can specify non-ASCII characters in the
subject line by using encoded-word syntax, as described in
RFC 2047.
$sel:body:Message', message_body - The body of the message. You can specify an HTML version of the message,
a text-only version of the message, or both.
message_subject :: Lens' Message Content Source #
The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047.
message_body :: Lens' Message Body Source #
The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.
MessageTag
data MessageTag Source #
Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.
See: newMessageTag smart constructor.
Constructors
| MessageTag' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> MessageTag |
Create a value of MessageTag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:MessageTag', messageTag_name - The name of the message tag. The message tag name has to meet the
following criteria:
- It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
$sel:value:MessageTag', messageTag_value - The value of the message tag. The message tag value has to meet the
following criteria:
- It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
messageTag_name :: Lens' MessageTag Text Source #
The name of the message tag. The message tag name has to meet the following criteria:
- It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
messageTag_value :: Lens' MessageTag Text Source #
The value of the message tag. The message tag value has to meet the following criteria:
- It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
- It can contain no more than 256 characters.
OverallVolume
data OverallVolume Source #
An object that contains information about email that was sent from the selected domain.
See: newOverallVolume smart constructor.
Constructors
| OverallVolume' | |
Fields
| |
Instances
newOverallVolume :: OverallVolume Source #
Create a value of OverallVolume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainIspPlacements:OverallVolume', overallVolume_domainIspPlacements - An object that contains inbox and junk mail placement metrics for
individual email providers.
$sel:volumeStatistics:OverallVolume', overallVolume_volumeStatistics - An object that contains information about the numbers of messages that
arrived in recipients' inboxes and junk mail folders.
$sel:readRatePercent:OverallVolume', overallVolume_readRatePercent - The percentage of emails that were sent from the domain that were read
by their recipients.
overallVolume_domainIspPlacements :: Lens' OverallVolume (Maybe [DomainIspPlacement]) Source #
An object that contains inbox and junk mail placement metrics for individual email providers.
overallVolume_volumeStatistics :: Lens' OverallVolume (Maybe VolumeStatistics) Source #
An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.
overallVolume_readRatePercent :: Lens' OverallVolume (Maybe Double) Source #
The percentage of emails that were sent from the domain that were read by their recipients.
PinpointDestination
data PinpointDestination Source #
An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
See: newPinpointDestination smart constructor.
Constructors
| PinpointDestination' | |
Fields
| |
Instances
newPinpointDestination :: PinpointDestination Source #
Create a value of PinpointDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationArn:PinpointDestination', pinpointDestination_applicationArn - The Amazon Resource Name (ARN) of the Amazon Pinpoint project to send
email events to.
pinpointDestination_applicationArn :: Lens' PinpointDestination (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon Pinpoint project to send email events to.
PlacementStatistics
data PlacementStatistics Source #
An object that contains inbox placement data for an email provider.
See: newPlacementStatistics smart constructor.
Constructors
| PlacementStatistics' | |
Fields
| |
Instances
newPlacementStatistics :: PlacementStatistics Source #
Create a value of PlacementStatistics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:missingPercentage:PlacementStatistics', placementStatistics_missingPercentage - The percentage of emails that didn't arrive in recipients' inboxes at
all during the predictive inbox placement test.
$sel:spamPercentage:PlacementStatistics', placementStatistics_spamPercentage - The percentage of emails that arrived in recipients' spam or junk mail
folders during the predictive inbox placement test.
$sel:spfPercentage:PlacementStatistics', placementStatistics_spfPercentage - The percentage of emails that were authenticated by using Sender Policy
Framework (SPF) during the predictive inbox placement test.
$sel:dkimPercentage:PlacementStatistics', placementStatistics_dkimPercentage - The percentage of emails that were authenticated by using DomainKeys
Identified Mail (DKIM) during the predictive inbox placement test.
$sel:inboxPercentage:PlacementStatistics', placementStatistics_inboxPercentage - The percentage of emails that arrived in recipients' inboxes during the
predictive inbox placement test.
placementStatistics_missingPercentage :: Lens' PlacementStatistics (Maybe Double) Source #
The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.
placementStatistics_spamPercentage :: Lens' PlacementStatistics (Maybe Double) Source #
The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.
placementStatistics_spfPercentage :: Lens' PlacementStatistics (Maybe Double) Source #
The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.
placementStatistics_dkimPercentage :: Lens' PlacementStatistics (Maybe Double) Source #
The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.
placementStatistics_inboxPercentage :: Lens' PlacementStatistics (Maybe Double) Source #
The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.
RawMessage
data RawMessage Source #
Represents the raw content of an email message.
See: newRawMessage smart constructor.
Constructors
| RawMessage' | |
Fields
| |
Instances
Arguments
| :: ByteString | |
| -> RawMessage |
Create a value of RawMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:data':RawMessage', rawMessage_data - The raw email message. The message has to meet the following criteria:
- The message has to contain a header and a body, separated by one blank line.
- All of the required header fields must be present in the message.
- Each part of a multipart MIME message must be formatted properly.
- Attachments must be in a file format that the Amazon SES supports.
- The entire message must be Base64 encoded.
- If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
- The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.--
- - Note: This
Lensautomatically encodes and decodes Base64 data. - - The underlying isomorphism will encode to Base64 representation during
- - serialisation, and decode from Base64 representation during deserialisation.
- - This
Lensaccepts and returns only raw unencoded data.
rawMessage_data :: Lens' RawMessage ByteString Source #
The raw email message. The message has to meet the following criteria:
- The message has to contain a header and a body, separated by one blank line.
- All of the required header fields must be present in the message.
- Each part of a multipart MIME message must be formatted properly.
- Attachments must be in a file format that the Amazon SES 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.
ReplacementEmailContent
data ReplacementEmailContent Source #
The ReplaceEmailContent object to be used for a specific
BulkEmailEntry. The ReplacementTemplate can be specified within this
object.
See: newReplacementEmailContent smart constructor.
Constructors
| ReplacementEmailContent' | |
Fields
| |
Instances
newReplacementEmailContent :: ReplacementEmailContent Source #
Create a value of ReplacementEmailContent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:replacementTemplate:ReplacementEmailContent', replacementEmailContent_replacementTemplate - The ReplacementTemplate associated with ReplacementEmailContent.
replacementEmailContent_replacementTemplate :: Lens' ReplacementEmailContent (Maybe ReplacementTemplate) Source #
The ReplacementTemplate associated with ReplacementEmailContent.
ReplacementTemplate
data ReplacementTemplate Source #
An object which contains ReplacementTemplateData to be used for a
specific BulkEmailEntry.
See: newReplacementTemplate smart constructor.
Constructors
| ReplacementTemplate' | |
Fields
| |
Instances
newReplacementTemplate :: ReplacementTemplate Source #
Create a value of ReplacementTemplate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:replacementTemplateData:ReplacementTemplate', replacementTemplate_replacementTemplateData - A list of replacement values to apply to the template. This parameter is
a JSON object, typically consisting of key-value pairs in which the keys
correspond to replacement tags in the email template.
replacementTemplate_replacementTemplateData :: Lens' ReplacementTemplate (Maybe Text) Source #
A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
ReputationOptions
data ReputationOptions Source #
Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current Amazon Web Services Region.
See: newReputationOptions smart constructor.
Constructors
| ReputationOptions' | |
Fields
| |
Instances
newReputationOptions :: ReputationOptions Source #
Create a value of ReputationOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastFreshStart:ReputationOptions', reputationOptions_lastFreshStart - The date and time (in Unix time) when the reputation metrics were last
given a fresh start. When your account is given a fresh start, your
reputation metrics are calculated starting from the date of the fresh
start.
$sel:reputationMetricsEnabled:ReputationOptions', reputationOptions_reputationMetricsEnabled - If true, tracking of reputation metrics is enabled for the
configuration set. If false, tracking of reputation metrics is
disabled for the configuration set.
reputationOptions_lastFreshStart :: Lens' ReputationOptions (Maybe UTCTime) Source #
The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.
reputationOptions_reputationMetricsEnabled :: Lens' ReputationOptions (Maybe Bool) Source #
If true, tracking of reputation metrics is enabled for the
configuration set. If false, tracking of reputation metrics is
disabled for the configuration set.
ReviewDetails
data ReviewDetails Source #
An object that contains information about your account details review.
See: newReviewDetails smart constructor.
Constructors
| ReviewDetails' | |
Fields
| |
Instances
newReviewDetails :: ReviewDetails Source #
Create a value of ReviewDetails with all optional fields omitted.
Use 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:ReviewDetails', reviewDetails_status - The status of the latest review of your account. The status can be one
of the following:
PENDING– We have received your appeal and are in the process of reviewing it.GRANTED– Your appeal has been reviewed and your production access has been granted.DENIED– Your appeal has been reviewed and your production access has been denied.FAILED– An internal error occurred and we didn't receive your appeal. You can submit your appeal again.
$sel:caseId:ReviewDetails', reviewDetails_caseId - The associated support center case ID (if any).
reviewDetails_status :: Lens' ReviewDetails (Maybe ReviewStatus) Source #
The status of the latest review of your account. The status can be one of the following:
PENDING– We have received your appeal and are in the process of reviewing it.GRANTED– Your appeal has been reviewed and your production access has been granted.DENIED– Your appeal has been reviewed and your production access has been denied.FAILED– An internal error occurred and we didn't receive your appeal. You can submit your appeal again.
reviewDetails_caseId :: Lens' ReviewDetails (Maybe Text) Source #
The associated support center case ID (if any).
SendQuota
An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current Amazon Web Services Region.
See: newSendQuota smart constructor.
Constructors
| SendQuota' | |
Fields
| |
Instances
| Eq SendQuota Source # | |
| Read SendQuota Source # | |
| Show SendQuota Source # | |
| Generic SendQuota Source # | |
| NFData SendQuota Source # | |
Defined in Amazonka.SESV2.Types.SendQuota | |
| Hashable SendQuota Source # | |
Defined in Amazonka.SESV2.Types.SendQuota | |
| FromJSON SendQuota Source # | |
| type Rep SendQuota Source # | |
Defined in Amazonka.SESV2.Types.SendQuota type Rep SendQuota = D1 ('MetaData "SendQuota" "Amazonka.SESV2.Types.SendQuota" "libZSservicesZSamazonka-sesv2ZSamazonka-sesv2" '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
Amazon Web Services 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 SES account in the current
Amazon Web Services Region over the past 24 hours.
$sel:max24HourSend:SendQuota', sendQuota_max24HourSend - The maximum number of emails that you can send in the current Amazon Web
Services Region over a 24-hour period. This value is also called your
sending quota.
sendQuota_maxSendRate :: Lens' SendQuota (Maybe Double) Source #
The maximum number of emails that you can send per second in the current Amazon Web Services Region. This value is also called your /maximum sending rate or your maximum TPS (transactions per second) rate/.
sendQuota_sentLast24Hours :: Lens' SendQuota (Maybe Double) Source #
The number of emails sent from your Amazon SES account in the current Amazon Web Services Region over the past 24 hours.
sendQuota_max24HourSend :: Lens' SendQuota (Maybe Double) Source #
The maximum number of emails that you can send in the current Amazon Web Services 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 Amazon Web Services Region.
See: newSendingOptions smart constructor.
Constructors
| SendingOptions' | |
Fields
| |
Instances
newSendingOptions :: SendingOptions Source #
Create a value of SendingOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sendingEnabled:SendingOptions', sendingOptions_sendingEnabled - If true, email sending is enabled for the configuration set. If
false, email sending is disabled for the configuration set.
sendingOptions_sendingEnabled :: Lens' SendingOptions (Maybe Bool) Source #
If true, email sending is enabled for the configuration set. If
false, email sending is disabled for the configuration set.
SnsDestination
data SnsDestination Source #
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
See: newSnsDestination smart constructor.
Constructors
| SnsDestination' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> SnsDestination |
Create a value of SnsDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:topicArn:SnsDestination', snsDestination_topicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic to publish email
events to. For more information about Amazon SNS topics, see the
Amazon SNS Developer Guide.
snsDestination_topicArn :: Lens' SnsDestination Text Source #
The Amazon Resource Name (ARN) of the Amazon SNS topic to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
SuppressedDestination
data SuppressedDestination Source #
An object that contains information about an email address that is on the suppression list for your account.
See: newSuppressedDestination smart constructor.
Constructors
| SuppressedDestination' | |
Fields
| |
Instances
newSuppressedDestination Source #
Arguments
| :: Text | |
| -> SuppressionListReason | |
| -> UTCTime | |
| -> SuppressedDestination |
Create a value of SuppressedDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:SuppressedDestination', suppressedDestination_attributes - An optional value that can contain additional information about the
reasons that the address was added to the suppression list for your
account.
$sel:emailAddress:SuppressedDestination', suppressedDestination_emailAddress - The email address that is on the suppression list for your account.
$sel:reason:SuppressedDestination', suppressedDestination_reason - The reason that the address was added to the suppression list for your
account.
$sel:lastUpdateTime:SuppressedDestination', suppressedDestination_lastUpdateTime - The date and time when the suppressed destination was last updated,
shown in Unix time format.
suppressedDestination_attributes :: Lens' SuppressedDestination (Maybe SuppressedDestinationAttributes) Source #
An optional value that can contain additional information about the reasons that the address was added to the suppression list for your account.
suppressedDestination_emailAddress :: Lens' SuppressedDestination Text Source #
The email address that is on the suppression list for your account.
suppressedDestination_reason :: Lens' SuppressedDestination SuppressionListReason Source #
The reason that the address was added to the suppression list for your account.
suppressedDestination_lastUpdateTime :: Lens' SuppressedDestination UTCTime Source #
The date and time when the suppressed destination was last updated, shown in Unix time format.
SuppressedDestinationAttributes
data SuppressedDestinationAttributes Source #
An object that contains additional attributes that are related an email address that is on the suppression list for your account.
See: newSuppressedDestinationAttributes smart constructor.
Constructors
| SuppressedDestinationAttributes' | |
Instances
newSuppressedDestinationAttributes :: SuppressedDestinationAttributes Source #
Create a value of SuppressedDestinationAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:feedbackId:SuppressedDestinationAttributes', suppressedDestinationAttributes_feedbackId - A unique identifier that's generated when an email address is added to
the suppression list for your account.
$sel:messageId:SuppressedDestinationAttributes', suppressedDestinationAttributes_messageId - The unique identifier of the email message that caused the email address
to be added to the suppression list for your account.
suppressedDestinationAttributes_feedbackId :: Lens' SuppressedDestinationAttributes (Maybe Text) Source #
A unique identifier that's generated when an email address is added to the suppression list for your account.
suppressedDestinationAttributes_messageId :: Lens' SuppressedDestinationAttributes (Maybe Text) Source #
The unique identifier of the email message that caused the email address to be added to the suppression list for your account.
SuppressedDestinationSummary
data SuppressedDestinationSummary Source #
A summary that describes the suppressed email address.
See: newSuppressedDestinationSummary smart constructor.
Constructors
| SuppressedDestinationSummary' | |
Fields
| |
Instances
newSuppressedDestinationSummary Source #
Arguments
| :: Text | |
| -> SuppressionListReason | |
| -> UTCTime | |
| -> SuppressedDestinationSummary |
Create a value of SuppressedDestinationSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:emailAddress:SuppressedDestinationSummary', suppressedDestinationSummary_emailAddress - The email address that's on the suppression list for your account.
$sel:reason:SuppressedDestinationSummary', suppressedDestinationSummary_reason - The reason that the address was added to the suppression list for your
account.
$sel:lastUpdateTime:SuppressedDestinationSummary', suppressedDestinationSummary_lastUpdateTime - The date and time when the suppressed destination was last updated,
shown in Unix time format.
suppressedDestinationSummary_emailAddress :: Lens' SuppressedDestinationSummary Text Source #
The email address that's on the suppression list for your account.
suppressedDestinationSummary_reason :: Lens' SuppressedDestinationSummary SuppressionListReason Source #
The reason that the address was added to the suppression list for your account.
suppressedDestinationSummary_lastUpdateTime :: Lens' SuppressedDestinationSummary UTCTime Source #
The date and time when the suppressed destination was last updated, shown in Unix time format.
SuppressionAttributes
data SuppressionAttributes Source #
An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region.
See: newSuppressionAttributes smart constructor.
Constructors
| SuppressionAttributes' | |
Fields
| |
Instances
newSuppressionAttributes :: SuppressionAttributes Source #
Create a value of SuppressionAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:suppressedReasons:SuppressionAttributes', suppressionAttributes_suppressedReasons - A list that contains the reasons that email addresses will be
automatically added to the suppression list for your account. This list
can contain any or all of the following:
COMPLAINT– Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.BOUNCE– Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.
suppressionAttributes_suppressedReasons :: Lens' SuppressionAttributes (Maybe [SuppressionListReason]) Source #
A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. This list can contain any or all of the following:
COMPLAINT– Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.BOUNCE– Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.
SuppressionListDestination
data SuppressionListDestination Source #
An object that contains details about the action of suppression list.
See: newSuppressionListDestination smart constructor.
Constructors
| SuppressionListDestination' | |
Fields
| |
Instances
newSuppressionListDestination Source #
Arguments
| :: SuppressionListImportAction |
|
| -> SuppressionListDestination |
Create a value of SuppressionListDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:suppressionListImportAction:SuppressionListDestination', suppressionListDestination_suppressionListImportAction - The type of action to perform on the address. The following are possible
values:
- PUT: add the addresses to the suppression list. If the record already exists, it will override it with the new value.
- DELETE: remove the addresses from the suppression list.
suppressionListDestination_suppressionListImportAction :: Lens' SuppressionListDestination SuppressionListImportAction Source #
The type of action to perform on the address. The following are possible values:
- PUT: add the addresses to the suppression list. If the record already exists, it will override it with the new value.
- DELETE: remove the addresses from the suppression list.
SuppressionOptions
data SuppressionOptions Source #
An object that contains information about the suppression list preferences for your account.
See: newSuppressionOptions smart constructor.
Constructors
| SuppressionOptions' | |
Fields
| |
Instances
newSuppressionOptions :: SuppressionOptions Source #
Create a value of SuppressionOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:suppressedReasons:SuppressionOptions', suppressionOptions_suppressedReasons - A list that contains the reasons that email addresses are automatically
added to the suppression list for your account. This list can contain
any or all of the following:
COMPLAINT– Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.BOUNCE– Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.
suppressionOptions_suppressedReasons :: Lens' SuppressionOptions (Maybe [SuppressionListReason]) Source #
A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:
COMPLAINT– Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.BOUNCE– Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.
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. 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 Amazon Web Services; 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 Amazon Web Services account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified Amazon Web Services Region for your Amazon Web Services account.
See: newTag smart constructor.
Constructors
| Tag' | |
Fields
| |
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.SESV2.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.SESV2.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.SESV2.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.SESV2.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.SESV2.Types.Tag" "libZSservicesZSamazonka-sesv2ZSamazonka-sesv2" '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. If you don't specify a
value, Amazon SES sets the value to an empty string.
tag_key :: Lens' Tag Text Source #
One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.
tag_value :: Lens' Tag Text Source #
The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want a resource to have a specific tag value, don't specify a value for this parameter. If you don't specify a value, Amazon SES sets the value to an empty string.
Template
An object that defines the email template to use for an email message, and the values to use for any message variables in that template. An email template is a type of message template that contains content that you want to define, save, and reuse in email messages that you send.
See: newTemplate smart constructor.
Constructors
| Template' | |
Fields
| |
Instances
| Eq Template Source # | |
| Read Template Source # | |
| Show Template Source # | |
| Generic Template Source # | |
| NFData Template Source # | |
Defined in Amazonka.SESV2.Types.Template | |
| Hashable Template Source # | |
Defined in Amazonka.SESV2.Types.Template | |
| ToJSON Template Source # | |
Defined in Amazonka.SESV2.Types.Template | |
| type Rep Template Source # | |
Defined in Amazonka.SESV2.Types.Template type Rep Template = D1 ('MetaData "Template" "Amazonka.SESV2.Types.Template" "libZSservicesZSamazonka-sesv2ZSamazonka-sesv2" 'False) (C1 ('MetaCons "Template'" 'PrefixI 'True) (S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (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:templateName:Template', template_templateName - The name of the template. You will refer to this name when you send
email using the SendTemplatedEmail or SendBulkTemplatedEmail
operations.
$sel:templateArn:Template', template_templateArn - The Amazon Resource Name (ARN) of the template.
$sel:templateData:Template', template_templateData - An object that defines the values to use for message variables in the
template. This object is a set of key-value pairs. Each key defines a
message variable in the template. The corresponding value defines the
value to use for that variable.
template_templateName :: Lens' Template (Maybe Text) Source #
The name of the template. You will refer to this name when you send
email using the SendTemplatedEmail or SendBulkTemplatedEmail
operations.
template_templateArn :: Lens' Template (Maybe Text) Source #
The Amazon Resource Name (ARN) of the template.
template_templateData :: Lens' Template (Maybe Text) Source #
An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.
Topic
An interest group, theme, or label within a list. Lists can have multiple topics.
See: newTopic smart constructor.
Constructors
| Topic' | |
Fields
| |
Instances
| Eq Topic Source # | |
| Read Topic Source # | |
| Show Topic Source # | |
| Generic Topic Source # | |
| NFData Topic Source # | |
Defined in Amazonka.SESV2.Types.Topic | |
| Hashable Topic Source # | |
Defined in Amazonka.SESV2.Types.Topic | |
| ToJSON Topic Source # | |
Defined in Amazonka.SESV2.Types.Topic | |
| FromJSON Topic Source # | |
| type Rep Topic Source # | |
Defined in Amazonka.SESV2.Types.Topic type Rep Topic = D1 ('MetaData "Topic" "Amazonka.SESV2.Types.Topic" "libZSservicesZSamazonka-sesv2ZSamazonka-sesv2" 'False) (C1 ('MetaCons "Topic'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "topicName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "defaultSubscriptionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubscriptionStatus)))) | |
Arguments
| :: Text | |
| -> Text | |
| -> SubscriptionStatus | |
| -> Topic |
Create a value of Topic with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:Topic', topic_description - A description of what the topic is about, which the contact will see.
$sel:topicName:Topic', topic_topicName - The name of the topic.
$sel:displayName:Topic', topic_displayName - The name of the topic the contact will see.
$sel:defaultSubscriptionStatus:Topic', topic_defaultSubscriptionStatus - The default subscription status to be applied to a contact if the
contact has not noted their preference for subscribing to a topic.
topic_description :: Lens' Topic (Maybe Text) Source #
A description of what the topic is about, which the contact will see.
topic_defaultSubscriptionStatus :: Lens' Topic SubscriptionStatus Source #
The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.
TopicFilter
data TopicFilter Source #
Used for filtering by a specific topic preference.
See: newTopicFilter smart constructor.
Constructors
| TopicFilter' | |
Instances
newTopicFilter :: TopicFilter Source #
Create a value of TopicFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:topicName:TopicFilter', topicFilter_topicName - The name of a topic on which you wish to apply the filter.
$sel:useDefaultIfPreferenceUnavailable:TopicFilter', topicFilter_useDefaultIfPreferenceUnavailable - Notes that the default subscription status should be applied to a
contact because the contact has not noted their preference for
subscribing to a topic.
topicFilter_topicName :: Lens' TopicFilter (Maybe Text) Source #
The name of a topic on which you wish to apply the filter.
topicFilter_useDefaultIfPreferenceUnavailable :: Lens' TopicFilter (Maybe Bool) Source #
Notes that the default subscription status should be applied to a contact because the contact has not noted their preference for subscribing to a topic.
TopicPreference
data TopicPreference Source #
The contact's preference for being opted-in to or opted-out of a topic.
See: newTopicPreference smart constructor.
Constructors
| TopicPreference' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> SubscriptionStatus | |
| -> TopicPreference |
Create a value of TopicPreference with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:topicName:TopicPreference', topicPreference_topicName - The name of the topic.
$sel:subscriptionStatus:TopicPreference', topicPreference_subscriptionStatus - The contact's subscription status to a topic which is either OPT_IN
or OPT_OUT.
topicPreference_topicName :: Lens' TopicPreference Text Source #
The name of the topic.
topicPreference_subscriptionStatus :: Lens' TopicPreference SubscriptionStatus Source #
The contact's subscription status to a topic which is either OPT_IN
or OPT_OUT.
TrackingOptions
data TrackingOptions Source #
An object that defines the tracking options for a configuration set. When you use the Amazon SES API v2 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 Amazon Web Services. You can optionally configure the Amazon SES to use a domain that you operate for these images and links.
See: newTrackingOptions smart constructor.
Constructors
| TrackingOptions' | |
Fields
| |
Instances
Create a value of TrackingOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customRedirectDomain:TrackingOptions', trackingOptions_customRedirectDomain - The domain to use for tracking open and click events.
trackingOptions_customRedirectDomain :: Lens' TrackingOptions Text Source #
The domain to use for tracking open and click events.
VolumeStatistics
data VolumeStatistics Source #
An object that contains information about the amount of email that was delivered to recipients.
See: newVolumeStatistics smart constructor.
Constructors
| VolumeStatistics' | |
Fields
| |
Instances
newVolumeStatistics :: VolumeStatistics Source #
Create a value of VolumeStatistics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inboxRawCount:VolumeStatistics', volumeStatistics_inboxRawCount - The total number of emails that arrived in recipients' inboxes.
$sel:projectedSpam:VolumeStatistics', volumeStatistics_projectedSpam - An estimate of the percentage of emails sent from the current domain
that will arrive in recipients' spam or junk mail folders.
$sel:projectedInbox:VolumeStatistics', volumeStatistics_projectedInbox - An estimate of the percentage of emails sent from the current domain
that will arrive in recipients' inboxes.
$sel:spamRawCount:VolumeStatistics', volumeStatistics_spamRawCount - The total number of emails that arrived in recipients' spam or junk
mail folders.
volumeStatistics_inboxRawCount :: Lens' VolumeStatistics (Maybe Integer) Source #
The total number of emails that arrived in recipients' inboxes.
volumeStatistics_projectedSpam :: Lens' VolumeStatistics (Maybe Integer) Source #
An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders.
volumeStatistics_projectedInbox :: Lens' VolumeStatistics (Maybe Integer) Source #
An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes.
volumeStatistics_spamRawCount :: Lens' VolumeStatistics (Maybe Integer) Source #
The total number of emails that arrived in recipients' spam or junk mail folders.