| Copyright | (c) 2013-2018 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 |
| Language | Haskell2010 |
Network.AWS.SES
Contents
- Service Configuration
- Errors
- InvalidConfigurationSetException
- InvalidSNSDestinationException
- TemplateDoesNotExistException
- ConfigurationSetSendingPausedException
- CannotDeleteException
- ProductionAccessNotGrantedException
- RuleDoesNotExistException
- MessageRejected
- InvalidRenderingParameterException
- MissingRenderingAttributeException
- FromEmailAddressNotVerifiedException
- RuleSetDoesNotExistException
- MailFromDomainNotVerifiedException
- InvalidFirehoseDestinationException
- ConfigurationSetAlreadyExistsException
- CustomVerificationEmailInvalidContentException
- InvalidTrackingOptionsException
- AccountSendingPausedException
- EventDestinationDoesNotExistException
- CustomVerificationEmailTemplateAlreadyExistsException
- CustomVerificationEmailTemplateDoesNotExistException
- InvalidCloudWatchDestinationException
- InvalidLambdaFunctionException
- TrackingOptionsDoesNotExistException
- InvalidTemplateException
- ConfigurationSetDoesNotExistException
- InvalidPolicyException
- InvalidS3ConfigurationException
- TrackingOptionsAlreadyExistsException
- InvalidSNSTopicException
- EventDestinationAlreadyExistsException
- AlreadyExistsException
- LimitExceededException
- Waiters
- Operations
- CreateTemplate
- DeleteConfigurationSetTrackingOptions
- UpdateConfigurationSetTrackingOptions
- CreateReceiptRuleSet
- SetIdentityHeadersInNotificationsEnabled
- GetSendQuota
- DescribeConfigurationSet
- PutIdentityPolicy
- DeleteCustomVerificationEmailTemplate
- DeleteIdentityPolicy
- UpdateCustomVerificationEmailTemplate
- SendCustomVerificationEmail
- GetIdentityNotificationAttributes
- UpdateConfigurationSetReputationMetricsEnabled
- ListIdentityPolicies
- SetIdentityDkimEnabled
- ListReceiptFilters
- DescribeReceiptRuleSet
- GetIdentityMailFromDomainAttributes
- CreateReceiptFilter
- UpdateConfigurationSetEventDestination
- DeleteConfigurationSetEventDestination
- SetIdentityMailFromDomain
- SetIdentityFeedbackForwardingEnabled
- ListConfigurationSets
- DeleteConfigurationSet
- GetIdentityVerificationAttributes
- GetIdentityPolicies
- ListTemplates
- VerifyDomainIdentity
- UpdateTemplate
- DeleteTemplate
- ReorderReceiptRuleSet
- ListReceiptRuleSets
- DeleteReceiptRuleSet
- SetReceiptRulePosition
- SendBounce
- GetIdentityDkimAttributes
- SendTemplatedEmail
- VerifyDomainDkim
- TestRenderTemplate
- SendBulkTemplatedEmail
- SendRawEmail
- GetSendStatistics
- ListCustomVerificationEmailTemplates (Paginated)
- DeleteIdentity
- DescribeReceiptRule
- ListIdentities (Paginated)
- UpdateConfigurationSetSendingEnabled
- CreateCustomVerificationEmailTemplate
- VerifyEmailIdentity
- VerifyEmailAddress
- DeleteVerifiedEmailAddress
- DeleteReceiptFilter
- ListVerifiedEmailAddresses
- GetCustomVerificationEmailTemplate
- SetIdentityNotificationTopic
- SendEmail
- DeleteReceiptRule
- UpdateReceiptRule
- CloneReceiptRuleSet
- CreateConfigurationSetEventDestination
- GetAccountSendingEnabled
- CreateReceiptRule
- GetTemplate
- SetActiveReceiptRuleSet
- CreateConfigurationSet
- UpdateAccountSendingEnabled
- CreateConfigurationSetTrackingOptions
- DescribeActiveReceiptRuleSet
- Types
- BehaviorOnMXFailure
- BounceType
- BulkEmailStatus
- ConfigurationSetAttribute
- CustomMailFromStatus
- DimensionValueSource
- DsnAction
- EventType
- IdentityType
- InvocationType
- NotificationType
- ReceiptFilterPolicy
- SNSActionEncoding
- StopScope
- TLSPolicy
- VerificationStatus
- AddHeaderAction
- Body
- BounceAction
- BouncedRecipientInfo
- BulkEmailDestination
- BulkEmailDestinationStatus
- CloudWatchDestination
- CloudWatchDimensionConfiguration
- ConfigurationSet
- Content
- CustomVerificationEmailTemplate
- Destination
- EventDestination
- ExtensionField
- IdentityDkimAttributes
- IdentityMailFromDomainAttributes
- IdentityNotificationAttributes
- IdentityVerificationAttributes
- KinesisFirehoseDestination
- LambdaAction
- Message
- MessageDsn
- MessageTag
- RawMessage
- ReceiptAction
- ReceiptFilter
- ReceiptIPFilter
- ReceiptRule
- ReceiptRuleSetMetadata
- RecipientDsnFields
- ReputationOptions
- S3Action
- SNSAction
- SNSDestination
- SendDataPoint
- StopAction
- Template
- TemplateMetadata
- TrackingOptions
- WorkmailAction
Description
Amazon Simple Email Service
This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be used in conjunction with the Amazon SES Developer Guide .
Synopsis
- ses :: Service
- _InvalidConfigurationSetException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSNSDestinationException :: AsError a => Getting (First ServiceError) a ServiceError
- _TemplateDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConfigurationSetSendingPausedException :: AsError a => Getting (First ServiceError) a ServiceError
- _CannotDeleteException :: AsError a => Getting (First ServiceError) a ServiceError
- _ProductionAccessNotGrantedException :: AsError a => Getting (First ServiceError) a ServiceError
- _RuleDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError
- _MessageRejected :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidRenderingParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _MissingRenderingAttributeException :: AsError a => Getting (First ServiceError) a ServiceError
- _FromEmailAddressNotVerifiedException :: AsError a => Getting (First ServiceError) a ServiceError
- _RuleSetDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError
- _MailFromDomainNotVerifiedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidFirehoseDestinationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConfigurationSetAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _CustomVerificationEmailInvalidContentException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidTrackingOptionsException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccountSendingPausedException :: AsError a => Getting (First ServiceError) a ServiceError
- _EventDestinationDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError
- _CustomVerificationEmailTemplateAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _CustomVerificationEmailTemplateDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidCloudWatchDestinationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidLambdaFunctionException :: AsError a => Getting (First ServiceError) a ServiceError
- _TrackingOptionsDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidTemplateException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConfigurationSetDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidPolicyException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidS3ConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError
- _TrackingOptionsAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSNSTopicException :: AsError a => Getting (First ServiceError) a ServiceError
- _EventDestinationAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.SES.CreateTemplate
- module Network.AWS.SES.DeleteConfigurationSetTrackingOptions
- module Network.AWS.SES.UpdateConfigurationSetTrackingOptions
- module Network.AWS.SES.CreateReceiptRuleSet
- module Network.AWS.SES.SetIdentityHeadersInNotificationsEnabled
- module Network.AWS.SES.GetSendQuota
- module Network.AWS.SES.DescribeConfigurationSet
- module Network.AWS.SES.PutIdentityPolicy
- module Network.AWS.SES.DeleteCustomVerificationEmailTemplate
- module Network.AWS.SES.DeleteIdentityPolicy
- module Network.AWS.SES.UpdateCustomVerificationEmailTemplate
- module Network.AWS.SES.SendCustomVerificationEmail
- module Network.AWS.SES.GetIdentityNotificationAttributes
- module Network.AWS.SES.UpdateConfigurationSetReputationMetricsEnabled
- module Network.AWS.SES.ListIdentityPolicies
- module Network.AWS.SES.SetIdentityDkimEnabled
- module Network.AWS.SES.ListReceiptFilters
- module Network.AWS.SES.DescribeReceiptRuleSet
- module Network.AWS.SES.GetIdentityMailFromDomainAttributes
- module Network.AWS.SES.CreateReceiptFilter
- module Network.AWS.SES.UpdateConfigurationSetEventDestination
- module Network.AWS.SES.DeleteConfigurationSetEventDestination
- module Network.AWS.SES.SetIdentityMailFromDomain
- module Network.AWS.SES.SetIdentityFeedbackForwardingEnabled
- module Network.AWS.SES.ListConfigurationSets
- module Network.AWS.SES.DeleteConfigurationSet
- module Network.AWS.SES.GetIdentityVerificationAttributes
- module Network.AWS.SES.GetIdentityPolicies
- module Network.AWS.SES.ListTemplates
- module Network.AWS.SES.VerifyDomainIdentity
- module Network.AWS.SES.UpdateTemplate
- module Network.AWS.SES.DeleteTemplate
- module Network.AWS.SES.ReorderReceiptRuleSet
- module Network.AWS.SES.ListReceiptRuleSets
- module Network.AWS.SES.DeleteReceiptRuleSet
- module Network.AWS.SES.SetReceiptRulePosition
- module Network.AWS.SES.SendBounce
- module Network.AWS.SES.GetIdentityDkimAttributes
- module Network.AWS.SES.SendTemplatedEmail
- module Network.AWS.SES.VerifyDomainDkim
- module Network.AWS.SES.TestRenderTemplate
- module Network.AWS.SES.SendBulkTemplatedEmail
- module Network.AWS.SES.SendRawEmail
- module Network.AWS.SES.GetSendStatistics
- module Network.AWS.SES.ListCustomVerificationEmailTemplates
- module Network.AWS.SES.DeleteIdentity
- module Network.AWS.SES.DescribeReceiptRule
- module Network.AWS.SES.ListIdentities
- module Network.AWS.SES.UpdateConfigurationSetSendingEnabled
- module Network.AWS.SES.CreateCustomVerificationEmailTemplate
- module Network.AWS.SES.VerifyEmailIdentity
- module Network.AWS.SES.VerifyEmailAddress
- module Network.AWS.SES.DeleteVerifiedEmailAddress
- module Network.AWS.SES.DeleteReceiptFilter
- module Network.AWS.SES.ListVerifiedEmailAddresses
- module Network.AWS.SES.GetCustomVerificationEmailTemplate
- module Network.AWS.SES.SetIdentityNotificationTopic
- module Network.AWS.SES.SendEmail
- module Network.AWS.SES.DeleteReceiptRule
- module Network.AWS.SES.UpdateReceiptRule
- module Network.AWS.SES.CloneReceiptRuleSet
- module Network.AWS.SES.CreateConfigurationSetEventDestination
- module Network.AWS.SES.GetAccountSendingEnabled
- module Network.AWS.SES.CreateReceiptRule
- module Network.AWS.SES.GetTemplate
- module Network.AWS.SES.SetActiveReceiptRuleSet
- module Network.AWS.SES.CreateConfigurationSet
- module Network.AWS.SES.UpdateAccountSendingEnabled
- module Network.AWS.SES.CreateConfigurationSetTrackingOptions
- module Network.AWS.SES.DescribeActiveReceiptRuleSet
- data BehaviorOnMXFailure
- data BounceType
- data BulkEmailStatus
- data ConfigurationSetAttribute
- data CustomMailFromStatus
- data DimensionValueSource
- data DsnAction
- data EventType
- data IdentityType
- data InvocationType
- data NotificationType
- data ReceiptFilterPolicy
- data SNSActionEncoding
- data StopScope = RuleSet
- data TLSPolicy
- data VerificationStatus
- data AddHeaderAction
- addHeaderAction :: Text -> Text -> AddHeaderAction
- ahaHeaderName :: Lens' AddHeaderAction Text
- ahaHeaderValue :: Lens' AddHeaderAction Text
- data Body
- body :: Body
- bText :: Lens' Body (Maybe Content)
- bHTML :: Lens' Body (Maybe Content)
- data BounceAction
- bounceAction :: Text -> Text -> Text -> BounceAction
- baTopicARN :: Lens' BounceAction (Maybe Text)
- baStatusCode :: Lens' BounceAction (Maybe Text)
- baSmtpReplyCode :: Lens' BounceAction Text
- baMessage :: Lens' BounceAction Text
- baSender :: Lens' BounceAction Text
- data BouncedRecipientInfo
- bouncedRecipientInfo :: Text -> BouncedRecipientInfo
- briBounceType :: Lens' BouncedRecipientInfo (Maybe BounceType)
- briRecipientDsnFields :: Lens' BouncedRecipientInfo (Maybe RecipientDsnFields)
- briRecipientARN :: Lens' BouncedRecipientInfo (Maybe Text)
- briRecipient :: Lens' BouncedRecipientInfo Text
- data BulkEmailDestination
- bulkEmailDestination :: Destination -> BulkEmailDestination
- bedReplacementTemplateData :: Lens' BulkEmailDestination (Maybe Text)
- bedReplacementTags :: Lens' BulkEmailDestination [MessageTag]
- bedDestination :: Lens' BulkEmailDestination Destination
- data BulkEmailDestinationStatus
- bulkEmailDestinationStatus :: BulkEmailDestinationStatus
- bedsStatus :: Lens' BulkEmailDestinationStatus (Maybe BulkEmailStatus)
- bedsError :: Lens' BulkEmailDestinationStatus (Maybe Text)
- bedsMessageId :: Lens' BulkEmailDestinationStatus (Maybe Text)
- data CloudWatchDestination
- cloudWatchDestination :: CloudWatchDestination
- cwdDimensionConfigurations :: Lens' CloudWatchDestination [CloudWatchDimensionConfiguration]
- data CloudWatchDimensionConfiguration
- cloudWatchDimensionConfiguration :: Text -> DimensionValueSource -> Text -> CloudWatchDimensionConfiguration
- cwdcDimensionName :: Lens' CloudWatchDimensionConfiguration Text
- cwdcDimensionValueSource :: Lens' CloudWatchDimensionConfiguration DimensionValueSource
- cwdcDefaultDimensionValue :: Lens' CloudWatchDimensionConfiguration Text
- data ConfigurationSet
- configurationSet :: Text -> ConfigurationSet
- csName :: Lens' ConfigurationSet Text
- data Content
- content :: Text -> Content
- cCharset :: Lens' Content (Maybe Text)
- cData :: Lens' Content Text
- data CustomVerificationEmailTemplate
- customVerificationEmailTemplate :: CustomVerificationEmailTemplate
- cvetFromEmailAddress :: Lens' CustomVerificationEmailTemplate (Maybe Text)
- cvetTemplateName :: Lens' CustomVerificationEmailTemplate (Maybe Text)
- cvetFailureRedirectionURL :: Lens' CustomVerificationEmailTemplate (Maybe Text)
- cvetTemplateSubject :: Lens' CustomVerificationEmailTemplate (Maybe Text)
- cvetSuccessRedirectionURL :: Lens' CustomVerificationEmailTemplate (Maybe Text)
- data Destination
- destination :: Destination
- dBCCAddresses :: Lens' Destination [Text]
- dCCAddresses :: Lens' Destination [Text]
- dToAddresses :: Lens' Destination [Text]
- data EventDestination
- eventDestination :: Text -> EventDestination
- edEnabled :: Lens' EventDestination (Maybe Bool)
- edKinesisFirehoseDestination :: Lens' EventDestination (Maybe KinesisFirehoseDestination)
- edCloudWatchDestination :: Lens' EventDestination (Maybe CloudWatchDestination)
- edSNSDestination :: Lens' EventDestination (Maybe SNSDestination)
- edName :: Lens' EventDestination Text
- edMatchingEventTypes :: Lens' EventDestination [EventType]
- data ExtensionField
- extensionField :: Text -> Text -> ExtensionField
- efName :: Lens' ExtensionField Text
- efValue :: Lens' ExtensionField Text
- data IdentityDkimAttributes
- identityDkimAttributes :: Bool -> VerificationStatus -> IdentityDkimAttributes
- idaDkimTokens :: Lens' IdentityDkimAttributes [Text]
- idaDkimEnabled :: Lens' IdentityDkimAttributes Bool
- idaDkimVerificationStatus :: Lens' IdentityDkimAttributes VerificationStatus
- data IdentityMailFromDomainAttributes
- identityMailFromDomainAttributes :: Text -> CustomMailFromStatus -> BehaviorOnMXFailure -> IdentityMailFromDomainAttributes
- imfdaMailFromDomain :: Lens' IdentityMailFromDomainAttributes Text
- imfdaMailFromDomainStatus :: Lens' IdentityMailFromDomainAttributes CustomMailFromStatus
- imfdaBehaviorOnMXFailure :: Lens' IdentityMailFromDomainAttributes BehaviorOnMXFailure
- data IdentityNotificationAttributes
- identityNotificationAttributes :: Text -> Text -> Text -> Bool -> IdentityNotificationAttributes
- inaHeadersInDeliveryNotificationsEnabled :: Lens' IdentityNotificationAttributes (Maybe Bool)
- inaHeadersInComplaintNotificationsEnabled :: Lens' IdentityNotificationAttributes (Maybe Bool)
- inaHeadersInBounceNotificationsEnabled :: Lens' IdentityNotificationAttributes (Maybe Bool)
- inaBounceTopic :: Lens' IdentityNotificationAttributes Text
- inaComplaintTopic :: Lens' IdentityNotificationAttributes Text
- inaDeliveryTopic :: Lens' IdentityNotificationAttributes Text
- inaForwardingEnabled :: Lens' IdentityNotificationAttributes Bool
- data IdentityVerificationAttributes
- identityVerificationAttributes :: VerificationStatus -> IdentityVerificationAttributes
- ivaVerificationToken :: Lens' IdentityVerificationAttributes (Maybe Text)
- ivaVerificationStatus :: Lens' IdentityVerificationAttributes VerificationStatus
- data KinesisFirehoseDestination
- kinesisFirehoseDestination :: Text -> Text -> KinesisFirehoseDestination
- kfdIAMRoleARN :: Lens' KinesisFirehoseDestination Text
- kfdDeliveryStreamARN :: Lens' KinesisFirehoseDestination Text
- data LambdaAction
- lambdaAction :: Text -> LambdaAction
- laInvocationType :: Lens' LambdaAction (Maybe InvocationType)
- laTopicARN :: Lens' LambdaAction (Maybe Text)
- laFunctionARN :: Lens' LambdaAction Text
- data Message
- message :: Content -> Body -> Message
- mSubject :: Lens' Message Content
- mBody :: Lens' Message Body
- data MessageDsn
- messageDsn :: Text -> MessageDsn
- mdArrivalDate :: Lens' MessageDsn (Maybe UTCTime)
- mdExtensionFields :: Lens' MessageDsn [ExtensionField]
- mdReportingMta :: Lens' MessageDsn Text
- data MessageTag
- messageTag :: Text -> Text -> MessageTag
- mtName :: Lens' MessageTag Text
- mtValue :: Lens' MessageTag Text
- data RawMessage
- rawMessage :: ByteString -> RawMessage
- rmData :: Lens' RawMessage ByteString
- data ReceiptAction
- receiptAction :: ReceiptAction
- raAddHeaderAction :: Lens' ReceiptAction (Maybe AddHeaderAction)
- raSNSAction :: Lens' ReceiptAction (Maybe SNSAction)
- raWorkmailAction :: Lens' ReceiptAction (Maybe WorkmailAction)
- raBounceAction :: Lens' ReceiptAction (Maybe BounceAction)
- raLambdaAction :: Lens' ReceiptAction (Maybe LambdaAction)
- raStopAction :: Lens' ReceiptAction (Maybe StopAction)
- raS3Action :: Lens' ReceiptAction (Maybe S3Action)
- data ReceiptFilter
- receiptFilter :: Text -> ReceiptIPFilter -> ReceiptFilter
- rfName :: Lens' ReceiptFilter Text
- rfIPFilter :: Lens' ReceiptFilter ReceiptIPFilter
- data ReceiptIPFilter
- receiptIPFilter :: ReceiptFilterPolicy -> Text -> ReceiptIPFilter
- rifPolicy :: Lens' ReceiptIPFilter ReceiptFilterPolicy
- rifCidr :: Lens' ReceiptIPFilter Text
- data ReceiptRule
- receiptRule :: Text -> ReceiptRule
- rrScanEnabled :: Lens' ReceiptRule (Maybe Bool)
- rrEnabled :: Lens' ReceiptRule (Maybe Bool)
- rrActions :: Lens' ReceiptRule [ReceiptAction]
- rrRecipients :: Lens' ReceiptRule [Text]
- rrTLSPolicy :: Lens' ReceiptRule (Maybe TLSPolicy)
- rrName :: Lens' ReceiptRule Text
- data ReceiptRuleSetMetadata
- receiptRuleSetMetadata :: ReceiptRuleSetMetadata
- rrsmName :: Lens' ReceiptRuleSetMetadata (Maybe Text)
- rrsmCreatedTimestamp :: Lens' ReceiptRuleSetMetadata (Maybe UTCTime)
- data RecipientDsnFields
- recipientDsnFields :: DsnAction -> Text -> RecipientDsnFields
- rdfDiagnosticCode :: Lens' RecipientDsnFields (Maybe Text)
- rdfRemoteMta :: Lens' RecipientDsnFields (Maybe Text)
- rdfFinalRecipient :: Lens' RecipientDsnFields (Maybe Text)
- rdfExtensionFields :: Lens' RecipientDsnFields [ExtensionField]
- rdfLastAttemptDate :: Lens' RecipientDsnFields (Maybe UTCTime)
- rdfAction :: Lens' RecipientDsnFields DsnAction
- rdfStatus :: Lens' RecipientDsnFields Text
- data ReputationOptions
- reputationOptions :: ReputationOptions
- roLastFreshStart :: Lens' ReputationOptions (Maybe UTCTime)
- roReputationMetricsEnabled :: Lens' ReputationOptions (Maybe Bool)
- roSendingEnabled :: Lens' ReputationOptions (Maybe Bool)
- data S3Action
- s3Action :: Text -> S3Action
- s3KMSKeyARN :: Lens' S3Action (Maybe Text)
- s3TopicARN :: Lens' S3Action (Maybe Text)
- s3ObjectKeyPrefix :: Lens' S3Action (Maybe Text)
- s3BucketName :: Lens' S3Action Text
- data SNSAction
- snsAction :: Text -> SNSAction
- saEncoding :: Lens' SNSAction (Maybe SNSActionEncoding)
- saTopicARN :: Lens' SNSAction Text
- data SNSDestination
- snsDestination :: Text -> SNSDestination
- sdTopicARN :: Lens' SNSDestination Text
- data SendDataPoint
- sendDataPoint :: SendDataPoint
- sdpRejects :: Lens' SendDataPoint (Maybe Integer)
- sdpComplaints :: Lens' SendDataPoint (Maybe Integer)
- sdpDeliveryAttempts :: Lens' SendDataPoint (Maybe Integer)
- sdpBounces :: Lens' SendDataPoint (Maybe Integer)
- sdpTimestamp :: Lens' SendDataPoint (Maybe UTCTime)
- data StopAction
- stopAction :: StopScope -> StopAction
- sTopicARN :: Lens' StopAction (Maybe Text)
- sScope :: Lens' StopAction StopScope
- data Template
- template :: Text -> Template
- tTextPart :: Lens' Template (Maybe Text)
- tSubjectPart :: Lens' Template (Maybe Text)
- tHTMLPart :: Lens' Template (Maybe Text)
- tTemplateName :: Lens' Template Text
- data TemplateMetadata
- templateMetadata :: TemplateMetadata
- tmName :: Lens' TemplateMetadata (Maybe Text)
- tmCreatedTimestamp :: Lens' TemplateMetadata (Maybe UTCTime)
- data TrackingOptions
- trackingOptions :: TrackingOptions
- toCustomRedirectDomain :: Lens' TrackingOptions (Maybe Text)
- data WorkmailAction
- workmailAction :: Text -> WorkmailAction
- waTopicARN :: Lens' WorkmailAction (Maybe Text)
- waOrganizationARN :: Lens' WorkmailAction Text
Service Configuration
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by SES.
InvalidConfigurationSetException
_InvalidConfigurationSetException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the configuration set is invalid. See the error message for details.
InvalidSNSDestinationException
_InvalidSNSDestinationException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error message for details.
TemplateDoesNotExistException
_TemplateDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the Template object you specified does not exist in your Amazon SES account.
ConfigurationSetSendingPausedException
_ConfigurationSetSendingPausedException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that email sending is disabled for the configuration set.
You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled .
CannotDeleteException
_CannotDeleteException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the delete operation could not be completed.
ProductionAccessNotGrantedException
_ProductionAccessNotGrantedException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the account has not been granted production access.
RuleDoesNotExistException
_RuleDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the provided receipt rule does not exist.
MessageRejected
_MessageRejected :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
InvalidRenderingParameterException
_InvalidRenderingParameterException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that one or more of the replacement values you provided is invalid. This error may occur when the TemplateData object contains invalid JSON.
MissingRenderingAttributeException
_MissingRenderingAttributeException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that one or more of the replacement values for the specified template was not specified. Ensure that the TemplateData object contains references to all of the replacement tags in the specified template.
FromEmailAddressNotVerifiedException
_FromEmailAddressNotVerifiedException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the sender address specified for a custom verification email is not verified, and is therefore not eligible to send the custom verification email.
RuleSetDoesNotExistException
_RuleSetDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the provided receipt rule set does not exist.
MailFromDomainNotVerifiedException
_MailFromDomainNotVerifiedException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide .
InvalidFirehoseDestinationException
_InvalidFirehoseDestinationException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.
ConfigurationSetAlreadyExistsException
_ConfigurationSetAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the configuration set could not be created because of a naming conflict.
CustomVerificationEmailInvalidContentException
_CustomVerificationEmailInvalidContentException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that custom verification email template provided content is invalid.
InvalidTrackingOptionsException
_InvalidTrackingOptionsException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the custom domain to be used for open and click tracking redirects is invalid. This error appears most often in the following situations:
- When the tracking domain you specified is not verified in Amazon SES.
- When the tracking domain you specified is not a valid domain or subdomain.
AccountSendingPausedException
_AccountSendingPausedException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that email sending is disabled for your entire Amazon SES account.
You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled .
EventDestinationDoesNotExistException
_EventDestinationDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the event destination does not exist.
CustomVerificationEmailTemplateAlreadyExistsException
_CustomVerificationEmailTemplateAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that a custom verification email template with the name you specified already exists.
CustomVerificationEmailTemplateDoesNotExistException
_CustomVerificationEmailTemplateDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that a custom verification email template with the name you specified does not exist.
InvalidCloudWatchDestinationException
_InvalidCloudWatchDestinationException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.
InvalidLambdaFunctionException
_InvalidLambdaFunctionException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide .
TrackingOptionsDoesNotExistException
_TrackingOptionsDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the TrackingOptions object you specified does not exist.
InvalidTemplateException
_InvalidTemplateException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that a template could not be created because it contained invalid JSON.
ConfigurationSetDoesNotExistException
_ConfigurationSetDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the configuration set does not exist.
InvalidPolicyException
_InvalidPolicyException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.
InvalidS3ConfigurationException
_InvalidS3ConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide .
TrackingOptionsAlreadyExistsException
_TrackingOptionsAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the configuration set you specified already contains a TrackingOptions object.
InvalidSNSTopicException
_InvalidSNSTopicException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide .
EventDestinationAlreadyExistsException
_EventDestinationAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that the event destination could not be created because of a naming conflict.
AlreadyExistsException
_AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that a resource could not be created because of a naming conflict.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError #
Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide .
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateTemplate
DeleteConfigurationSetTrackingOptions
UpdateConfigurationSetTrackingOptions
CreateReceiptRuleSet
SetIdentityHeadersInNotificationsEnabled
GetSendQuota
module Network.AWS.SES.GetSendQuota
DescribeConfigurationSet
PutIdentityPolicy
DeleteCustomVerificationEmailTemplate
DeleteIdentityPolicy
UpdateCustomVerificationEmailTemplate
SendCustomVerificationEmail
GetIdentityNotificationAttributes
UpdateConfigurationSetReputationMetricsEnabled
ListIdentityPolicies
SetIdentityDkimEnabled
ListReceiptFilters
DescribeReceiptRuleSet
GetIdentityMailFromDomainAttributes
CreateReceiptFilter
UpdateConfigurationSetEventDestination
DeleteConfigurationSetEventDestination
SetIdentityMailFromDomain
SetIdentityFeedbackForwardingEnabled
ListConfigurationSets
DeleteConfigurationSet
GetIdentityVerificationAttributes
GetIdentityPolicies
ListTemplates
VerifyDomainIdentity
UpdateTemplate
DeleteTemplate
ReorderReceiptRuleSet
ListReceiptRuleSets
DeleteReceiptRuleSet
SetReceiptRulePosition
SendBounce
module Network.AWS.SES.SendBounce
GetIdentityDkimAttributes
SendTemplatedEmail
VerifyDomainDkim
TestRenderTemplate
SendBulkTemplatedEmail
SendRawEmail
module Network.AWS.SES.SendRawEmail
GetSendStatistics
ListCustomVerificationEmailTemplates (Paginated)
DeleteIdentity
DescribeReceiptRule
ListIdentities (Paginated)
UpdateConfigurationSetSendingEnabled
CreateCustomVerificationEmailTemplate
VerifyEmailIdentity
VerifyEmailAddress
DeleteVerifiedEmailAddress
DeleteReceiptFilter
ListVerifiedEmailAddresses
GetCustomVerificationEmailTemplate
SetIdentityNotificationTopic
SendEmail
module Network.AWS.SES.SendEmail
DeleteReceiptRule
UpdateReceiptRule
CloneReceiptRuleSet
CreateConfigurationSetEventDestination
GetAccountSendingEnabled
CreateReceiptRule
GetTemplate
module Network.AWS.SES.GetTemplate
SetActiveReceiptRuleSet
CreateConfigurationSet
UpdateAccountSendingEnabled
CreateConfigurationSetTrackingOptions
DescribeActiveReceiptRuleSet
Types
BehaviorOnMXFailure
data BehaviorOnMXFailure #
Constructors
| RejectMessage | |
| UseDefaultValue |
Instances
BounceType
data BounceType #
Instances
BulkEmailStatus
data BulkEmailStatus #
Constructors
Instances
ConfigurationSetAttribute
data ConfigurationSetAttribute #
Constructors
| EventDestinations | |
| ReputationOptions | |
| TrackingOptions |
Instances
CustomMailFromStatus
data CustomMailFromStatus #
Constructors
| CMFSFailed | |
| CMFSPending | |
| CMFSSuccess | |
| CMFSTemporaryFailure |
Instances
DimensionValueSource
data DimensionValueSource #
Constructors
| EmailHeader | |
| LinkTag | |
| MessageTag |
Instances
DsnAction
Constructors
| DADelayed | |
| DADelivered | |
| DAExpanded | |
| DAFailed | |
| DARelayed |
Instances
EventType
Constructors
| ETBounce | |
| ETClick | |
| ETComplaint | |
| ETDelivery | |
| ETOpen | |
| ETReject | |
| ETRenderingFailure | |
| ETSend |
Instances
IdentityType
data IdentityType #
Constructors
| Domain | |
| EmailAddress |
Instances
InvocationType
data InvocationType #
Constructors
| Event | |
| RequestResponse |
Instances
NotificationType
data NotificationType #
Instances
ReceiptFilterPolicy
data ReceiptFilterPolicy #
Instances
SNSActionEncoding
data SNSActionEncoding #
Instances
StopScope
Constructors
| RuleSet |
Instances
TLSPolicy
Instances
VerificationStatus
data VerificationStatus #
Constructors
| VSFailed | |
| VSNotStarted | |
| VSPending | |
| VSSuccess | |
| VSTemporaryFailure |
Instances
AddHeaderAction
data AddHeaderAction #
When included in a receipt rule, this action adds a header to the received email.
For information about adding a header using a receipt rule, see the Amazon SES Developer Guide .
See: addHeaderAction smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AddHeaderAction |
Creates a value of AddHeaderAction with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ahaHeaderName- The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.ahaHeaderValue- Must be less than 2048 characters, and must not contain newline characters ("r" or "n").
ahaHeaderName :: Lens' AddHeaderAction Text #
The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
ahaHeaderValue :: Lens' AddHeaderAction Text #
Must be less than 2048 characters, and must not contain newline characters ("r" or "n").
Body
Represents the body of the message. You can specify text, HTML, or both. If you use both, then the message should display correctly in the widest variety of email clients.
See: body smart constructor.
Instances
| Eq Body # | |
| Data Body # | |
Defined in Network.AWS.SES.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Body -> c Body # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Body # dataTypeOf :: Body -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Body) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Body) # gmapT :: (forall b. Data b => b -> b) -> Body -> Body # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Body -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Body -> r # gmapQ :: (forall d. Data d => d -> u) -> Body -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Body -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Body -> m Body # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Body -> m Body # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Body -> m Body # | |
| Read Body # | |
| Show Body # | |
| Generic Body # | |
| Hashable Body # | |
Defined in Network.AWS.SES.Types.Product | |
| ToQuery Body # | |
Defined in Network.AWS.SES.Types.Product Methods toQuery :: Body -> QueryString # | |
| NFData Body # | |
Defined in Network.AWS.SES.Types.Product | |
| type Rep Body # | |
Defined in Network.AWS.SES.Types.Product type Rep Body = D1 (MetaData "Body" "Network.AWS.SES.Types.Product" "amazonka-ses-1.6.1-GyciVs3kElCGWDMAMMcZl5" False) (C1 (MetaCons "Body'" PrefixI True) (S1 (MetaSel (Just "_bText") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Content)) :*: S1 (MetaSel (Just "_bHTML") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Content)))) | |
Creates a value of Body with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bText- The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).bHTML- 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.
bText :: Lens' Body (Maybe Content) #
The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
bHTML :: Lens' Body (Maybe Content) #
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.
BounceAction
data BounceAction #
When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
For information about sending a bounce message in response to a received email, see the Amazon SES Developer Guide .
See: bounceAction smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> BounceAction |
Creates a value of BounceAction with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
baTopicARN- The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN isarn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .baStatusCode- The SMTP enhanced status code, as defined by RFC 3463 .baSmtpReplyCode- The SMTP reply code, as defined by RFC 5321 .baMessage- Human-readable text to include in the bounce message.baSender- The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
baTopicARN :: Lens' BounceAction (Maybe Text) #
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
baStatusCode :: Lens' BounceAction (Maybe Text) #
The SMTP enhanced status code, as defined by RFC 3463 .
baSmtpReplyCode :: Lens' BounceAction Text #
The SMTP reply code, as defined by RFC 5321 .
baMessage :: Lens' BounceAction Text #
Human-readable text to include in the bounce message.
baSender :: Lens' BounceAction Text #
The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
BouncedRecipientInfo
data BouncedRecipientInfo #
Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide .
See: bouncedRecipientInfo smart constructor.
Instances
Arguments
| :: Text | |
| -> BouncedRecipientInfo |
Creates a value of BouncedRecipientInfo with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
briBounceType- The reason for the bounce. You must provide either this parameter orRecipientDsnFields.briRecipientDsnFields- Recipient-related DSN fields, most of which would normally be filled in automatically when provided with aBounceType. You must provide either this parameter orBounceType.briRecipientARN- This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide .briRecipient- The email address of the recipient of the bounced email.
briBounceType :: Lens' BouncedRecipientInfo (Maybe BounceType) #
The reason for the bounce. You must provide either this parameter or RecipientDsnFields .
briRecipientDsnFields :: Lens' BouncedRecipientInfo (Maybe RecipientDsnFields) #
Recipient-related DSN fields, most of which would normally be filled in automatically when provided with a BounceType . You must provide either this parameter or BounceType .
briRecipientARN :: Lens' BouncedRecipientInfo (Maybe Text) #
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide .
briRecipient :: Lens' BouncedRecipientInfo Text #
The email address of the recipient of the bounced email.
BulkEmailDestination
data BulkEmailDestination #
An array that contains one or more Destinations, as well as the tags and replacement data associated with each of those Destinations.
See: bulkEmailDestination smart constructor.
Instances
Arguments
| :: Destination | |
| -> BulkEmailDestination |
Creates a value of BulkEmailDestination with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bedReplacementTemplateData- 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.bedReplacementTags- A list of tags, in the form of name/value pairs, to apply to an email that you send usingSendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.bedDestination- Undocumented member.
bedReplacementTemplateData :: Lens' BulkEmailDestination (Maybe Text) #
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.
bedReplacementTags :: Lens' BulkEmailDestination [MessageTag] #
A list of tags, in the form of name/value pairs, to apply to an email that you send using SendBulkTemplatedEmail . Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
bedDestination :: Lens' BulkEmailDestination Destination #
Undocumented member.
BulkEmailDestinationStatus
data BulkEmailDestinationStatus #
An object that contains the response from the SendBulkTemplatedEmail operation.
See: bulkEmailDestinationStatus smart constructor.
Instances
bulkEmailDestinationStatus :: BulkEmailDestinationStatus #
Creates a value of BulkEmailDestinationStatus with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bedsStatus- The status of a message sent using theSendBulkTemplatedEmailoperation. Possible values for this parameter include: *Success: Amazon SES accepted the message, and will attempt to deliver it to the recipients. *MessageRejected: The message was rejected because it contained a virus. *MailFromDomainNotVerified: The sender's email address or domain was not verified. *ConfigurationSetDoesNotExist: The configuration set you specified does not exist. *TemplateDoesNotExist: The template you specified does not exist. *AccountSuspended: Your account has been shut down because of issues related to your email sending practices. *AccountThrottled: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit. *AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period. *InvalidSendingPoolName: The configuration set you specified refers to an IP pool that does not exist. *AccountSendingPaused: Email sending for the Amazon SES account was disabled using theUpdateAccountSendingEnabledoperation. *ConfigurationSetSendingPaused: Email sending for this configuration set was disabled using theUpdateConfigurationSetSendingEnabledoperation. *InvalidParameterValue: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information. *TransientFailure: 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.bedsError- A description of an error that prevented a message being sent using theSendBulkTemplatedEmailoperation.bedsMessageId- The unique message identifier returned from theSendBulkTemplatedEmailoperation.
bedsStatus :: Lens' BulkEmailDestinationStatus (Maybe BulkEmailStatus) #
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. * MessageRejected : The message was rejected because it contained a virus. * MailFromDomainNotVerified : The sender's email address or domain was not verified. * ConfigurationSetDoesNotExist : The configuration set you specified does not exist. * TemplateDoesNotExist : The template you specified does not exist. * AccountSuspended : Your account has been shut down because of issues related to your email sending practices. * AccountThrottled : The number of emails you can send has been reduced because your account has exceeded its allocated sending limit. * AccountDailyQuotaExceeded : You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period. * InvalidSendingPoolName : The configuration set you specified refers to an IP pool that does not exist. * AccountSendingPaused : Email sending for the Amazon SES account was disabled using the UpdateAccountSendingEnabled operation. * ConfigurationSetSendingPaused : Email sending for this configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation. * InvalidParameterValue : One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information. * TransientFailure : 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.
bedsError :: Lens' BulkEmailDestinationStatus (Maybe Text) #
A description of an error that prevented a message being sent using the SendBulkTemplatedEmail operation.
bedsMessageId :: Lens' BulkEmailDestinationStatus (Maybe Text) #
The unique message identifier returned from the SendBulkTemplatedEmail operation.
CloudWatchDestination
data CloudWatchDestination #
Contains information associated with an Amazon CloudWatch event destination to which email sending events are published.
Event destinations, such as Amazon CloudWatch, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide .
See: cloudWatchDestination smart constructor.
Instances
cloudWatchDestination :: CloudWatchDestination #
Creates a value of CloudWatchDestination with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cwdDimensionConfigurations- A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.
cwdDimensionConfigurations :: Lens' CloudWatchDestination [CloudWatchDimensionConfiguration] #
A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.
CloudWatchDimensionConfiguration
data CloudWatchDimensionConfiguration #
Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.
For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide .
See: cloudWatchDimensionConfiguration smart constructor.
Instances
cloudWatchDimensionConfiguration #
Arguments
| :: Text | |
| -> DimensionValueSource | |
| -> Text | |
| -> CloudWatchDimensionConfiguration |
Creates a value of CloudWatchDimensionConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cwdcDimensionName- The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Contain less than 256 characters.cwdcDimensionValueSource- The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using anX-SES-MESSAGE-TAGSheader or a parameter to theSendEmail/SendRawEmailAPI, choosemessageTag. If you want Amazon SES to use your own email headers, chooseemailHeader.cwdcDefaultDimensionValue- The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Contain less than 256 characters.
cwdcDimensionName :: Lens' CloudWatchDimensionConfiguration Text #
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Contain less than 256 characters.
cwdcDimensionValueSource :: Lens' CloudWatchDimensionConfiguration DimensionValueSource #
The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail /SendRawEmail API, choose messageTag . If you want Amazon SES to use your own email headers, choose emailHeader .
cwdcDefaultDimensionValue :: Lens' CloudWatchDimensionConfiguration Text #
The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Contain less than 256 characters.
ConfigurationSet
data ConfigurationSet #
The name of the configuration set.
Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES. For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .
See: configurationSet smart constructor.
Instances
Arguments
| :: Text | |
| -> ConfigurationSet |
Creates a value of ConfigurationSet with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csName- The name of the configuration set. The name must meet the following requirements: * Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Contain 64 characters or fewer.
csName :: Lens' ConfigurationSet Text #
The name of the configuration set. The name must meet the following requirements: * Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Contain 64 characters or fewer.
Content
Represents textual data, plus an optional character set specification.
By default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol. If the text must contain any other characters, then you must also specify a character set. Examples include UTF-8, ISO-8859-1, and Shift_JIS.
See: content smart constructor.
Instances
| Eq Content # | |
| Data Content # | |
Defined in Network.AWS.SES.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Content -> c Content # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Content # toConstr :: Content -> Constr # dataTypeOf :: Content -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Content) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Content) # gmapT :: (forall b. Data b => b -> b) -> Content -> Content # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Content -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Content -> r # gmapQ :: (forall d. Data d => d -> u) -> Content -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Content -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Content -> m Content # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Content -> m Content # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Content -> m Content # | |
| Read Content # | |
| Show Content # | |
| Generic Content # | |
| Hashable Content # | |
Defined in Network.AWS.SES.Types.Product | |
| ToQuery Content # | |
Defined in Network.AWS.SES.Types.Product Methods toQuery :: Content -> QueryString # | |
| NFData Content # | |
Defined in Network.AWS.SES.Types.Product | |
| type Rep Content # | |
Defined in Network.AWS.SES.Types.Product type Rep Content = D1 (MetaData "Content" "Network.AWS.SES.Types.Product" "amazonka-ses-1.6.1-GyciVs3kElCGWDMAMMcZl5" False) (C1 (MetaCons "Content'" PrefixI True) (S1 (MetaSel (Just "_cCharset") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) | |
CustomVerificationEmailTemplate
data CustomVerificationEmailTemplate #
Contains information about a custom verification email template.
See: customVerificationEmailTemplate smart constructor.
Instances
customVerificationEmailTemplate :: CustomVerificationEmailTemplate #
Creates a value of CustomVerificationEmailTemplate with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cvetFromEmailAddress- The email address that the custom verification email is sent from.cvetTemplateName- The name of the custom verification email template.cvetFailureRedirectionURL- The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.cvetTemplateSubject- The subject line of the custom verification email.cvetSuccessRedirectionURL- The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
cvetFromEmailAddress :: Lens' CustomVerificationEmailTemplate (Maybe Text) #
The email address that the custom verification email is sent from.
cvetTemplateName :: Lens' CustomVerificationEmailTemplate (Maybe Text) #
The name of the custom verification email template.
cvetFailureRedirectionURL :: Lens' CustomVerificationEmailTemplate (Maybe Text) #
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
cvetTemplateSubject :: Lens' CustomVerificationEmailTemplate (Maybe Text) #
The subject line of the custom verification email.
cvetSuccessRedirectionURL :: Lens' CustomVerificationEmailTemplate (Maybe Text) #
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
Destination
data Destination #
Represents the destination of the message, consisting of To:, CC:, and BCC: fields.
See: destination smart constructor.
Instances
Creates a value of Destination with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dBCCAddresses- The BCC: field(s) of the message.dCCAddresses- The CC: field(s) of the message.dToAddresses- The To: field(s) of the message.
dBCCAddresses :: Lens' Destination [Text] #
The BCC: field(s) of the message.
dCCAddresses :: Lens' Destination [Text] #
The CC: field(s) of the message.
dToAddresses :: Lens' Destination [Text] #
The To: field(s) of the message.
EventDestination
data EventDestination #
Contains information about the event destination that the specified email sending events will be published to.
Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the Amazon SES Developer Guide .
See: eventDestination smart constructor.
Instances
Arguments
| :: Text | |
| -> EventDestination |
Creates a value of EventDestination with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
edEnabled- Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set totrueto enable publishing to this destination; set tofalseto prevent publishing to this destination. The default value isfalse.edKinesisFirehoseDestination- An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.edCloudWatchDestination- An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.edSNSDestination- An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.edName- The name of the event destination. The name must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Contain less than 64 characters.edMatchingEventTypes- The type of email sending events to publish to the event destination.
edEnabled :: Lens' EventDestination (Maybe Bool) #
Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false .
edKinesisFirehoseDestination :: Lens' EventDestination (Maybe KinesisFirehoseDestination) #
An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
edCloudWatchDestination :: Lens' EventDestination (Maybe CloudWatchDestination) #
An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
edSNSDestination :: Lens' EventDestination (Maybe SNSDestination) #
An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
edName :: Lens' EventDestination Text #
The name of the event destination. The name must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Contain less than 64 characters.
edMatchingEventTypes :: Lens' EventDestination [EventType] #
The type of email sending events to publish to the event destination.
ExtensionField
data ExtensionField #
Additional X-headers to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide .
See: extensionField smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ExtensionField |
Creates a value of ExtensionField with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
efName :: Lens' ExtensionField Text #
The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
efValue :: Lens' ExtensionField Text #
The value of the header to add. Must be less than 2048 characters, and must not contain newline characters ("r" or "n").
IdentityDkimAttributes
data IdentityDkimAttributes #
Represents the DKIM attributes of a verified email address or a domain.
See: identityDkimAttributes smart constructor.
Instances
Arguments
| :: Bool | |
| -> VerificationStatus | |
| -> IdentityDkimAttributes |
Creates a value of IdentityDkimAttributes with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
idaDkimTokens- 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 .idaDkimEnabled- True if DKIM signing is enabled for email sent from the identity; false otherwise. The default value is true.idaDkimVerificationStatus- 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.)
idaDkimTokens :: Lens' IdentityDkimAttributes [Text] #
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 .
idaDkimEnabled :: Lens' IdentityDkimAttributes Bool #
True if DKIM signing is enabled for email sent from the identity; false otherwise. The default value is true.
idaDkimVerificationStatus :: Lens' IdentityDkimAttributes VerificationStatus #
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.)
IdentityMailFromDomainAttributes
data IdentityMailFromDomainAttributes #
Represents the custom MAIL FROM domain attributes of a verified identity (email address or domain).
See: identityMailFromDomainAttributes smart constructor.
Instances
identityMailFromDomainAttributes #
Arguments
| :: Text | |
| -> CustomMailFromStatus | |
| -> BehaviorOnMXFailure | |
| -> IdentityMailFromDomainAttributes |
Creates a value of IdentityMailFromDomainAttributes with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
imfdaMailFromDomain- The custom MAIL FROM domain that the identity is configured to use.imfdaMailFromDomainStatus- The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state isSuccess, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described byBehaviorOnMXFailure.imfdaBehaviorOnMXFailure- The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value ofUseDefaultValueindicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value ofRejectMessageindicates that if Amazon SES cannot read the required MX record, Amazon SES returns aMailFromDomainNotVerifiederror and does not send the email. The custom MAIL FROM setup states that result in this behavior arePending,Failed, andTemporaryFailure.
imfdaMailFromDomain :: Lens' IdentityMailFromDomainAttributes Text #
The custom MAIL FROM domain that the identity is configured to use.
imfdaMailFromDomainStatus :: Lens' IdentityMailFromDomainAttributes CustomMailFromStatus #
The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success , Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure .
imfdaBehaviorOnMXFailure :: Lens' IdentityMailFromDomainAttributes BehaviorOnMXFailure #
The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email. The custom MAIL FROM setup states that result in this behavior are Pending , Failed , and TemporaryFailure .
IdentityNotificationAttributes
data IdentityNotificationAttributes #
Represents the notification attributes of an identity, including whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications, and whether feedback forwarding is enabled for bounce and complaint notifications.
See: identityNotificationAttributes smart constructor.
Instances
identityNotificationAttributes #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Bool | |
| -> IdentityNotificationAttributes |
Creates a value of IdentityNotificationAttributes with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
inaHeadersInDeliveryNotificationsEnabled- Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of typeDelivery. A value oftruespecifies that Amazon SES will include headers in delivery notifications, and a value offalsespecifies that Amazon SES will not include headers in delivery notifications.inaHeadersInComplaintNotificationsEnabled- Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of typeComplaint. A value oftruespecifies that Amazon SES will include headers in complaint notifications, and a value offalsespecifies that Amazon SES will not include headers in complaint notifications.inaHeadersInBounceNotificationsEnabled- Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of typeBounce. A value oftruespecifies that Amazon SES will include headers in bounce notifications, and a value offalsespecifies that Amazon SES will not include headers in bounce notifications.inaBounceTopic- The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.inaComplaintTopic- The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.inaDeliveryTopic- The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.inaForwardingEnabled- Describes whether Amazon SES will forward bounce and complaint notifications as email.trueindicates that Amazon SES will forward bounce and complaint notifications as email, whilefalseindicates that bounce and complaint notifications will be published only to the specified bounce and complaint Amazon SNS topics.
inaHeadersInDeliveryNotificationsEnabled :: Lens' IdentityNotificationAttributes (Maybe Bool) #
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Delivery . A value of true specifies that Amazon SES will include headers in delivery notifications, and a value of false specifies that Amazon SES will not include headers in delivery notifications.
inaHeadersInComplaintNotificationsEnabled :: Lens' IdentityNotificationAttributes (Maybe Bool) #
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Complaint . A value of true specifies that Amazon SES will include headers in complaint notifications, and a value of false specifies that Amazon SES will not include headers in complaint notifications.
inaHeadersInBounceNotificationsEnabled :: Lens' IdentityNotificationAttributes (Maybe Bool) #
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Bounce . A value of true specifies that Amazon SES will include headers in bounce notifications, and a value of false specifies that Amazon SES will not include headers in bounce notifications.
inaBounceTopic :: Lens' IdentityNotificationAttributes Text #
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.
inaComplaintTopic :: Lens' IdentityNotificationAttributes Text #
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.
inaDeliveryTopic :: Lens' IdentityNotificationAttributes Text #
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.
inaForwardingEnabled :: Lens' IdentityNotificationAttributes Bool #
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.
IdentityVerificationAttributes
data IdentityVerificationAttributes #
Represents the verification attributes of a single identity.
See: identityVerificationAttributes smart constructor.
Instances
identityVerificationAttributes #
Creates a value of IdentityVerificationAttributes with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ivaVerificationToken- The verification token for a domain identity. Null for email address identities.ivaVerificationStatus- The verification status of the identity: Pending, Success, Failed, or TemporaryFailure.
ivaVerificationToken :: Lens' IdentityVerificationAttributes (Maybe Text) #
The verification token for a domain identity. Null for email address identities.
ivaVerificationStatus :: Lens' IdentityVerificationAttributes VerificationStatus #
The verification status of the identity: Pending, Success, Failed, or TemporaryFailure.
KinesisFirehoseDestination
data KinesisFirehoseDestination #
Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
Event destinations, such as Amazon Kinesis Firehose, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide .
See: kinesisFirehoseDestination smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> KinesisFirehoseDestination |
Creates a value of KinesisFirehoseDestination with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
kfdIAMRoleARN- The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.kfdDeliveryStreamARN- The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.
kfdIAMRoleARN :: Lens' KinesisFirehoseDestination Text #
The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.
kfdDeliveryStreamARN :: Lens' KinesisFirehoseDestination Text #
The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.
LambdaAction
data LambdaAction #
When included in a receipt rule, this action calls an AWS Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
To enable Amazon SES to call your AWS Lambda function or to publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide .
For information about using AWS Lambda actions in receipt rules, see the Amazon SES Developer Guide .
See: lambdaAction smart constructor.
Instances
Arguments
| :: Text | |
| -> LambdaAction |
Creates a value of LambdaAction with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
laInvocationType- The invocation type of the AWS Lambda function. An invocation type ofRequestResponsemeans that the execution of the function will immediately result in a response, and a value ofEventmeans that the function will be invoked asynchronously. The default value isEvent. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide . Important: There is a 30-second timeout onRequestResponseinvocations. You should useEventinvocation in most cases. UseRequestResponseonly when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.laTopicARN- The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN isarn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .laFunctionARN- The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN isarn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide .
laInvocationType :: Lens' LambdaAction (Maybe InvocationType) #
The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event . For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide . Important: There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
laTopicARN :: Lens' LambdaAction (Maybe Text) #
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
laFunctionARN :: Lens' LambdaAction Text #
The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction . For more information about AWS Lambda, see the AWS Lambda Developer Guide .
Message
Represents the message to be sent, composed of a subject and a body.
See: message smart constructor.
Instances
| Eq Message # | |
| Data Message # | |
Defined in Network.AWS.SES.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Message -> c Message # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Message # toConstr :: Message -> Constr # dataTypeOf :: Message -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Message) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Message) # gmapT :: (forall b. Data b => b -> b) -> Message -> Message # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Message -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Message -> r # gmapQ :: (forall d. Data d => d -> u) -> Message -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Message -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Message -> m Message # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Message -> m Message # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Message -> m Message # | |
| Read Message # | |
| Show Message # | |
| Generic Message # | |
| Hashable Message # | |
Defined in Network.AWS.SES.Types.Product | |
| ToQuery Message # | |
Defined in Network.AWS.SES.Types.Product Methods toQuery :: Message -> QueryString # | |
| NFData Message # | |
Defined in Network.AWS.SES.Types.Product | |
| type Rep Message # | |
Defined in Network.AWS.SES.Types.Product type Rep Message = D1 (MetaData "Message" "Network.AWS.SES.Types.Product" "amazonka-ses-1.6.1-GyciVs3kElCGWDMAMMcZl5" False) (C1 (MetaCons "Message'" PrefixI True) (S1 (MetaSel (Just "_mSubject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Content) :*: S1 (MetaSel (Just "_mBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Body))) | |
mSubject :: Lens' Message Content #
The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
MessageDsn
data MessageDsn #
Message-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide .
See: messageDsn smart constructor.
Instances
Arguments
| :: Text | |
| -> MessageDsn |
Creates a value of MessageDsn with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mdArrivalDate- When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.mdExtensionFields- Additional X-headers to include in the DSN.mdReportingMta- The reporting MTA that attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). The default value isdns; inbound-smtp.[region].amazonaws.com.
mdArrivalDate :: Lens' MessageDsn (Maybe UTCTime) #
When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.
mdExtensionFields :: Lens' MessageDsn [ExtensionField] #
Additional X-headers to include in the DSN.
mdReportingMta :: Lens' MessageDsn Text #
The reporting MTA that attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name ). The default value is dns; inbound-smtp.[region].amazonaws.com .
MessageTag
data MessageTag #
Contains the name and value of a tag that you can provide to SendEmail or SendRawEmail to apply to an email.
Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide .
See: messageTag smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> MessageTag |
Creates a value of MessageTag with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mtName- The name of the tag. The name must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Contain less than 256 characters.mtValue- The value of the tag. The value must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Contain less than 256 characters.
mtName :: Lens' MessageTag Text #
The name of the tag. The name must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Contain less than 256 characters.
mtValue :: Lens' MessageTag Text #
The value of the tag. The value must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Contain less than 256 characters.
RawMessage
data RawMessage #
Represents the raw data of the message.
See: rawMessage smart constructor.
Instances
Arguments
| :: ByteString | |
| -> RawMessage |
Creates a value of RawMessage with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rmData- The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding. The To:, CC:, and BCC: headers in the raw message can contain a group list. If you are usingSendRawEmailwith sending authorization, you can include X-headers in the raw message to specify the "Source," "From," and "Return-Path" addresses. For more information, see the documentation forSendRawEmail. Important: Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email. For more information, go to the Amazon SES Developer Guide .-- Note: ThisLensautomatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLensaccepts and returns only raw unencoded data.
rmData :: Lens' RawMessage ByteString #
The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding. The To:, CC:, and BCC: headers in the raw message can contain a group list. If you are using SendRawEmail with sending authorization, you can include X-headers in the raw message to specify the "Source," "From," and "Return-Path" addresses. For more information, see the documentation for SendRawEmail . Important: Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email. For more information, go to the Amazon SES Developer Guide .-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.
ReceiptAction
data ReceiptAction #
An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.
For information about setting up receipt rules, see the Amazon SES Developer Guide .
See: receiptAction smart constructor.
Instances
receiptAction :: ReceiptAction #
Creates a value of ReceiptAction with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
raAddHeaderAction- Adds a header to the received email.raSNSAction- Publishes the email content within a notification to Amazon SNS.raWorkmailAction- Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.raBounceAction- Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).raLambdaAction- Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.raStopAction- Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.raS3Action- Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
raAddHeaderAction :: Lens' ReceiptAction (Maybe AddHeaderAction) #
Adds a header to the received email.
raSNSAction :: Lens' ReceiptAction (Maybe SNSAction) #
Publishes the email content within a notification to Amazon SNS.
raWorkmailAction :: Lens' ReceiptAction (Maybe WorkmailAction) #
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
raBounceAction :: Lens' ReceiptAction (Maybe BounceAction) #
Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
raLambdaAction :: Lens' ReceiptAction (Maybe LambdaAction) #
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
raStopAction :: Lens' ReceiptAction (Maybe StopAction) #
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
raS3Action :: Lens' ReceiptAction (Maybe S3Action) #
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
ReceiptFilter
data ReceiptFilter #
A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.
For information about setting up IP address filters, see the Amazon SES Developer Guide .
See: receiptFilter smart constructor.
Instances
Arguments
| :: Text | |
| -> ReceiptIPFilter | |
| -> ReceiptFilter |
Creates a value of ReceiptFilter with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rfName- The name of the IP address filter. The name must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Start and end with a letter or number. * Contain less than 64 characters.rfIPFilter- A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.
rfName :: Lens' ReceiptFilter Text #
The name of the IP address filter. The name must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Start and end with a letter or number. * Contain less than 64 characters.
rfIPFilter :: Lens' ReceiptFilter ReceiptIPFilter #
A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.
ReceiptIPFilter
data ReceiptIPFilter #
A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.
For information about setting up IP address filters, see the Amazon SES Developer Guide .
See: receiptIPFilter smart constructor.
Instances
Arguments
| :: ReceiptFilterPolicy | |
| -> Text | |
| -> ReceiptIPFilter |
Creates a value of ReceiptIPFilter with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rifPolicy- Indicates whether to block or allow incoming mail from the specified IP addresses.rifCidr- A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.124. For more information about CIDR notation, see <https:tools.ietf.orghtml/rfc2317 RFC 2317> .
rifPolicy :: Lens' ReceiptIPFilter ReceiptFilterPolicy #
Indicates whether to block or allow incoming mail from the specified IP addresses.
rifCidr :: Lens' ReceiptIPFilter Text #
A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.124. For more information about CIDR notation, see <https:tools.ietf.orghtml/rfc2317 RFC 2317> .
ReceiptRule
data ReceiptRule #
Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.
Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.
For information about setting up receipt rules, see the Amazon SES Developer Guide .
See: receiptRule smart constructor.
Instances
Arguments
| :: Text | |
| -> ReceiptRule |
Creates a value of ReceiptRule with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrScanEnabled- Iftrue, then messages that this receipt rule applies to are scanned for spam and viruses. The default value isfalse.rrEnabled- Iftrue, the receipt rule is active. The default value isfalse.rrActions- An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.rrRecipients- The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.rrTLSPolicy- Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set toRequire, Amazon SES will bounce emails that are not received over TLS. The default isOptional.rrName- The name of the receipt rule. The name must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Start and end with a letter or number. * Contain less than 64 characters.
rrScanEnabled :: Lens' ReceiptRule (Maybe Bool) #
If true , then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false .
rrEnabled :: Lens' ReceiptRule (Maybe Bool) #
If true , the receipt rule is active. The default value is false .
rrActions :: Lens' ReceiptRule [ReceiptAction] #
An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
rrRecipients :: Lens' ReceiptRule [Text] #
The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.
rrTLSPolicy :: Lens' ReceiptRule (Maybe TLSPolicy) #
Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require , Amazon SES will bounce emails that are not received over TLS. The default is Optional .
rrName :: Lens' ReceiptRule Text #
The name of the receipt rule. The name must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Start and end with a letter or number. * Contain less than 64 characters.
ReceiptRuleSetMetadata
data ReceiptRuleSetMetadata #
Information about a receipt rule set.
A receipt rule set is a collection of rules that specify what Amazon SES should do with mail it receives on behalf of your account's verified domains.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide .
See: receiptRuleSetMetadata smart constructor.
Instances
receiptRuleSetMetadata :: ReceiptRuleSetMetadata #
Creates a value of ReceiptRuleSetMetadata with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrsmName- The name of the receipt rule set. The name must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Start and end with a letter or number. * Contain less than 64 characters.rrsmCreatedTimestamp- The date and time the receipt rule set was created.
rrsmName :: Lens' ReceiptRuleSetMetadata (Maybe Text) #
The name of the receipt rule set. The name must: * This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). * Start and end with a letter or number. * Contain less than 64 characters.
rrsmCreatedTimestamp :: Lens' ReceiptRuleSetMetadata (Maybe UTCTime) #
The date and time the receipt rule set was created.
RecipientDsnFields
data RecipientDsnFields #
Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide .
See: recipientDsnFields smart constructor.
Instances
Arguments
| :: DsnAction | |
| -> Text | |
| -> RecipientDsnFields |
Creates a value of RecipientDsnFields with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdfDiagnosticCode- An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.rdfRemoteMta- The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.rdfFinalRecipient- The email address that the message was ultimately delivered to. This corresponds to theFinal-Recipientin the DSN. If not specified,FinalRecipientwill be set to theRecipientspecified in theBouncedRecipientInfostructure. EitherFinalRecipientor the recipient inBouncedRecipientInfomust be a recipient of the original bounced message.rdfExtensionFields- Additional X-headers to include in the DSN.rdfLastAttemptDate- The time the final delivery attempt was made, in RFC 822 date-time format.rdfAction- The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464 .rdfStatus- The status code that indicates what went wrong. This is required by RFC 3464 .
rdfDiagnosticCode :: Lens' RecipientDsnFields (Maybe Text) #
An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.
rdfRemoteMta :: Lens' RecipientDsnFields (Maybe Text) #
The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name ). This parameter typically applies only to propagating synchronous bounces.
rdfFinalRecipient :: Lens' RecipientDsnFields (Maybe Text) #
The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.
rdfExtensionFields :: Lens' RecipientDsnFields [ExtensionField] #
Additional X-headers to include in the DSN.
rdfLastAttemptDate :: Lens' RecipientDsnFields (Maybe UTCTime) #
The time the final delivery attempt was made, in RFC 822 date-time format.
rdfAction :: Lens' RecipientDsnFields DsnAction #
The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464 .
rdfStatus :: Lens' RecipientDsnFields Text #
The status code that indicates what went wrong. This is required by RFC 3464 .
ReputationOptions
data ReputationOptions #
Contains information about the reputation settings for a configuration set.
See: reputationOptions smart constructor.
Instances
reputationOptions :: ReputationOptions #
Creates a value of ReputationOptions with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
roLastFreshStart- The date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start . When you disable email sending for a configuration set usingUpdateConfigurationSetSendingEnabledand later re-enable it, the reputation metrics for the configuration set (but not for the entire Amazon SES account) are reset. If email sending for the configuration set has never been disabled and later re-enabled, the value of this attribute isnull.roReputationMetricsEnabled- Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. If the value istrue, reputation metrics are published. If the value isfalse, reputation metrics are not published. The default value isfalse.roSendingEnabled- Describes whether email sending is enabled or disabled for the configuration set. If the value istrue, then Amazon SES will send emails that use the configuration set. If the value isfalse, Amazon SES will not send emails that use the configuration set. The default value istrue. You can change this setting usingUpdateConfigurationSetSendingEnabled.
roLastFreshStart :: Lens' ReputationOptions (Maybe UTCTime) #
The date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start . When you disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled and later re-enable it, the reputation metrics for the configuration set (but not for the entire Amazon SES account) are reset. If email sending for the configuration set has never been disabled and later re-enabled, the value of this attribute is null .
roReputationMetricsEnabled :: Lens' ReputationOptions (Maybe Bool) #
Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. If the value is true , reputation metrics are published. If the value is false , reputation metrics are not published. The default value is false .
roSendingEnabled :: Lens' ReputationOptions (Maybe Bool) #
Describes whether email sending is enabled or disabled for the configuration set. If the value is true , then Amazon SES will send emails that use the configuration set. If the value is false , Amazon SES will not send emails that use the configuration set. The default value is true . You can change this setting using UpdateConfigurationSetSendingEnabled .
S3Action
When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
To enable Amazon SES to write emails to your Amazon S3 bucket, use an AWS KMS key to encrypt your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide .
For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide .
See: s3Action smart constructor.
Instances
| Eq S3Action # | |
| Data S3Action # | |
Defined in Network.AWS.SES.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> S3Action -> c S3Action # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c S3Action # toConstr :: S3Action -> Constr # dataTypeOf :: S3Action -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c S3Action) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c S3Action) # gmapT :: (forall b. Data b => b -> b) -> S3Action -> S3Action # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> S3Action -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> S3Action -> r # gmapQ :: (forall d. Data d => d -> u) -> S3Action -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> S3Action -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> S3Action -> m S3Action # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> S3Action -> m S3Action # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> S3Action -> m S3Action # | |
| Read S3Action # | |
| Show S3Action # | |
| Generic S3Action # | |
| Hashable S3Action # | |
Defined in Network.AWS.SES.Types.Product | |
| FromXML S3Action # | |
| ToQuery S3Action # | |
Defined in Network.AWS.SES.Types.Product Methods toQuery :: S3Action -> QueryString # | |
| NFData S3Action # | |
Defined in Network.AWS.SES.Types.Product | |
| type Rep S3Action # | |
Defined in Network.AWS.SES.Types.Product type Rep S3Action = D1 (MetaData "S3Action" "Network.AWS.SES.Types.Product" "amazonka-ses-1.6.1-GyciVs3kElCGWDMAMMcZl5" False) (C1 (MetaCons "S3Action'" PrefixI True) ((S1 (MetaSel (Just "_s3KMSKeyARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_s3TopicARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_s3ObjectKeyPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_s3BucketName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) | |
Creates a value of S3Action with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
s3KMSKeyARN- The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows: * To use the default master key, provide an ARN in the form ofarn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:aliasawsses. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would bearn:aws:kms:us-west-2:123456789012:aliasawsses. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key. * To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide . For more information about key policies, see the AWS KMS Developer Guide . If you do not specify a master key, Amazon SES will not encrypt your emails. Important: Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS Java SDK and AWS Ruby SDK only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide .s3TopicARN- The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN isarn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .s3ObjectKeyPrefix- The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.s3BucketName- The name of the Amazon S3 bucket that incoming email will be saved to.
s3KMSKeyARN :: Lens' S3Action (Maybe Text) #
The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows: * To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:aliasawsses . For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:aliasawsses . If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key. * To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide . For more information about key policies, see the AWS KMS Developer Guide . If you do not specify a master key, Amazon SES will not encrypt your emails. Important: Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS Java SDK and AWS Ruby SDK only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide .
s3TopicARN :: Lens' S3Action (Maybe Text) #
The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
s3ObjectKeyPrefix :: Lens' S3Action (Maybe Text) #
The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
s3BucketName :: Lens' S3Action Text #
The name of the Amazon S3 bucket that incoming email will be saved to.
SNSAction
When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS notifications. Amazon SNS notifications for all other actions simply provide information about the email. They do not include the email content itself.
If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a policy to the topic to give Amazon SES permissions to access it. For information about giving permissions, see the Amazon SES Developer Guide .
Important: You can only publish emails that are 150 KB or less (including the header) to Amazon SNS. Larger emails will bounce. If you anticipate emails larger than 150 KB, use the S3 action instead.
For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon SES Developer Guide .
See: snsAction smart constructor.
Instances
| Eq SNSAction # | |
| Data SNSAction # | |
Defined in Network.AWS.SES.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SNSAction -> c SNSAction # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SNSAction # toConstr :: SNSAction -> Constr # dataTypeOf :: SNSAction -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SNSAction) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SNSAction) # gmapT :: (forall b. Data b => b -> b) -> SNSAction -> SNSAction # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SNSAction -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SNSAction -> r # gmapQ :: (forall d. Data d => d -> u) -> SNSAction -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SNSAction -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SNSAction -> m SNSAction # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SNSAction -> m SNSAction # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SNSAction -> m SNSAction # | |
| Read SNSAction # | |
| Show SNSAction # | |
| Generic SNSAction # | |
| Hashable SNSAction # | |
Defined in Network.AWS.SES.Types.Product | |
| FromXML SNSAction # | |
| ToQuery SNSAction # | |
Defined in Network.AWS.SES.Types.Product Methods toQuery :: SNSAction -> QueryString # | |
| NFData SNSAction # | |
Defined in Network.AWS.SES.Types.Product | |
| type Rep SNSAction # | |
Defined in Network.AWS.SES.Types.Product type Rep SNSAction = D1 (MetaData "SNSAction" "Network.AWS.SES.Types.Product" "amazonka-ses-1.6.1-GyciVs3kElCGWDMAMMcZl5" False) (C1 (MetaCons "SNSAction'" PrefixI True) (S1 (MetaSel (Just "_saEncoding") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SNSActionEncoding)) :*: S1 (MetaSel (Just "_saTopicARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) | |
Creates a value of SNSAction with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
saEncoding- The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.saTopicARN- The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN isarn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
saEncoding :: Lens' SNSAction (Maybe SNSActionEncoding) #
The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
saTopicARN :: Lens' SNSAction Text #
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
SNSDestination
data SNSDestination #
Contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
Event destinations, such as Amazon SNS, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide .
See: snsDestination smart constructor.
Instances
Arguments
| :: Text | |
| -> SNSDestination |
Creates a value of SNSDestination with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdTopicARN- The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN isarn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
sdTopicARN :: Lens' SNSDestination Text #
The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
SendDataPoint
data SendDataPoint #
Represents sending statistics data. Each SendDataPoint contains statistics for a 15-minute period of sending activity.
See: sendDataPoint smart constructor.
Instances
sendDataPoint :: SendDataPoint #
Creates a value of SendDataPoint with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdpRejects- Number of emails rejected by Amazon SES.sdpComplaints- Number of unwanted emails that were rejected by recipients.sdpDeliveryAttempts- Number of emails that have been sent.sdpBounces- Number of emails that have bounced.sdpTimestamp- Time of the data point.
sdpRejects :: Lens' SendDataPoint (Maybe Integer) #
Number of emails rejected by Amazon SES.
sdpComplaints :: Lens' SendDataPoint (Maybe Integer) #
Number of unwanted emails that were rejected by recipients.
sdpDeliveryAttempts :: Lens' SendDataPoint (Maybe Integer) #
Number of emails that have been sent.
sdpBounces :: Lens' SendDataPoint (Maybe Integer) #
Number of emails that have bounced.
sdpTimestamp :: Lens' SendDataPoint (Maybe UTCTime) #
Time of the data point.
StopAction
data StopAction #
When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
For information about setting a stop action in a receipt rule, see the Amazon SES Developer Guide .
See: stopAction smart constructor.
Instances
Arguments
| :: StopScope | |
| -> StopAction |
Creates a value of StopAction with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sTopicARN- The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN isarn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .sScope- The name of the RuleSet that is being stopped.
sTopicARN :: Lens' StopAction (Maybe Text) #
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
sScope :: Lens' StopAction StopScope #
The name of the RuleSet that is being stopped.
Template
The content of the email, composed of a subject line, an HTML part, and a text-only part.
See: template smart constructor.
Instances
Creates a value of Template with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tTextPart- The email body that will be visible to recipients whose email clients do not display HTML.tSubjectPart- The subject line of the email.tHTMLPart- The HTML body of the email.tTemplateName- The name of the template. You will refer to this name when you send email using theSendTemplatedEmailorSendBulkTemplatedEmailoperations.
tTextPart :: Lens' Template (Maybe Text) #
The email body that will be visible to recipients whose email clients do not display HTML.
tTemplateName :: Lens' Template Text #
The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
TemplateMetadata
data TemplateMetadata #
Contains information about an email template.
See: templateMetadata smart constructor.
Instances
templateMetadata :: TemplateMetadata #
Creates a value of TemplateMetadata with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tmName- The name of the template.tmCreatedTimestamp- The time and date the template was created.
tmCreatedTimestamp :: Lens' TemplateMetadata (Maybe UTCTime) #
The time and date the template was created.
TrackingOptions
data TrackingOptions #
A domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.
For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide .
See: trackingOptions smart constructor.
Instances
trackingOptions :: TrackingOptions #
Creates a value of TrackingOptions with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
toCustomRedirectDomain- The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.
toCustomRedirectDomain :: Lens' TrackingOptions (Maybe Text) #
The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.
WorkmailAction
data WorkmailAction #
When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). You will typically not use this action directly because Amazon WorkMail adds the rule automatically during its setup procedure.
For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide .
See: workmailAction smart constructor.
Instances
Arguments
| :: Text | |
| -> WorkmailAction |
Creates a value of WorkmailAction with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
waTopicARN- The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN isarn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .waOrganizationARN- The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN isarn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide .
waTopicARN :: Lens' WorkmailAction (Maybe Text) #
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
waOrganizationARN :: Lens' WorkmailAction Text #
The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7 . For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide .