diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -8,7 +8,14 @@ ## Description -Amazon Simple Email Service (Amazon SES) is a cost-effective outbound-only email-sending service built on the reliable and scalable infrastructure that Amazon.com has developed to serve its own customer base. With Amazon SES, you can send transactional email, marketing messages, or any other type of high-quality content and you only pay for what you use. Along with high deliverability, Amazon SES provides easy, real-time access to your sending statistics and built-in notifications for bounces, complaints, and deliveries to help you fine-tune your email-sending strategy. + Amazon Simple Email Service (Amazon SES) is a cost-effective outbound-only + email-sending service built on the reliable and scalable infrastructure that + Amazon.com has developed to serve its own customer base. With Amazon SES, you + can send transactional email, marketing messages, or any other type of + high-quality content and you only pay for what you use. Along with high + deliverability, Amazon SES provides easy, real-time access to your sending + statistics and built-in notifications for bounces, complaints, and deliveries + to help you fine-tune your email-sending strategy. Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-ses) and [AWS API Reference](http://docs.aws.amazon.com/ses/latest/APIReference/Welcome.html). diff --git a/amazonka-ses.cabal b/amazonka-ses.cabal --- a/amazonka-ses.cabal +++ b/amazonka-ses.cabal @@ -1,5 +1,5 @@ name: amazonka-ses -version: 0.0.1 +version: 0.0.2 synopsis: Amazon Simple Email Service SDK. homepage: https://github.com/brendanhay/amazonka license: OtherLicense @@ -13,15 +13,14 @@ cabal-version: >= 1.10 description: - Amazon Simple Email Service (Amazon SES) is a cost-effective - outbound-only email-sending service built on the reliable and scalable - infrastructure that Amazon.com has developed to serve its own customer - base. With Amazon SES, you can send transactional email, marketing - messages, or any other type of high-quality content and you only pay - for what you use. Along with high deliverability, Amazon SES provides - easy, real-time access to your sending statistics and built-in - notifications for bounces, complaints, and deliveries to help you - fine-tune your email-sending strategy. + Amazon Simple Email Service (Amazon SES) is a cost-effective outbound-only + email-sending service built on the reliable and scalable infrastructure that + Amazon.com has developed to serve its own customer base. With Amazon SES, you + can send transactional email, marketing messages, or any other type of + high-quality content and you only pay for what you use. Along with high + deliverability, Amazon SES provides easy, real-time access to your sending + statistics and built-in notifications for bounces, complaints, and deliveries + to help you fine-tune your email-sending strategy. . /See:/ . @@ -63,5 +62,5 @@ other-modules: build-depends: - amazonka-core == 0.0.1.* + amazonka-core == 0.0.2.* , base >= 4.7 && < 5 diff --git a/gen/Network/AWS/SES.hs b/gen/Network/AWS/SES.hs --- a/gen/Network/AWS/SES.hs +++ b/gen/Network/AWS/SES.hs @@ -9,13 +9,13 @@ -- Portability : non-portable (GHC extensions) -- | Amazon Simple Email Service (Amazon SES) is a cost-effective outbound-only --- email-sending service built on the reliable and scalable infrastructure --- that Amazon.com has developed to serve its own customer base. With Amazon --- SES, you can send transactional email, marketing messages, or any other --- type of high-quality content and you only pay for what you use. Along with --- high deliverability, Amazon SES provides easy, real-time access to your --- sending statistics and built-in notifications for bounces, complaints, and --- deliveries to help you fine-tune your email-sending strategy. +-- email-sending service built on the reliable and scalable infrastructure that +-- Amazon.com has developed to serve its own customer base. With Amazon SES, you +-- can send transactional email, marketing messages, or any other type of +-- high-quality content and you only pay for what you use. Along with high +-- deliverability, Amazon SES provides easy, real-time access to your sending +-- statistics and built-in notifications for bounces, complaints, and deliveries +-- to help you fine-tune your email-sending strategy. module Network.AWS.SES ( module Network.AWS.SES.DeleteIdentity , module Network.AWS.SES.DeleteVerifiedEmailAddress diff --git a/gen/Network/AWS/SES/DeleteIdentity.hs b/gen/Network/AWS/SES/DeleteIdentity.hs --- a/gen/Network/AWS/SES/DeleteIdentity.hs +++ b/gen/Network/AWS/SES/DeleteIdentity.hs @@ -21,8 +21,10 @@ -- Portability : non-portable (GHC extensions) -- | Deletes the specified identity (email address or domain) from the list of --- verified identities. This action is throttled at one request per second. +-- verified identities. -- +-- This action is throttled at one request per second. +-- -- module Network.AWS.SES.DeleteIdentity ( @@ -60,8 +62,7 @@ { _diIdentity = p1 } --- | The identity to be removed from the list of identities for the AWS --- Account. +-- | The identity to be removed from the list of identities for the AWS Account. diIdentity :: Lens' DeleteIdentity Text diIdentity = lens _diIdentity (\s a -> s { _diIdentity = a }) diff --git a/gen/Network/AWS/SES/DeleteVerifiedEmailAddress.hs b/gen/Network/AWS/SES/DeleteVerifiedEmailAddress.hs --- a/gen/Network/AWS/SES/DeleteVerifiedEmailAddress.hs +++ b/gen/Network/AWS/SES/DeleteVerifiedEmailAddress.hs @@ -21,9 +21,9 @@ -- Portability : non-portable (GHC extensions) -- | Deletes the specified email address from the list of verified addresses. +-- -- The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 --- release of Domain Verification. The DeleteIdentity action is now preferred. --- This action is throttled at one request per second. +-- release of Domain Verification. The DeleteIdentity action is now preferred. This action is throttled at one request per second. -- -- module Network.AWS.SES.DeleteVerifiedEmailAddress diff --git a/gen/Network/AWS/SES/GetIdentityDkimAttributes.hs b/gen/Network/AWS/SES/GetIdentityDkimAttributes.hs --- a/gen/Network/AWS/SES/GetIdentityDkimAttributes.hs +++ b/gen/Network/AWS/SES/GetIdentityDkimAttributes.hs @@ -22,18 +22,21 @@ -- | Returns the current status of Easy DKIM signing for an entity. For domain -- name identities, this action also returns the DKIM tokens that are required --- for Easy DKIM signing, and whether Amazon SES has successfully verified --- that these tokens have been published. This action takes a list of --- identities as input and returns the following information for each: Whether --- Easy DKIM signing is enabled or disabled. A set of DKIM tokens that +-- for Easy DKIM signing, and whether Amazon SES has successfully verified that +-- these tokens have been published. +-- +-- This action takes a list of identities as input and returns the following +-- information for each: +-- +-- Whether Easy DKIM signing is enabled or disabled. A set of DKIM tokens that -- represent the identity. If the identity is an email address, the tokens -- represent the domain of that address. Whether Amazon SES has successfully -- verified the DKIM tokens published in the domain's DNS. This information is --- only returned for domain name identities, not for email addresses. This --- action is throttled at one request per second. For more information about --- creating DNS records using DKIM tokens, go to the Amazon SES Developer --- Guide. +-- only returned for domain name identities, not for email addresses. This +-- action is throttled at one request per second. -- +-- For more information about creating DNS records using DKIM tokens, go to the . +-- -- module Network.AWS.SES.GetIdentityDkimAttributes ( @@ -78,8 +81,7 @@ { _gidaIdentities = mempty } --- | A list of one or more verified identities - email addresses, domains, or --- both. +-- | A list of one or more verified identities - email addresses, domains, or both. gidaIdentities :: Lens' GetIdentityDkimAttributes [Text] gidaIdentities = lens _gidaIdentities (\s a -> s { _gidaIdentities = a }) . _List diff --git a/gen/Network/AWS/SES/GetIdentityNotificationAttributes.hs b/gen/Network/AWS/SES/GetIdentityNotificationAttributes.hs --- a/gen/Network/AWS/SES/GetIdentityNotificationAttributes.hs +++ b/gen/Network/AWS/SES/GetIdentityNotificationAttributes.hs @@ -20,10 +20,12 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Given a list of verified identities (email addresses and/or domains), --- returns a structure describing identity notification attributes. This --- action is throttled at one request per second. For more information about --- using notifications with Amazon SES, see the Amazon SES Developer Guide. +-- | Given a list of verified identities (email addresses and/or domains), returns +-- a structure describing identity notification attributes. +-- +-- This action is throttled at one request per second. +-- +-- For more information about using notifications with Amazon SES, see the . -- -- module Network.AWS.SES.GetIdentityNotificationAttributes diff --git a/gen/Network/AWS/SES/GetIdentityVerificationAttributes.hs b/gen/Network/AWS/SES/GetIdentityVerificationAttributes.hs --- a/gen/Network/AWS/SES/GetIdentityVerificationAttributes.hs +++ b/gen/Network/AWS/SES/GetIdentityVerificationAttributes.hs @@ -22,7 +22,9 @@ -- | Given a list of identities (email addresses and/or domains), returns the -- verification status and (for domain identities) the verification token for --- each identity. This action is throttled at one request per second. +-- each identity. +-- +-- This action is throttled at one request per second. -- -- module Network.AWS.SES.GetIdentityVerificationAttributes diff --git a/gen/Network/AWS/SES/GetSendQuota.hs b/gen/Network/AWS/SES/GetSendQuota.hs --- a/gen/Network/AWS/SES/GetSendQuota.hs +++ b/gen/Network/AWS/SES/GetSendQuota.hs @@ -20,8 +20,9 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Returns the user's current sending limits. This action is throttled at one --- request per second. +-- | Returns the user's current sending limits. +-- +-- This action is throttled at one request per second. -- -- module Network.AWS.SES.GetSendQuota diff --git a/gen/Network/AWS/SES/GetSendStatistics.hs b/gen/Network/AWS/SES/GetSendStatistics.hs --- a/gen/Network/AWS/SES/GetSendStatistics.hs +++ b/gen/Network/AWS/SES/GetSendStatistics.hs @@ -21,9 +21,11 @@ -- Portability : non-portable (GHC extensions) -- | Returns the user's sending statistics. The result is a list of data points, --- representing the last two weeks of sending activity. Each data point in the --- list contains statistics for a 15-minute interval. This action is throttled --- at one request per second. +-- representing the last two weeks of sending activity. +-- +-- Each data point in the list contains statistics for a 15-minute interval. +-- +-- This action is throttled at one request per second. -- -- module Network.AWS.SES.GetSendStatistics diff --git a/gen/Network/AWS/SES/ListIdentities.hs b/gen/Network/AWS/SES/ListIdentities.hs --- a/gen/Network/AWS/SES/ListIdentities.hs +++ b/gen/Network/AWS/SES/ListIdentities.hs @@ -20,8 +20,9 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Returns a list containing all of the identities (email addresses and --- domains) for a specific AWS Account, regardless of verification status. +-- | Returns a list containing all of the identities (email addresses and domains) +-- for a specific AWS Account, regardless of verification status. +-- -- This action is throttled at one request per second. -- -- @@ -73,9 +74,8 @@ , _liMaxItems = Nothing } --- | The type of the identities to list. Possible values are "EmailAddress" --- and "Domain". If this parameter is omitted, then all identities will be --- listed. +-- | The type of the identities to list. Possible values are "EmailAddress" and +-- "Domain". If this parameter is omitted, then all identities will be listed. liIdentityType :: Lens' ListIdentities (Maybe IdentityType) liIdentityType = lens _liIdentityType (\s a -> s { _liIdentityType = a }) diff --git a/gen/Network/AWS/SES/ListVerifiedEmailAddresses.hs b/gen/Network/AWS/SES/ListVerifiedEmailAddresses.hs --- a/gen/Network/AWS/SES/ListVerifiedEmailAddresses.hs +++ b/gen/Network/AWS/SES/ListVerifiedEmailAddresses.hs @@ -20,10 +20,10 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Returns a list containing all of the email addresses that have been --- verified. The ListVerifiedEmailAddresses action is deprecated as of the May --- 15, 2012 release of Domain Verification. The ListIdentities action is now --- preferred. This action is throttled at one request per second. +-- | Returns a list containing all of the email addresses that have been verified. +-- +-- The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 +-- release of Domain Verification. The ListIdentities action is now preferred. This action is throttled at one request per second. -- -- module Network.AWS.SES.ListVerifiedEmailAddresses diff --git a/gen/Network/AWS/SES/SendEmail.hs b/gen/Network/AWS/SES/SendEmail.hs --- a/gen/Network/AWS/SES/SendEmail.hs +++ b/gen/Network/AWS/SES/SendEmail.hs @@ -21,21 +21,24 @@ -- Portability : non-portable (GHC extensions) -- | Composes an email message based on input data, and then immediately queues --- the message for sending. You can only send email from verified email --- addresses and domains. If you have not requested production access to --- Amazon SES, you must also verify every recipient email address except for --- the recipients provided by the Amazon SES mailbox simulator. For more --- information, go to the Amazon SES Developer Guide. The total size of the --- message cannot exceed 10 MB. Amazon SES has a limit on the total number of --- recipients per message: The combined number of To:, CC: and BCC: email --- addresses cannot exceed 50. If you need to send an email message to a --- larger audience, you can divide your recipient list into groups of 50 or --- fewer, and then call Amazon SES repeatedly to send the message to each --- group. For every message that you send, the total number of recipients --- (To:, CC: and BCC:) is counted against your sending quota - the maximum --- number of emails you can send in a 24-hour period. For information about --- your sending quota, go to the Amazon SES Developer Guide. +-- the message for sending. -- +-- You can only send email from verified email addresses and domains. If you +-- have not requested production access to Amazon SES, you must also verify +-- every recipient email address except for the recipients provided by the +-- Amazon SES mailbox simulator. For more information, go to the . The total size of the message cannot exceed 10 MB. +-- +-- Amazon SES has a limit on the total number of recipients per message: The +-- combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you +-- need to send an email message to a larger audience, you can divide your +-- recipient list into groups of 50 or fewer, and then call Amazon SES +-- repeatedly to send the message to each group. +-- +-- For every message that you send, the total number of recipients (To:, CC: +-- and BCC:) is counted against your /sending quota/ - the maximum number of +-- emails you can send in a 24-hour period. For information about your sending +-- quota, go to the . +-- -- module Network.AWS.SES.SendEmail ( @@ -105,26 +108,26 @@ seMessage :: Lens' SendEmail Message seMessage = lens _seMessage (\s a -> s { _seMessage = a }) --- | The reply-to email address(es) for the message. If the recipient replies --- to the message, each reply-to address will receive the reply. +-- | The reply-to email address(es) for the message. If the recipient replies to +-- the message, each reply-to address will receive the reply. seReplyToAddresses :: Lens' SendEmail [Text] seReplyToAddresses = lens _seReplyToAddresses (\s a -> s { _seReplyToAddresses = a }) . _List --- | The email address to which bounces and complaints are to be forwarded --- when feedback forwarding is enabled. If the message cannot be delivered --- to the recipient, then an error message will be returned from the --- recipient's ISP; this message will then be forwarded to the email address --- specified by the ReturnPath parameter. +-- | The email address to which bounces and complaints are to be forwarded when +-- feedback forwarding is enabled. If the message cannot be delivered to the +-- recipient, then an error message will be returned from the recipient's ISP; +-- this message will then be forwarded to the email address specified by the 'ReturnPath' parameter. seReturnPath :: Lens' SendEmail (Maybe Text) seReturnPath = lens _seReturnPath (\s a -> s { _seReturnPath = a }) --- | The identity's email address. By default, the string must be 7-bit ASCII. --- If the text must contain any other characters, then you must use MIME --- encoded-word syntax (RFC 2047) instead of a literal string. MIME --- encoded-word syntax uses the following form: --- =?charset?encoding?encoded-text?=. For more information, see RFC 2047. +-- | The identity's email address. +-- +-- By default, the string must be 7-bit ASCII. If the text must contain any +-- other characters, then you must use MIME encoded-word syntax (RFC 2047) +-- instead of a literal string. MIME encoded-word syntax uses the following +-- form: '=?charset?encoding?encoded-text?='. For more information, see . seSource :: Lens' SendEmail Text seSource = lens _seSource (\s a -> s { _seSource = a }) @@ -144,7 +147,7 @@ { _serMessageId = p1 } --- | The unique message identifier returned from the SendEmail action. +-- | The unique message identifier returned from the 'SendEmail' action. serMessageId :: Lens' SendEmailResponse Text serMessageId = lens _serMessageId (\s a -> s { _serMessageId = a }) diff --git a/gen/Network/AWS/SES/SendRawEmail.hs b/gen/Network/AWS/SES/SendRawEmail.hs --- a/gen/Network/AWS/SES/SendRawEmail.hs +++ b/gen/Network/AWS/SES/SendRawEmail.hs @@ -20,27 +20,31 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Sends an email message, with header and content specified by the client. --- The SendRawEmail action is useful for sending multipart MIME emails. The --- raw text of the message must comply with Internet email standards; --- otherwise, the message cannot be sent. You can only send email from --- verified email addresses and domains. If you have not requested production --- access to Amazon SES, you must also verify every recipient email address --- except for the recipients provided by the Amazon SES mailbox simulator. For --- more information, go to the Amazon SES Developer Guide. The total size of --- the message cannot exceed 10 MB. This includes any attachments that are --- part of the message. Amazon SES has a limit on the total number of --- recipients per message: The combined number of To:, CC: and BCC: email --- addresses cannot exceed 50. If you need to send an email message to a --- larger audience, you can divide your recipient list into groups of 50 or --- fewer, and then call Amazon SES repeatedly to send the message to each --- group. The To:, CC:, and BCC: headers in the raw message can contain a --- group list. Note that each recipient in a group list counts towards the --- 50-recipient limit. For every message that you send, the total number of --- recipients (To:, CC: and BCC:) is counted against your sending quota - the --- maximum number of emails you can send in a 24-hour period. For information --- about your sending quota, go to the Amazon SES Developer Guide. +-- | Sends an email message, with header and content specified by the client. The 'SendRawEmail' action is useful for sending multipart MIME emails. The raw text of the +-- message must comply with Internet email standards; otherwise, the message +-- cannot be sent. -- +-- You can only send email from verified email addresses and domains. If you +-- have not requested production access to Amazon SES, you must also verify +-- every recipient email address except for the recipients provided by the +-- Amazon SES mailbox simulator. For more information, go to the . The total size of the message cannot exceed 10 MB. This +-- includes any attachments that are part of the message. +-- +-- Amazon SES has a limit on the total number of recipients per message: The +-- combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you +-- need to send an email message to a larger audience, you can divide your +-- recipient list into groups of 50 or fewer, and then call Amazon SES +-- repeatedly to send the message to each group. +-- +-- The To:, CC:, and BCC: headers in the raw message can contain a group list. +-- Note that each recipient in a group list counts towards the 50-recipient +-- limit. +-- +-- For every message that you send, the total number of recipients (To:, CC: +-- and BCC:) is counted against your /sending quota/ - the maximum number of +-- emails you can send in a 24-hour period. For information about your sending +-- quota, go to the . +-- -- module Network.AWS.SES.SendRawEmail ( @@ -96,20 +100,22 @@ sreDestinations = lens _sreDestinations (\s a -> s { _sreDestinations = a }) . _List -- | The raw text of the message. The client is responsible for ensuring the --- following: Message must contain a header and a body, separated by a blank --- line. All required header fields must be present. Each part of a --- multipart MIME message must be formatted properly. MIME content types --- must be among those supported by Amazon SES. For more information, go to --- the Amazon SES Developer Guide. Content must be base64-encoded, if MIME --- requires it. +-- following: +-- +-- Message must contain a header and a body, separated by a blank line. All +-- required header fields must be present. Each part of a multipart MIME message +-- must be formatted properly. MIME content types must be among those supported +-- by Amazon SES. For more information, go to the . Content must be base64-encoded, if MIME requires it. +-- sreRawMessage :: Lens' SendRawEmail RawMessage sreRawMessage = lens _sreRawMessage (\s a -> s { _sreRawMessage = a }) --- | The identity's email address. By default, the string must be 7-bit ASCII. --- If the text must contain any other characters, then you must use MIME --- encoded-word syntax (RFC 2047) instead of a literal string. MIME --- encoded-word syntax uses the following form: --- =?charset?encoding?encoded-text?=. For more information, see RFC 2047. +-- | The identity's email address. +-- +-- By default, the string must be 7-bit ASCII. If the text must contain any +-- other characters, then you must use MIME encoded-word syntax (RFC 2047) +-- instead of a literal string. MIME encoded-word syntax uses the following +-- form: '=?charset?encoding?encoded-text?='. For more information, see . sreSource :: Lens' SendRawEmail (Maybe Text) sreSource = lens _sreSource (\s a -> s { _sreSource = a }) @@ -129,7 +135,7 @@ { _srerMessageId = p1 } --- | The unique message identifier returned from the SendRawEmail action. +-- | The unique message identifier returned from the 'SendRawEmail' action. srerMessageId :: Lens' SendRawEmailResponse Text srerMessageId = lens _srerMessageId (\s a -> s { _srerMessageId = a }) diff --git a/gen/Network/AWS/SES/SetIdentityDkimEnabled.hs b/gen/Network/AWS/SES/SetIdentityDkimEnabled.hs --- a/gen/Network/AWS/SES/SetIdentityDkimEnabled.hs +++ b/gen/Network/AWS/SES/SetIdentityDkimEnabled.hs @@ -20,18 +20,19 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Enables or disables Easy DKIM signing of email sent from an identity: If --- Easy DKIM signing is enabled for a domain name identity (e.g., --- example.com), then Amazon SES will DKIM-sign all email sent by addresses --- under that domain name (e.g., user@example.com). If Easy DKIM signing is --- enabled for an email address, then Amazon SES will DKIM-sign all email sent --- by that email address. For email addresses (e.g., user@example.com), you --- can only enable Easy DKIM signing if the corresponding domain (e.g., --- example.com) has been set up for Easy DKIM using the AWS Console or the --- VerifyDomainDkim action. This action is throttled at one request per --- second. For more information about Easy DKIM signing, go to the Amazon SES --- Developer Guide. +-- | Enables or disables Easy DKIM signing of email sent from an identity: -- +-- If Easy DKIM signing is enabled for a domain name identity (e.g., 'example.com'), then Amazon SES will DKIM-sign all email sent by addresses under that +-- domain name (e.g., 'user@example.com'). If Easy DKIM signing is enabled for an +-- email address, then Amazon SES will DKIM-sign all email sent by that email +-- address. For email addresses (e.g., 'user@example.com'), you can only enable +-- Easy DKIM signing if the corresponding domain (e.g., 'example.com') has been +-- set up for Easy DKIM using the AWS Console or the 'VerifyDomainDkim' action. +-- +-- This action is throttled at one request per second. +-- +-- For more information about Easy DKIM signing, go to the . +-- -- module Network.AWS.SES.SetIdentityDkimEnabled ( @@ -75,8 +76,8 @@ , _sideDkimEnabled = p2 } --- | Sets whether DKIM signing is enabled for an identity. Set to true to --- enable DKIM signing for this identity; false to disable it. +-- | Sets whether DKIM signing is enabled for an identity. Set to 'true' to enable +-- DKIM signing for this identity; 'false' to disable it. sideDkimEnabled :: Lens' SetIdentityDkimEnabled Bool sideDkimEnabled = lens _sideDkimEnabled (\s a -> s { _sideDkimEnabled = a }) diff --git a/gen/Network/AWS/SES/SetIdentityFeedbackForwardingEnabled.hs b/gen/Network/AWS/SES/SetIdentityFeedbackForwardingEnabled.hs --- a/gen/Network/AWS/SES/SetIdentityFeedbackForwardingEnabled.hs +++ b/gen/Network/AWS/SES/SetIdentityFeedbackForwardingEnabled.hs @@ -23,10 +23,12 @@ -- | Given an identity (email address or domain), enables or disables whether -- Amazon SES forwards bounce and complaint notifications as email. Feedback -- forwarding can only be disabled when Amazon Simple Notification Service --- (Amazon SNS) topics are specified for both bounces and complaints. This --- action is throttled at one request per second. For more information about --- using notifications with Amazon SES, see the Amazon SES Developer Guide. +-- (Amazon SNS) topics are specified for both bounces and complaints. -- +-- This action is throttled at one request per second. +-- +-- For more information about using notifications with Amazon SES, see the . +-- -- module Network.AWS.SES.SetIdentityFeedbackForwardingEnabled ( @@ -70,19 +72,19 @@ , _siffeForwardingEnabled = p2 } --- | Sets whether Amazon SES will forward bounce and complaint notifications --- as email. true specifies that Amazon SES will forward bounce and --- complaint notifications as email, in addition to any Amazon SNS topic --- publishing otherwise specified. false specifies that Amazon SES will --- publish bounce and complaint notifications only through Amazon SNS. This --- value can only be set to false when Amazon SNS topics are set for both --- Bounce and Complaint notification types. +-- | Sets whether Amazon SES will forward bounce and complaint notifications as +-- email. 'true' specifies that Amazon SES will forward bounce and complaint +-- notifications as email, in addition to any Amazon SNS topic publishing +-- otherwise specified. 'false' specifies that Amazon SES will publish bounce and +-- complaint notifications only through Amazon SNS. This value can only be set +-- to 'false' when Amazon SNS topics are set for both 'Bounce' and 'Complaint' +-- notification types. siffeForwardingEnabled :: Lens' SetIdentityFeedbackForwardingEnabled Bool siffeForwardingEnabled = lens _siffeForwardingEnabled (\s a -> s { _siffeForwardingEnabled = a }) --- | The identity for which to set bounce and complaint notification --- forwarding. Examples: user@example.com, example.com. +-- | The identity for which to set bounce and complaint notification forwarding. +-- Examples: 'user@example.com', 'example.com'. siffeIdentity :: Lens' SetIdentityFeedbackForwardingEnabled Text siffeIdentity = lens _siffeIdentity (\s a -> s { _siffeIdentity = a }) diff --git a/gen/Network/AWS/SES/SetIdentityNotificationTopic.hs b/gen/Network/AWS/SES/SetIdentityNotificationTopic.hs --- a/gen/Network/AWS/SES/SetIdentityNotificationTopic.hs +++ b/gen/Network/AWS/SES/SetIdentityNotificationTopic.hs @@ -23,10 +23,12 @@ -- | Given an identity (email address or domain), sets the Amazon Simple -- Notification Service (Amazon SNS) topic to which Amazon SES will publish -- bounce, complaint, and/or delivery notifications for emails sent with that --- identity as the Source. This action is throttled at one request per second. --- For more information about feedback notification, see the Amazon SES --- Developer Guide. +-- identity as the 'Source'. -- +-- This action is throttled at one request per second. +-- +-- For more information about feedback notification, see the . +-- -- module Network.AWS.SES.SetIdentityNotificationTopic ( @@ -75,20 +77,19 @@ , _sintSnsTopic = Nothing } --- | The identity for which the Amazon SNS topic will be set. Examples: --- user@example.com, example.com. +-- | The identity for which the Amazon SNS topic will be set. Examples: 'user@example.com', 'example.com'. sintIdentity :: Lens' SetIdentityNotificationTopic Text sintIdentity = lens _sintIdentity (\s a -> s { _sintIdentity = a }) --- | The type of notifications that will be published to the specified Amazon --- SNS topic. +-- | The type of notifications that will be published to the specified Amazon SNS +-- topic. sintNotificationType :: Lens' SetIdentityNotificationTopic NotificationType sintNotificationType = lens _sintNotificationType (\s a -> s { _sintNotificationType = a }) --- | The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter --- is omitted from the request or a null value is passed, SnsTopic is --- cleared and publishing is disabled. +-- | The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is +-- omitted from the request or a null value is passed, 'SnsTopic' is cleared and +-- publishing is disabled. sintSnsTopic :: Lens' SetIdentityNotificationTopic (Maybe Text) sintSnsTopic = lens _sintSnsTopic (\s a -> s { _sintSnsTopic = a }) diff --git a/gen/Network/AWS/SES/Types.hs b/gen/Network/AWS/SES/Types.hs --- a/gen/Network/AWS/SES/Types.hs +++ b/gen/Network/AWS/SES/Types.hs @@ -203,21 +203,21 @@ idaDkimEnabled :: Lens' IdentityDkimAttributes Bool idaDkimEnabled = lens _idaDkimEnabled (\s a -> s { _idaDkimEnabled = a }) --- | A set of character strings that represent the domain's identity. Using --- these tokens, you will need to create DNS CNAME records that point to --- DKIM public keys hosted by Amazon SES. Amazon Web Services will --- eventually detect that you have updated your DNS records; this detection --- process may take up to 72 hours. Upon successful detection, Amazon SES --- will be able to DKIM-sign email originating from that domain. (This only --- applies to domain identities, not email address identities.) For more --- information about creating DNS records using DKIM tokens, go to the --- Amazon SES Developer Guide. +-- | A set of character strings that represent the domain's identity. Using these +-- tokens, you will need to create DNS CNAME records that point to DKIM public +-- keys hosted by Amazon SES. Amazon Web Services will eventually detect that +-- you have updated your DNS records; this detection process may take up to 72 +-- hours. Upon successful detection, Amazon SES will be able to DKIM-sign email +-- originating from that domain. (This only applies to domain identities, not +-- email address identities.) +-- +-- For more information about creating DNS records using DKIM tokens, go to the . idaDkimTokens :: Lens' IdentityDkimAttributes [Text] idaDkimTokens = lens _idaDkimTokens (\s a -> s { _idaDkimTokens = a }) . _List --- | Describes whether Amazon SES has successfully verified the DKIM DNS --- records (tokens) published in the domain name's DNS. (This only applies --- to domain identities, not email address identities.). +-- | Describes whether Amazon SES has successfully verified the DKIM DNS records +-- (tokens) published in the domain name's DNS. (This only applies to domain +-- identities, not email address identities.) idaDkimVerificationStatus :: Lens' IdentityDkimAttributes VerificationStatus idaDkimVerificationStatus = lens _idaDkimVerificationStatus @@ -255,9 +255,9 @@ , _bHtml = Nothing } --- | The content of the message, in HTML format. Use this for email clients --- that can process HTML. You can include clickable links, formatted text, --- and much more in an HTML message. +-- | The content of the message, in HTML format. Use this for email clients that +-- can process HTML. You can include clickable links, formatted text, and much +-- more in an HTML message. bHtml :: Lens' Body (Maybe Content) bHtml = lens _bHtml (\s a -> s { _bHtml = a }) @@ -297,8 +297,8 @@ , _ivaVerificationToken = Nothing } --- | The verification status of the identity: "Pending", "Success", "Failed", --- or "TemporaryFailure". +-- | The verification status of the identity: "Pending", "Success", "Failed", or +-- "TemporaryFailure". ivaVerificationStatus :: Lens' IdentityVerificationAttributes VerificationStatus ivaVerificationStatus = lens _ivaVerificationStatus (\s a -> s { _ivaVerificationStatus = a }) @@ -325,7 +325,7 @@ , _sdpComplaints :: Maybe Integer , _sdpDeliveryAttempts :: Maybe Integer , _sdpRejects :: Maybe Integer - , _sdpTimestamp :: Maybe RFC822 + , _sdpTimestamp :: Maybe ISO8601 } deriving (Eq, Ord, Show) -- | 'SendDataPoint' constructor. @@ -397,8 +397,11 @@ instance Hashable IdentityType instance FromText IdentityType where - parser = match "Domain" ITDomain - <|> match "EmailAddress" ITEmailAddress + parser = takeText >>= \case + "Domain" -> pure ITDomain + "EmailAddress" -> pure ITEmailAddress + e -> fail $ + "Failure parsing IdentityType from " ++ show e instance ToText IdentityType where toText = \case @@ -412,7 +415,6 @@ instance FromXML IdentityType where parseXML = parseXMLText "IdentityType" - data Content = Content { _cCharset :: Maybe Text , _cData :: Text @@ -483,27 +485,27 @@ , _inaForwardingEnabled = p4 } --- | The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES --- will publish bounce notifications. +-- | The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will +-- publish bounce notifications. inaBounceTopic :: Lens' IdentityNotificationAttributes Text inaBounceTopic = lens _inaBounceTopic (\s a -> s { _inaBounceTopic = a }) --- | The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES --- will publish complaint notifications. +-- | The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will +-- publish complaint notifications. inaComplaintTopic :: Lens' IdentityNotificationAttributes Text inaComplaintTopic = lens _inaComplaintTopic (\s a -> s { _inaComplaintTopic = a }) --- | The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES --- will publish delivery notifications. +-- | The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will +-- publish delivery notifications. inaDeliveryTopic :: Lens' IdentityNotificationAttributes Text inaDeliveryTopic = lens _inaDeliveryTopic (\s a -> s { _inaDeliveryTopic = a }) --- | Describes whether Amazon SES will forward bounce and complaint --- notifications as email. true indicates that Amazon SES will forward --- bounce and complaint notifications as email, while false indicates that --- bounce and complaint notifications will be published only to the --- specified bounce and complaint Amazon SNS topics. +-- | Describes whether Amazon SES will forward bounce and complaint notifications +-- as email. 'true' indicates that Amazon SES will forward bounce and complaint +-- notifications as email, while 'false' indicates that bounce and complaint +-- notifications will be published only to the specified bounce and complaint +-- Amazon SNS topics. inaForwardingEnabled :: Lens' IdentityNotificationAttributes Bool inaForwardingEnabled = lens _inaForwardingEnabled (\s a -> s { _inaForwardingEnabled = a }) @@ -539,11 +541,13 @@ { _rmData = p1 } --- | The raw data of the message. The client must ensure that the message --- format complies with Internet email standards regarding email header --- fields, MIME types, MIME encoding, and base64 encoding (if necessary). --- The To:, CC:, and BCC: headers in the raw message can contain a group --- list. For more information, go to the Amazon SES Developer Guide. +-- | The raw data of the message. The client must ensure that the message format +-- complies with Internet email standards regarding email header fields, MIME +-- types, MIME encoding, and base64 encoding (if necessary). +-- +-- The To:, CC:, and BCC: headers in the raw message can contain a group list. +-- +-- For more information, go to the . rmData :: Lens' RawMessage Base64 rmData = lens _rmData (\s a -> s { _rmData = a }) @@ -565,9 +569,12 @@ instance Hashable NotificationType instance FromText NotificationType where - parser = match "Bounce" Bounce - <|> match "Complaint" Complaint - <|> match "Delivery" Delivery + parser = takeText >>= \case + "Bounce" -> pure Bounce + "Complaint" -> pure Complaint + "Delivery" -> pure Delivery + e -> fail $ + "Failure parsing NotificationType from " ++ show e instance ToText NotificationType where toText = \case @@ -582,7 +589,6 @@ instance FromXML NotificationType where parseXML = parseXMLText "NotificationType" - data VerificationStatus = Failed -- ^ Failed | NotStarted -- ^ NotStarted @@ -594,11 +600,14 @@ instance Hashable VerificationStatus instance FromText VerificationStatus where - parser = match "Failed" Failed - <|> match "NotStarted" NotStarted - <|> match "Pending" Pending - <|> match "Success" Success - <|> match "TemporaryFailure" TemporaryFailure + parser = takeText >>= \case + "Failed" -> pure Failed + "NotStarted" -> pure NotStarted + "Pending" -> pure Pending + "Success" -> pure Success + "TemporaryFailure" -> pure TemporaryFailure + e -> fail $ + "Failure parsing VerificationStatus from " ++ show e instance ToText VerificationStatus where toText = \case @@ -615,7 +624,6 @@ instance FromXML VerificationStatus where parseXML = parseXMLText "VerificationStatus" - data Message = Message { _mBody :: Body , _mSubject :: Content @@ -641,8 +649,8 @@ mBody :: Lens' Message Body mBody = lens _mBody (\s a -> s { _mBody = a }) --- | The subject of the message: A short summary of the content, which will --- appear in the recipient's inbox. +-- | The subject of the message: A short summary of the content, which will appear +-- in the recipient's inbox. mSubject :: Lens' Message Content mSubject = lens _mSubject (\s a -> s { _mSubject = a }) diff --git a/gen/Network/AWS/SES/VerifyDomainDkim.hs b/gen/Network/AWS/SES/VerifyDomainDkim.hs --- a/gen/Network/AWS/SES/VerifyDomainDkim.hs +++ b/gen/Network/AWS/SES/VerifyDomainDkim.hs @@ -20,17 +20,20 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Returns a set of DKIM tokens for a domain. DKIM tokens are character --- strings that represent your domain's identity. Using these tokens, you will --- need to create DNS CNAME records that point to DKIM public keys hosted by --- Amazon SES. Amazon Web Services will eventually detect that you have --- updated your DNS records; this detection process may take up to 72 hours. --- Upon successful detection, Amazon SES will be able to DKIM-sign email --- originating from that domain. This action is throttled at one request per --- second. To enable or disable Easy DKIM signing for a domain, use the --- SetIdentityDkimEnabled action. For more information about creating DNS --- records using DKIM tokens, go to the Amazon SES Developer Guide. +-- | Returns a set of DKIM tokens for a domain. DKIM /tokens/ are character strings +-- that represent your domain's identity. Using these tokens, you will need to +-- create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. +-- Amazon Web Services will eventually detect that you have updated your DNS +-- records; this detection process may take up to 72 hours. Upon successful +-- detection, Amazon SES will be able to DKIM-sign email originating from that +-- domain. -- +-- This action is throttled at one request per second. +-- +-- To enable or disable Easy DKIM signing for a domain, use the 'SetIdentityDkimEnabled' action. +-- +-- For more information about creating DNS records using DKIM tokens, go to the . +-- -- module Network.AWS.SES.VerifyDomainDkim ( @@ -96,14 +99,15 @@ } -- | A set of character strings that represent the domain's identity. If the --- identity is an email address, the tokens represent the domain of that --- address. Using these tokens, you will need to create DNS CNAME records --- that point to DKIM public keys hosted by Amazon SES. Amazon Web Services --- will eventually detect that you have updated your DNS records; this --- detection process may take up to 72 hours. Upon successful detection, --- Amazon SES will be able to DKIM-sign emails originating from that domain. --- For more information about creating DNS records using DKIM tokens, go to --- the Amazon SES Developer Guide. +-- identity is an email address, the tokens represent the domain of that address. +-- +-- Using these tokens, you will need to create DNS CNAME records that point to +-- DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually +-- detect that you have updated your DNS records; this detection process may +-- take up to 72 hours. Upon successful detection, Amazon SES will be able to +-- DKIM-sign emails originating from that domain. +-- +-- For more information about creating DNS records using DKIM tokens, go to the . vddrDkimTokens :: Lens' VerifyDomainDkimResponse [Text] vddrDkimTokens = lens _vddrDkimTokens (\s a -> s { _vddrDkimTokens = a }) . _List diff --git a/gen/Network/AWS/SES/VerifyDomainIdentity.hs b/gen/Network/AWS/SES/VerifyDomainIdentity.hs --- a/gen/Network/AWS/SES/VerifyDomainIdentity.hs +++ b/gen/Network/AWS/SES/VerifyDomainIdentity.hs @@ -20,8 +20,10 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Verifies a domain. This action is throttled at one request per second. +-- | Verifies a domain. -- +-- This action is throttled at one request per second. +-- -- module Network.AWS.SES.VerifyDomainIdentity ( @@ -81,8 +83,8 @@ { _vdirVerificationToken = p1 } --- | A TXT record that must be placed in the DNS settings for the domain, in --- order to complete domain verification. +-- | A TXT record that must be placed in the DNS settings for the domain, in order +-- to complete domain verification. vdirVerificationToken :: Lens' VerifyDomainIdentityResponse Text vdirVerificationToken = lens _vdirVerificationToken (\s a -> s { _vdirVerificationToken = a }) diff --git a/gen/Network/AWS/SES/VerifyEmailAddress.hs b/gen/Network/AWS/SES/VerifyEmailAddress.hs --- a/gen/Network/AWS/SES/VerifyEmailAddress.hs +++ b/gen/Network/AWS/SES/VerifyEmailAddress.hs @@ -20,11 +20,12 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Verifies an email address. This action causes a confirmation email message --- to be sent to the specified address. The VerifyEmailAddress action is --- deprecated as of the May 15, 2012 release of Domain Verification. The --- VerifyEmailIdentity action is now preferred. This action is throttled at --- one request per second. +-- | Verifies an email address. This action causes a confirmation email message to +-- be sent to the specified address. +-- +-- The VerifyEmailAddress action is deprecated as of the May 15, 2012 release +-- of Domain Verification. The VerifyEmailIdentity action is now preferred. This +-- action is throttled at one request per second. -- -- module Network.AWS.SES.VerifyEmailAddress diff --git a/gen/Network/AWS/SES/VerifyEmailIdentity.hs b/gen/Network/AWS/SES/VerifyEmailIdentity.hs --- a/gen/Network/AWS/SES/VerifyEmailIdentity.hs +++ b/gen/Network/AWS/SES/VerifyEmailIdentity.hs @@ -20,9 +20,10 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Verifies an email address. This action causes a confirmation email message --- to be sent to the specified address. This action is throttled at one --- request per second. +-- | Verifies an email address. This action causes a confirmation email message to +-- be sent to the specified address. +-- +-- This action is throttled at one request per second. -- -- module Network.AWS.SES.VerifyEmailIdentity