| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.SES.Types
Contents
- Service Configuration
- Errors
- 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
- DeliveryOptions
- 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
Synopsis
- defaultService :: Service
- _AccountSendingPausedException :: AsError a => Fold a ServiceError
- _AlreadyExistsException :: AsError a => Fold a ServiceError
- _CannotDeleteException :: AsError a => Fold a ServiceError
- _ConfigurationSetAlreadyExistsException :: AsError a => Fold a ServiceError
- _ConfigurationSetDoesNotExistException :: AsError a => Fold a ServiceError
- _ConfigurationSetSendingPausedException :: AsError a => Fold a ServiceError
- _CustomVerificationEmailInvalidContentException :: AsError a => Fold a ServiceError
- _CustomVerificationEmailTemplateAlreadyExistsException :: AsError a => Fold a ServiceError
- _CustomVerificationEmailTemplateDoesNotExistException :: AsError a => Fold a ServiceError
- _EventDestinationAlreadyExistsException :: AsError a => Fold a ServiceError
- _EventDestinationDoesNotExistException :: AsError a => Fold a ServiceError
- _FromEmailAddressNotVerifiedException :: AsError a => Fold a ServiceError
- _InvalidCloudWatchDestinationException :: AsError a => Fold a ServiceError
- _InvalidConfigurationSetException :: AsError a => Fold a ServiceError
- _InvalidDeliveryOptionsException :: AsError a => Fold a ServiceError
- _InvalidFirehoseDestinationException :: AsError a => Fold a ServiceError
- _InvalidLambdaFunctionException :: AsError a => Fold a ServiceError
- _InvalidPolicyException :: AsError a => Fold a ServiceError
- _InvalidRenderingParameterException :: AsError a => Fold a ServiceError
- _InvalidS3ConfigurationException :: AsError a => Fold a ServiceError
- _InvalidSNSDestinationException :: AsError a => Fold a ServiceError
- _InvalidSnsTopicException :: AsError a => Fold a ServiceError
- _InvalidTemplateException :: AsError a => Fold a ServiceError
- _InvalidTrackingOptionsException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _MailFromDomainNotVerifiedException :: AsError a => Fold a ServiceError
- _MessageRejected :: AsError a => Fold a ServiceError
- _MissingRenderingAttributeException :: AsError a => Fold a ServiceError
- _ProductionAccessNotGrantedException :: AsError a => Fold a ServiceError
- _RuleDoesNotExistException :: AsError a => Fold a ServiceError
- _RuleSetDoesNotExistException :: AsError a => Fold a ServiceError
- _TemplateDoesNotExistException :: AsError a => Fold a ServiceError
- _TrackingOptionsAlreadyExistsException :: AsError a => Fold a ServiceError
- _TrackingOptionsDoesNotExistException :: AsError a => Fold a ServiceError
- newtype BehaviorOnMXFailure where
- newtype BounceType where
- BounceType' { }
- pattern BounceType_ContentRejected :: BounceType
- pattern BounceType_DoesNotExist :: BounceType
- pattern BounceType_ExceededQuota :: BounceType
- pattern BounceType_MessageTooLarge :: BounceType
- pattern BounceType_TemporaryFailure :: BounceType
- pattern BounceType_Undefined :: BounceType
- newtype BulkEmailStatus where
- BulkEmailStatus' { }
- pattern BulkEmailStatus_AccountDailyQuotaExceeded :: BulkEmailStatus
- pattern BulkEmailStatus_AccountSendingPaused :: BulkEmailStatus
- pattern BulkEmailStatus_AccountSuspended :: BulkEmailStatus
- pattern BulkEmailStatus_AccountThrottled :: BulkEmailStatus
- pattern BulkEmailStatus_ConfigurationSetDoesNotExist :: BulkEmailStatus
- pattern BulkEmailStatus_ConfigurationSetSendingPaused :: BulkEmailStatus
- pattern BulkEmailStatus_Failed :: BulkEmailStatus
- pattern BulkEmailStatus_InvalidParameterValue :: BulkEmailStatus
- pattern BulkEmailStatus_InvalidSendingPoolName :: BulkEmailStatus
- pattern BulkEmailStatus_MailFromDomainNotVerified :: BulkEmailStatus
- pattern BulkEmailStatus_MessageRejected :: BulkEmailStatus
- pattern BulkEmailStatus_Success :: BulkEmailStatus
- pattern BulkEmailStatus_TemplateDoesNotExist :: BulkEmailStatus
- pattern BulkEmailStatus_TransientFailure :: BulkEmailStatus
- newtype ConfigurationSetAttribute where
- ConfigurationSetAttribute' { }
- pattern ConfigurationSetAttribute_DeliveryOptions :: ConfigurationSetAttribute
- pattern ConfigurationSetAttribute_EventDestinations :: ConfigurationSetAttribute
- pattern ConfigurationSetAttribute_ReputationOptions :: ConfigurationSetAttribute
- pattern ConfigurationSetAttribute_TrackingOptions :: ConfigurationSetAttribute
- newtype CustomMailFromStatus where
- newtype DimensionValueSource where
- newtype DsnAction where
- DsnAction' { }
- pattern DsnAction_Delayed :: DsnAction
- pattern DsnAction_Delivered :: DsnAction
- pattern DsnAction_Expanded :: DsnAction
- pattern DsnAction_Failed :: DsnAction
- pattern DsnAction_Relayed :: DsnAction
- newtype EventType where
- EventType' { }
- pattern EventType_Bounce :: EventType
- pattern EventType_Click :: EventType
- pattern EventType_Complaint :: EventType
- pattern EventType_Delivery :: EventType
- pattern EventType_Open :: EventType
- pattern EventType_Reject :: EventType
- pattern EventType_RenderingFailure :: EventType
- pattern EventType_Send :: EventType
- newtype IdentityType where
- IdentityType' { }
- pattern IdentityType_Domain :: IdentityType
- pattern IdentityType_EmailAddress :: IdentityType
- newtype InvocationType where
- InvocationType' { }
- pattern InvocationType_Event :: InvocationType
- pattern InvocationType_RequestResponse :: InvocationType
- newtype NotificationType where
- NotificationType' { }
- pattern NotificationType_Bounce :: NotificationType
- pattern NotificationType_Complaint :: NotificationType
- pattern NotificationType_Delivery :: NotificationType
- newtype ReceiptFilterPolicy where
- newtype SNSActionEncoding where
- SNSActionEncoding' { }
- pattern SNSActionEncoding_Base64 :: SNSActionEncoding
- pattern SNSActionEncoding_UTF_8 :: SNSActionEncoding
- newtype StopScope where
- StopScope' { }
- pattern StopScope_RuleSet :: StopScope
- newtype TlsPolicy where
- TlsPolicy' { }
- pattern TlsPolicy_Optional :: TlsPolicy
- pattern TlsPolicy_Require :: TlsPolicy
- newtype VerificationStatus where
- VerificationStatus' { }
- pattern VerificationStatus_Failed :: VerificationStatus
- pattern VerificationStatus_NotStarted :: VerificationStatus
- pattern VerificationStatus_Pending :: VerificationStatus
- pattern VerificationStatus_Success :: VerificationStatus
- pattern VerificationStatus_TemporaryFailure :: VerificationStatus
- data AddHeaderAction = AddHeaderAction' {
- headerName :: Text
- headerValue :: Text
- newAddHeaderAction :: Text -> Text -> AddHeaderAction
- addHeaderAction_headerName :: Lens' AddHeaderAction Text
- addHeaderAction_headerValue :: Lens' AddHeaderAction Text
- data Body = Body' {}
- newBody :: Body
- body_html :: Lens' Body (Maybe Content)
- body_text :: Lens' Body (Maybe Content)
- data BounceAction = BounceAction' {}
- newBounceAction :: Text -> Text -> Text -> BounceAction
- bounceAction_statusCode :: Lens' BounceAction (Maybe Text)
- bounceAction_topicArn :: Lens' BounceAction (Maybe Text)
- bounceAction_smtpReplyCode :: Lens' BounceAction Text
- bounceAction_message :: Lens' BounceAction Text
- bounceAction_sender :: Lens' BounceAction Text
- data BouncedRecipientInfo = BouncedRecipientInfo' {}
- newBouncedRecipientInfo :: Text -> BouncedRecipientInfo
- bouncedRecipientInfo_bounceType :: Lens' BouncedRecipientInfo (Maybe BounceType)
- bouncedRecipientInfo_recipientArn :: Lens' BouncedRecipientInfo (Maybe Text)
- bouncedRecipientInfo_recipientDsnFields :: Lens' BouncedRecipientInfo (Maybe RecipientDsnFields)
- bouncedRecipientInfo_recipient :: Lens' BouncedRecipientInfo Text
- data BulkEmailDestination = BulkEmailDestination' {}
- newBulkEmailDestination :: Destination -> BulkEmailDestination
- bulkEmailDestination_replacementTags :: Lens' BulkEmailDestination (Maybe [MessageTag])
- bulkEmailDestination_replacementTemplateData :: Lens' BulkEmailDestination (Maybe Text)
- bulkEmailDestination_destination :: Lens' BulkEmailDestination Destination
- data BulkEmailDestinationStatus = BulkEmailDestinationStatus' {}
- newBulkEmailDestinationStatus :: BulkEmailDestinationStatus
- bulkEmailDestinationStatus_error :: Lens' BulkEmailDestinationStatus (Maybe Text)
- bulkEmailDestinationStatus_messageId :: Lens' BulkEmailDestinationStatus (Maybe Text)
- bulkEmailDestinationStatus_status :: Lens' BulkEmailDestinationStatus (Maybe BulkEmailStatus)
- data CloudWatchDestination = CloudWatchDestination' {}
- newCloudWatchDestination :: CloudWatchDestination
- cloudWatchDestination_dimensionConfigurations :: Lens' CloudWatchDestination [CloudWatchDimensionConfiguration]
- data CloudWatchDimensionConfiguration = CloudWatchDimensionConfiguration' {}
- newCloudWatchDimensionConfiguration :: Text -> DimensionValueSource -> Text -> CloudWatchDimensionConfiguration
- cloudWatchDimensionConfiguration_dimensionName :: Lens' CloudWatchDimensionConfiguration Text
- cloudWatchDimensionConfiguration_dimensionValueSource :: Lens' CloudWatchDimensionConfiguration DimensionValueSource
- cloudWatchDimensionConfiguration_defaultDimensionValue :: Lens' CloudWatchDimensionConfiguration Text
- data ConfigurationSet = ConfigurationSet' {}
- newConfigurationSet :: Text -> ConfigurationSet
- configurationSet_name :: Lens' ConfigurationSet Text
- data Content = Content' {}
- newContent :: Text -> Content
- content_charset :: Lens' Content (Maybe Text)
- content_data :: Lens' Content Text
- data CustomVerificationEmailTemplate = CustomVerificationEmailTemplate' {}
- newCustomVerificationEmailTemplate :: CustomVerificationEmailTemplate
- customVerificationEmailTemplate_failureRedirectionURL :: Lens' CustomVerificationEmailTemplate (Maybe Text)
- customVerificationEmailTemplate_fromEmailAddress :: Lens' CustomVerificationEmailTemplate (Maybe Text)
- customVerificationEmailTemplate_successRedirectionURL :: Lens' CustomVerificationEmailTemplate (Maybe Text)
- customVerificationEmailTemplate_templateName :: Lens' CustomVerificationEmailTemplate (Maybe Text)
- customVerificationEmailTemplate_templateSubject :: Lens' CustomVerificationEmailTemplate (Maybe Text)
- data DeliveryOptions = DeliveryOptions' {}
- newDeliveryOptions :: DeliveryOptions
- deliveryOptions_tlsPolicy :: Lens' DeliveryOptions (Maybe TlsPolicy)
- data Destination = Destination' {
- bccAddresses :: Maybe [Text]
- ccAddresses :: Maybe [Text]
- toAddresses :: Maybe [Text]
- newDestination :: Destination
- destination_bccAddresses :: Lens' Destination (Maybe [Text])
- destination_ccAddresses :: Lens' Destination (Maybe [Text])
- destination_toAddresses :: Lens' Destination (Maybe [Text])
- data EventDestination = EventDestination' {}
- newEventDestination :: Text -> EventDestination
- eventDestination_cloudWatchDestination :: Lens' EventDestination (Maybe CloudWatchDestination)
- eventDestination_enabled :: Lens' EventDestination (Maybe Bool)
- eventDestination_kinesisFirehoseDestination :: Lens' EventDestination (Maybe KinesisFirehoseDestination)
- eventDestination_sNSDestination :: Lens' EventDestination (Maybe SNSDestination)
- eventDestination_name :: Lens' EventDestination Text
- eventDestination_matchingEventTypes :: Lens' EventDestination [EventType]
- data ExtensionField = ExtensionField' {}
- newExtensionField :: Text -> Text -> ExtensionField
- extensionField_name :: Lens' ExtensionField Text
- extensionField_value :: Lens' ExtensionField Text
- data IdentityDkimAttributes = IdentityDkimAttributes' {}
- newIdentityDkimAttributes :: Bool -> VerificationStatus -> IdentityDkimAttributes
- identityDkimAttributes_dkimTokens :: Lens' IdentityDkimAttributes (Maybe [Text])
- identityDkimAttributes_dkimEnabled :: Lens' IdentityDkimAttributes Bool
- identityDkimAttributes_dkimVerificationStatus :: Lens' IdentityDkimAttributes VerificationStatus
- data IdentityMailFromDomainAttributes = IdentityMailFromDomainAttributes' {}
- newIdentityMailFromDomainAttributes :: Text -> CustomMailFromStatus -> BehaviorOnMXFailure -> IdentityMailFromDomainAttributes
- identityMailFromDomainAttributes_mailFromDomain :: Lens' IdentityMailFromDomainAttributes Text
- identityMailFromDomainAttributes_mailFromDomainStatus :: Lens' IdentityMailFromDomainAttributes CustomMailFromStatus
- identityMailFromDomainAttributes_behaviorOnMXFailure :: Lens' IdentityMailFromDomainAttributes BehaviorOnMXFailure
- data IdentityNotificationAttributes = IdentityNotificationAttributes' {}
- newIdentityNotificationAttributes :: Text -> Text -> Text -> Bool -> IdentityNotificationAttributes
- identityNotificationAttributes_headersInBounceNotificationsEnabled :: Lens' IdentityNotificationAttributes (Maybe Bool)
- identityNotificationAttributes_headersInComplaintNotificationsEnabled :: Lens' IdentityNotificationAttributes (Maybe Bool)
- identityNotificationAttributes_headersInDeliveryNotificationsEnabled :: Lens' IdentityNotificationAttributes (Maybe Bool)
- identityNotificationAttributes_bounceTopic :: Lens' IdentityNotificationAttributes Text
- identityNotificationAttributes_complaintTopic :: Lens' IdentityNotificationAttributes Text
- identityNotificationAttributes_deliveryTopic :: Lens' IdentityNotificationAttributes Text
- identityNotificationAttributes_forwardingEnabled :: Lens' IdentityNotificationAttributes Bool
- data IdentityVerificationAttributes = IdentityVerificationAttributes' {}
- newIdentityVerificationAttributes :: VerificationStatus -> IdentityVerificationAttributes
- identityVerificationAttributes_verificationToken :: Lens' IdentityVerificationAttributes (Maybe Text)
- identityVerificationAttributes_verificationStatus :: Lens' IdentityVerificationAttributes VerificationStatus
- data KinesisFirehoseDestination = KinesisFirehoseDestination' {}
- newKinesisFirehoseDestination :: Text -> Text -> KinesisFirehoseDestination
- kinesisFirehoseDestination_iAMRoleARN :: Lens' KinesisFirehoseDestination Text
- kinesisFirehoseDestination_deliveryStreamARN :: Lens' KinesisFirehoseDestination Text
- data LambdaAction = LambdaAction' {}
- newLambdaAction :: Text -> LambdaAction
- lambdaAction_invocationType :: Lens' LambdaAction (Maybe InvocationType)
- lambdaAction_topicArn :: Lens' LambdaAction (Maybe Text)
- lambdaAction_functionArn :: Lens' LambdaAction Text
- data Message = Message' {}
- newMessage :: Content -> Body -> Message
- message_subject :: Lens' Message Content
- message_body :: Lens' Message Body
- data MessageDsn = MessageDsn' {}
- newMessageDsn :: Text -> MessageDsn
- messageDsn_arrivalDate :: Lens' MessageDsn (Maybe UTCTime)
- messageDsn_extensionFields :: Lens' MessageDsn (Maybe [ExtensionField])
- messageDsn_reportingMta :: Lens' MessageDsn Text
- data MessageTag = MessageTag' {}
- newMessageTag :: Text -> Text -> MessageTag
- messageTag_name :: Lens' MessageTag Text
- messageTag_value :: Lens' MessageTag Text
- data RawMessage = RawMessage' {}
- newRawMessage :: ByteString -> RawMessage
- rawMessage_data :: Lens' RawMessage ByteString
- data ReceiptAction = ReceiptAction' {}
- newReceiptAction :: ReceiptAction
- receiptAction_addHeaderAction :: Lens' ReceiptAction (Maybe AddHeaderAction)
- receiptAction_bounceAction :: Lens' ReceiptAction (Maybe BounceAction)
- receiptAction_lambdaAction :: Lens' ReceiptAction (Maybe LambdaAction)
- receiptAction_s3Action :: Lens' ReceiptAction (Maybe S3Action)
- receiptAction_sNSAction :: Lens' ReceiptAction (Maybe SNSAction)
- receiptAction_stopAction :: Lens' ReceiptAction (Maybe StopAction)
- receiptAction_workmailAction :: Lens' ReceiptAction (Maybe WorkmailAction)
- data ReceiptFilter = ReceiptFilter' {
- name :: Text
- ipFilter :: ReceiptIpFilter
- newReceiptFilter :: Text -> ReceiptIpFilter -> ReceiptFilter
- receiptFilter_name :: Lens' ReceiptFilter Text
- receiptFilter_ipFilter :: Lens' ReceiptFilter ReceiptIpFilter
- data ReceiptIpFilter = ReceiptIpFilter' {}
- newReceiptIpFilter :: ReceiptFilterPolicy -> Text -> ReceiptIpFilter
- receiptIpFilter_policy :: Lens' ReceiptIpFilter ReceiptFilterPolicy
- receiptIpFilter_cidr :: Lens' ReceiptIpFilter Text
- data ReceiptRule = ReceiptRule' {}
- newReceiptRule :: Text -> ReceiptRule
- receiptRule_actions :: Lens' ReceiptRule (Maybe [ReceiptAction])
- receiptRule_enabled :: Lens' ReceiptRule (Maybe Bool)
- receiptRule_recipients :: Lens' ReceiptRule (Maybe [Text])
- receiptRule_scanEnabled :: Lens' ReceiptRule (Maybe Bool)
- receiptRule_tlsPolicy :: Lens' ReceiptRule (Maybe TlsPolicy)
- receiptRule_name :: Lens' ReceiptRule Text
- data ReceiptRuleSetMetadata = ReceiptRuleSetMetadata' {}
- newReceiptRuleSetMetadata :: ReceiptRuleSetMetadata
- receiptRuleSetMetadata_createdTimestamp :: Lens' ReceiptRuleSetMetadata (Maybe UTCTime)
- receiptRuleSetMetadata_name :: Lens' ReceiptRuleSetMetadata (Maybe Text)
- data RecipientDsnFields = RecipientDsnFields' {}
- newRecipientDsnFields :: DsnAction -> Text -> RecipientDsnFields
- recipientDsnFields_diagnosticCode :: Lens' RecipientDsnFields (Maybe Text)
- recipientDsnFields_extensionFields :: Lens' RecipientDsnFields (Maybe [ExtensionField])
- recipientDsnFields_finalRecipient :: Lens' RecipientDsnFields (Maybe Text)
- recipientDsnFields_lastAttemptDate :: Lens' RecipientDsnFields (Maybe UTCTime)
- recipientDsnFields_remoteMta :: Lens' RecipientDsnFields (Maybe Text)
- recipientDsnFields_action :: Lens' RecipientDsnFields DsnAction
- recipientDsnFields_status :: Lens' RecipientDsnFields Text
- data ReputationOptions = ReputationOptions' {}
- newReputationOptions :: ReputationOptions
- reputationOptions_lastFreshStart :: Lens' ReputationOptions (Maybe UTCTime)
- reputationOptions_reputationMetricsEnabled :: Lens' ReputationOptions (Maybe Bool)
- reputationOptions_sendingEnabled :: Lens' ReputationOptions (Maybe Bool)
- data S3Action = S3Action' {}
- newS3Action :: Text -> S3Action
- s3Action_kmsKeyArn :: Lens' S3Action (Maybe Text)
- s3Action_objectKeyPrefix :: Lens' S3Action (Maybe Text)
- s3Action_topicArn :: Lens' S3Action (Maybe Text)
- s3Action_bucketName :: Lens' S3Action Text
- data SNSAction = SNSAction' {}
- newSNSAction :: Text -> SNSAction
- sNSAction_encoding :: Lens' SNSAction (Maybe SNSActionEncoding)
- sNSAction_topicArn :: Lens' SNSAction Text
- data SNSDestination = SNSDestination' {}
- newSNSDestination :: Text -> SNSDestination
- sNSDestination_topicARN :: Lens' SNSDestination Text
- data SendDataPoint = SendDataPoint' {}
- newSendDataPoint :: SendDataPoint
- sendDataPoint_bounces :: Lens' SendDataPoint (Maybe Integer)
- sendDataPoint_complaints :: Lens' SendDataPoint (Maybe Integer)
- sendDataPoint_deliveryAttempts :: Lens' SendDataPoint (Maybe Integer)
- sendDataPoint_rejects :: Lens' SendDataPoint (Maybe Integer)
- sendDataPoint_timestamp :: Lens' SendDataPoint (Maybe UTCTime)
- data StopAction = StopAction' {}
- newStopAction :: StopScope -> StopAction
- stopAction_topicArn :: Lens' StopAction (Maybe Text)
- stopAction_scope :: Lens' StopAction StopScope
- data Template = Template' {}
- newTemplate :: Text -> Template
- template_htmlPart :: Lens' Template (Maybe Text)
- template_subjectPart :: Lens' Template (Maybe Text)
- template_textPart :: Lens' Template (Maybe Text)
- template_templateName :: Lens' Template Text
- data TemplateMetadata = TemplateMetadata' {}
- newTemplateMetadata :: TemplateMetadata
- templateMetadata_createdTimestamp :: Lens' TemplateMetadata (Maybe UTCTime)
- templateMetadata_name :: Lens' TemplateMetadata (Maybe Text)
- data TrackingOptions = TrackingOptions' {}
- newTrackingOptions :: TrackingOptions
- trackingOptions_customRedirectDomain :: Lens' TrackingOptions (Maybe Text)
- data WorkmailAction = WorkmailAction' {
- topicArn :: Maybe Text
- organizationArn :: Text
- newWorkmailAction :: Text -> WorkmailAction
- workmailAction_topicArn :: Lens' WorkmailAction (Maybe Text)
- workmailAction_organizationArn :: Lens' WorkmailAction Text
Service Configuration
defaultService :: Service Source #
API version 2010-12-01 of the Amazon Simple Email Service SDK configuration.
Errors
_AccountSendingPausedException :: AsError a => Fold a ServiceError Source #
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.
_AlreadyExistsException :: AsError a => Fold a ServiceError Source #
Indicates that a resource could not be created because of a naming conflict.
_CannotDeleteException :: AsError a => Fold a ServiceError Source #
Indicates that the delete operation could not be completed.
_ConfigurationSetAlreadyExistsException :: AsError a => Fold a ServiceError Source #
Indicates that the configuration set could not be created because of a naming conflict.
_ConfigurationSetDoesNotExistException :: AsError a => Fold a ServiceError Source #
Indicates that the configuration set does not exist.
_ConfigurationSetSendingPausedException :: AsError a => Fold a ServiceError Source #
Indicates that email sending is disabled for the configuration set.
You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.
_CustomVerificationEmailInvalidContentException :: AsError a => Fold a ServiceError Source #
Indicates that custom verification email template provided content is invalid.
_CustomVerificationEmailTemplateAlreadyExistsException :: AsError a => Fold a ServiceError Source #
Indicates that a custom verification email template with the name you specified already exists.
_CustomVerificationEmailTemplateDoesNotExistException :: AsError a => Fold a ServiceError Source #
Indicates that a custom verification email template with the name you specified does not exist.
_EventDestinationAlreadyExistsException :: AsError a => Fold a ServiceError Source #
Indicates that the event destination could not be created because of a naming conflict.
_EventDestinationDoesNotExistException :: AsError a => Fold a ServiceError Source #
Indicates that the event destination does not exist.
_FromEmailAddressNotVerifiedException :: AsError a => Fold a ServiceError Source #
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.
_InvalidCloudWatchDestinationException :: AsError a => Fold a ServiceError Source #
Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.
_InvalidConfigurationSetException :: AsError a => Fold a ServiceError Source #
Indicates that the configuration set is invalid. See the error message for details.
_InvalidDeliveryOptionsException :: AsError a => Fold a ServiceError Source #
Indicates that provided delivery option is invalid.
_InvalidFirehoseDestinationException :: AsError a => Fold a ServiceError Source #
Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.
_InvalidLambdaFunctionException :: AsError a => Fold a ServiceError Source #
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.
_InvalidPolicyException :: AsError a => Fold a ServiceError Source #
Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.
_InvalidRenderingParameterException :: AsError a => Fold a ServiceError Source #
Indicates that one or more of the replacement values you provided is invalid. This error may occur when the TemplateData object contains invalid JSON.
_InvalidS3ConfigurationException :: AsError a => Fold a ServiceError Source #
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.
_InvalidSNSDestinationException :: AsError a => Fold a ServiceError Source #
Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error message for details.
_InvalidSnsTopicException :: AsError a => Fold a ServiceError Source #
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.
_InvalidTemplateException :: AsError a => Fold a ServiceError Source #
Indicates that the template that you specified could not be rendered. This issue may occur when a template refers to a partial that does not exist.
_InvalidTrackingOptionsException :: AsError a => Fold a ServiceError Source #
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.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
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.
_MailFromDomainNotVerifiedException :: AsError a => Fold a ServiceError Source #
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.
_MessageRejected :: AsError a => Fold a ServiceError Source #
Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.
_MissingRenderingAttributeException :: AsError a => Fold a ServiceError Source #
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.
_ProductionAccessNotGrantedException :: AsError a => Fold a ServiceError Source #
Indicates that the account has not been granted production access.
_RuleDoesNotExistException :: AsError a => Fold a ServiceError Source #
Indicates that the provided receipt rule does not exist.
_RuleSetDoesNotExistException :: AsError a => Fold a ServiceError Source #
Indicates that the provided receipt rule set does not exist.
_TemplateDoesNotExistException :: AsError a => Fold a ServiceError Source #
Indicates that the Template object you specified does not exist in your Amazon SES account.
_TrackingOptionsAlreadyExistsException :: AsError a => Fold a ServiceError Source #
Indicates that the configuration set you specified already contains a TrackingOptions object.
_TrackingOptionsDoesNotExistException :: AsError a => Fold a ServiceError Source #
Indicates that the TrackingOptions object you specified does not exist.
BehaviorOnMXFailure
newtype BehaviorOnMXFailure Source #
Constructors
| BehaviorOnMXFailure' | |
Fields | |
Bundled Patterns
| pattern BehaviorOnMXFailure_RejectMessage :: BehaviorOnMXFailure | |
| pattern BehaviorOnMXFailure_UseDefaultValue :: BehaviorOnMXFailure |
Instances
BounceType
newtype BounceType Source #
Constructors
| BounceType' | |
Fields | |
Bundled Patterns
| pattern BounceType_ContentRejected :: BounceType | |
| pattern BounceType_DoesNotExist :: BounceType | |
| pattern BounceType_ExceededQuota :: BounceType | |
| pattern BounceType_MessageTooLarge :: BounceType | |
| pattern BounceType_TemporaryFailure :: BounceType | |
| pattern BounceType_Undefined :: BounceType |
Instances
BulkEmailStatus
newtype BulkEmailStatus Source #
Constructors
| BulkEmailStatus' | |
Fields | |
Bundled Patterns
| pattern BulkEmailStatus_AccountDailyQuotaExceeded :: BulkEmailStatus | |
| pattern BulkEmailStatus_AccountSendingPaused :: BulkEmailStatus | |
| pattern BulkEmailStatus_AccountSuspended :: BulkEmailStatus | |
| pattern BulkEmailStatus_AccountThrottled :: BulkEmailStatus | |
| pattern BulkEmailStatus_ConfigurationSetDoesNotExist :: BulkEmailStatus | |
| pattern BulkEmailStatus_ConfigurationSetSendingPaused :: BulkEmailStatus | |
| pattern BulkEmailStatus_Failed :: BulkEmailStatus | |
| pattern BulkEmailStatus_InvalidParameterValue :: BulkEmailStatus | |
| pattern BulkEmailStatus_InvalidSendingPoolName :: BulkEmailStatus | |
| pattern BulkEmailStatus_MailFromDomainNotVerified :: BulkEmailStatus | |
| pattern BulkEmailStatus_MessageRejected :: BulkEmailStatus | |
| pattern BulkEmailStatus_Success :: BulkEmailStatus | |
| pattern BulkEmailStatus_TemplateDoesNotExist :: BulkEmailStatus | |
| pattern BulkEmailStatus_TransientFailure :: BulkEmailStatus |
Instances
ConfigurationSetAttribute
newtype ConfigurationSetAttribute Source #
Constructors
| ConfigurationSetAttribute' | |
Fields | |
Bundled Patterns
Instances
CustomMailFromStatus
newtype CustomMailFromStatus Source #
Constructors
| CustomMailFromStatus' | |
Fields | |
Bundled Patterns
| pattern CustomMailFromStatus_Failed :: CustomMailFromStatus | |
| pattern CustomMailFromStatus_Pending :: CustomMailFromStatus | |
| pattern CustomMailFromStatus_Success :: CustomMailFromStatus | |
| pattern CustomMailFromStatus_TemporaryFailure :: CustomMailFromStatus |
Instances
DimensionValueSource
newtype DimensionValueSource Source #
Constructors
| DimensionValueSource' | |
Fields | |
Bundled Patterns
| pattern DimensionValueSource_EmailHeader :: DimensionValueSource | |
| pattern DimensionValueSource_LinkTag :: DimensionValueSource | |
| pattern DimensionValueSource_MessageTag :: DimensionValueSource |
Instances
DsnAction
Constructors
| DsnAction' | |
Fields | |
Bundled Patterns
| pattern DsnAction_Delayed :: DsnAction | |
| pattern DsnAction_Delivered :: DsnAction | |
| pattern DsnAction_Expanded :: DsnAction | |
| pattern DsnAction_Failed :: DsnAction | |
| pattern DsnAction_Relayed :: DsnAction |
Instances
EventType
Constructors
| EventType' | |
Fields | |
Bundled Patterns
| pattern EventType_Bounce :: EventType | |
| pattern EventType_Click :: EventType | |
| pattern EventType_Complaint :: EventType | |
| pattern EventType_Delivery :: EventType | |
| pattern EventType_Open :: EventType | |
| pattern EventType_Reject :: EventType | |
| pattern EventType_RenderingFailure :: EventType | |
| pattern EventType_Send :: EventType |
Instances
IdentityType
newtype IdentityType Source #
Constructors
| IdentityType' | |
Fields | |
Bundled Patterns
| pattern IdentityType_Domain :: IdentityType | |
| pattern IdentityType_EmailAddress :: IdentityType |
Instances
InvocationType
newtype InvocationType Source #
Constructors
| InvocationType' | |
Fields | |
Bundled Patterns
| pattern InvocationType_Event :: InvocationType | |
| pattern InvocationType_RequestResponse :: InvocationType |
Instances
NotificationType
newtype NotificationType Source #
Constructors
| NotificationType' | |
Fields | |
Bundled Patterns
| pattern NotificationType_Bounce :: NotificationType | |
| pattern NotificationType_Complaint :: NotificationType | |
| pattern NotificationType_Delivery :: NotificationType |
Instances
ReceiptFilterPolicy
newtype ReceiptFilterPolicy Source #
Constructors
| ReceiptFilterPolicy' | |
Fields | |
Bundled Patterns
| pattern ReceiptFilterPolicy_Allow :: ReceiptFilterPolicy | |
| pattern ReceiptFilterPolicy_Block :: ReceiptFilterPolicy |
Instances
SNSActionEncoding
newtype SNSActionEncoding Source #
Constructors
| SNSActionEncoding' | |
Fields | |
Bundled Patterns
| pattern SNSActionEncoding_Base64 :: SNSActionEncoding | |
| pattern SNSActionEncoding_UTF_8 :: SNSActionEncoding |
Instances
StopScope
Constructors
| StopScope' | |
Fields | |
Bundled Patterns
| pattern StopScope_RuleSet :: StopScope |
Instances
TlsPolicy
Constructors
| TlsPolicy' | |
Fields | |
Bundled Patterns
| pattern TlsPolicy_Optional :: TlsPolicy | |
| pattern TlsPolicy_Require :: TlsPolicy |
Instances
VerificationStatus
newtype VerificationStatus Source #
Constructors
| VerificationStatus' | |
Fields | |
Bundled Patterns
| pattern VerificationStatus_Failed :: VerificationStatus | |
| pattern VerificationStatus_NotStarted :: VerificationStatus | |
| pattern VerificationStatus_Pending :: VerificationStatus | |
| pattern VerificationStatus_Success :: VerificationStatus | |
| pattern VerificationStatus_TemporaryFailure :: VerificationStatus |
Instances
AddHeaderAction
data AddHeaderAction Source #
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: newAddHeaderAction smart constructor.
Constructors
| AddHeaderAction' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AddHeaderAction |
Create a value of AddHeaderAction with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:headerName:AddHeaderAction', addHeaderAction_headerName - 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.
$sel:headerValue:AddHeaderAction', addHeaderAction_headerValue - Must be less than 2048 characters, and must not contain newline
characters ("\r" or "\n").
addHeaderAction_headerName :: Lens' AddHeaderAction Text Source #
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.
addHeaderAction_headerValue :: Lens' AddHeaderAction Text Source #
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: newBody smart constructor.
Constructors
| Body' | |
Fields
| |
Instances
| ToQuery Body Source # | |
Defined in Amazonka.SES.Types.Body Methods toQuery :: Body -> QueryString # | |
| Generic Body Source # | |
| Read Body Source # | |
| Show Body Source # | |
| NFData Body Source # | |
Defined in Amazonka.SES.Types.Body | |
| Eq Body Source # | |
| Hashable Body Source # | |
Defined in Amazonka.SES.Types.Body | |
| type Rep Body Source # | |
Defined in Amazonka.SES.Types.Body type Rep Body = D1 ('MetaData "Body" "Amazonka.SES.Types.Body" "amazonka-ses-2.0-Gc6VkOIX7Sd2eunWehphuf" 'False) (C1 ('MetaCons "Body'" 'PrefixI 'True) (S1 ('MetaSel ('Just "html") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Content)) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Content)))) | |
Create a value of Body with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:html:Body', body_html - 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.
$sel:text:Body', body_text - 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).
body_html :: Lens' Body (Maybe Content) Source #
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.
body_text :: Lens' Body (Maybe Content) Source #
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).
BounceAction
data BounceAction Source #
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: newBounceAction smart constructor.
Constructors
| BounceAction' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> BounceAction |
Create a value of BounceAction with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:statusCode:BounceAction', bounceAction_statusCode - The SMTP enhanced status code, as defined by
RFC 3463.
$sel:topicArn:BounceAction', bounceAction_topicArn - 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.
$sel:smtpReplyCode:BounceAction', bounceAction_smtpReplyCode - The SMTP reply code, as defined by
RFC 5321.
$sel:message:BounceAction', bounceAction_message - Human-readable text to include in the bounce message.
$sel:sender:BounceAction', bounceAction_sender - The email address of the sender of the bounced email. This is the
address from which the bounce message will be sent.
bounceAction_statusCode :: Lens' BounceAction (Maybe Text) Source #
The SMTP enhanced status code, as defined by RFC 3463.
bounceAction_topicArn :: Lens' BounceAction (Maybe Text) Source #
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.
bounceAction_smtpReplyCode :: Lens' BounceAction Text Source #
The SMTP reply code, as defined by RFC 5321.
bounceAction_message :: Lens' BounceAction Text Source #
Human-readable text to include in the bounce message.
bounceAction_sender :: Lens' BounceAction Text Source #
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 Source #
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: newBouncedRecipientInfo smart constructor.
Constructors
| BouncedRecipientInfo' | |
Fields
| |
Instances
newBouncedRecipientInfo Source #
Arguments
| :: Text | |
| -> BouncedRecipientInfo |
Create a value of BouncedRecipientInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bounceType:BouncedRecipientInfo', bouncedRecipientInfo_bounceType - The reason for the bounce. You must provide either this parameter or
RecipientDsnFields.
$sel:recipientArn:BouncedRecipientInfo', bouncedRecipientInfo_recipientArn - 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.
$sel:recipientDsnFields:BouncedRecipientInfo', bouncedRecipientInfo_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.
$sel:recipient:BouncedRecipientInfo', bouncedRecipientInfo_recipient - The email address of the recipient of the bounced email.
bouncedRecipientInfo_bounceType :: Lens' BouncedRecipientInfo (Maybe BounceType) Source #
The reason for the bounce. You must provide either this parameter or
RecipientDsnFields.
bouncedRecipientInfo_recipientArn :: Lens' BouncedRecipientInfo (Maybe Text) Source #
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.
bouncedRecipientInfo_recipientDsnFields :: Lens' BouncedRecipientInfo (Maybe RecipientDsnFields) Source #
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.
bouncedRecipientInfo_recipient :: Lens' BouncedRecipientInfo Text Source #
The email address of the recipient of the bounced email.
BulkEmailDestination
data BulkEmailDestination Source #
An array that contains one or more Destinations, as well as the tags and replacement data associated with each of those Destinations.
See: newBulkEmailDestination smart constructor.
Constructors
| BulkEmailDestination' | |
Fields
| |
Instances
newBulkEmailDestination Source #
Create a value of BulkEmailDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:replacementTags:BulkEmailDestination', bulkEmailDestination_replacementTags - 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.
$sel:replacementTemplateData:BulkEmailDestination', bulkEmailDestination_replacementTemplateData - A list of replacement values to apply to the template. This parameter is
a JSON object, typically consisting of key-value pairs in which the keys
correspond to replacement tags in the email template.
$sel:destination:BulkEmailDestination', bulkEmailDestination_destination - Undocumented member.
bulkEmailDestination_replacementTags :: Lens' BulkEmailDestination (Maybe [MessageTag]) Source #
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.
bulkEmailDestination_replacementTemplateData :: Lens' BulkEmailDestination (Maybe Text) Source #
A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
bulkEmailDestination_destination :: Lens' BulkEmailDestination Destination Source #
Undocumented member.
BulkEmailDestinationStatus
data BulkEmailDestinationStatus Source #
An object that contains the response from the SendBulkTemplatedEmail
operation.
See: newBulkEmailDestinationStatus smart constructor.
Constructors
| BulkEmailDestinationStatus' | |
Fields
| |
Instances
newBulkEmailDestinationStatus :: BulkEmailDestinationStatus Source #
Create a value of BulkEmailDestinationStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:error:BulkEmailDestinationStatus', bulkEmailDestinationStatus_error - A description of an error that prevented a message being sent using the
SendBulkTemplatedEmail operation.
$sel:messageId:BulkEmailDestinationStatus', bulkEmailDestinationStatus_messageId - The unique message identifier returned from the SendBulkTemplatedEmail
operation.
$sel:status:BulkEmailDestinationStatus', bulkEmailDestinationStatus_status - The status of a message sent using the SendBulkTemplatedEmail
operation.
Possible values for this parameter include:
Success: Amazon SES accepted the message, and will attempt to deliver it to the recipients.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.
bulkEmailDestinationStatus_error :: Lens' BulkEmailDestinationStatus (Maybe Text) Source #
A description of an error that prevented a message being sent using the
SendBulkTemplatedEmail operation.
bulkEmailDestinationStatus_messageId :: Lens' BulkEmailDestinationStatus (Maybe Text) Source #
The unique message identifier returned from the SendBulkTemplatedEmail
operation.
bulkEmailDestinationStatus_status :: Lens' BulkEmailDestinationStatus (Maybe BulkEmailStatus) Source #
The status of a message sent using the SendBulkTemplatedEmail
operation.
Possible values for this parameter include:
Success: Amazon SES accepted the message, and will attempt to deliver it to the recipients.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.
CloudWatchDestination
data CloudWatchDestination Source #
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: newCloudWatchDestination smart constructor.
Constructors
| CloudWatchDestination' | |
Fields
| |
Instances
newCloudWatchDestination :: CloudWatchDestination Source #
Create a value of CloudWatchDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensionConfigurations:CloudWatchDestination', cloudWatchDestination_dimensionConfigurations - A list of dimensions upon which to categorize your emails when you
publish email sending events to Amazon CloudWatch.
cloudWatchDestination_dimensionConfigurations :: Lens' CloudWatchDestination [CloudWatchDimensionConfiguration] Source #
A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.
CloudWatchDimensionConfiguration
data CloudWatchDimensionConfiguration Source #
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: newCloudWatchDimensionConfiguration smart constructor.
Constructors
| CloudWatchDimensionConfiguration' | |
Fields
| |
Instances
newCloudWatchDimensionConfiguration Source #
Arguments
| :: Text | |
| -> DimensionValueSource | |
| -> Text |
|
| -> CloudWatchDimensionConfiguration |
Create a value of CloudWatchDimensionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensionName:CloudWatchDimensionConfiguration', cloudWatchDimensionConfiguration_dimensionName - The name of an Amazon CloudWatch dimension associated with an email
sending metric. The name must:
- This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
- Contain less than 256 characters.
$sel:dimensionValueSource:CloudWatchDimensionConfiguration', 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.
$sel:defaultDimensionValue:CloudWatchDimensionConfiguration', cloudWatchDimensionConfiguration_defaultDimensionValue - 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.
cloudWatchDimensionConfiguration_dimensionName :: Lens' CloudWatchDimensionConfiguration Text Source #
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.
cloudWatchDimensionConfiguration_dimensionValueSource :: Lens' CloudWatchDimensionConfiguration DimensionValueSource Source #
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.
cloudWatchDimensionConfiguration_defaultDimensionValue :: Lens' CloudWatchDimensionConfiguration Text Source #
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 Source #
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: newConfigurationSet smart constructor.
Constructors
| ConfigurationSet' | |
Instances
Arguments
| :: Text | |
| -> ConfigurationSet |
Create a value of ConfigurationSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:ConfigurationSet', configurationSet_name - 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.
configurationSet_name :: Lens' ConfigurationSet Text Source #
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: newContent smart constructor.
Constructors
| Content' | |
Instances
| ToQuery Content Source # | |
Defined in Amazonka.SES.Types.Content Methods toQuery :: Content -> QueryString # | |
| Generic Content Source # | |
| Read Content Source # | |
| Show Content Source # | |
| NFData Content Source # | |
Defined in Amazonka.SES.Types.Content | |
| Eq Content Source # | |
| Hashable Content Source # | |
Defined in Amazonka.SES.Types.Content | |
| type Rep Content Source # | |
Defined in Amazonka.SES.Types.Content type Rep Content = D1 ('MetaData "Content" "Amazonka.SES.Types.Content" "amazonka-ses-2.0-Gc6VkOIX7Sd2eunWehphuf" 'False) (C1 ('MetaCons "Content'" 'PrefixI 'True) (S1 ('MetaSel ('Just "charset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Content with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:charset:Content', content_charset - The character set of the content.
$sel:data':Content', content_data - The textual data of the content.
CustomVerificationEmailTemplate
data CustomVerificationEmailTemplate Source #
Contains information about a custom verification email template.
See: newCustomVerificationEmailTemplate smart constructor.
Constructors
| CustomVerificationEmailTemplate' | |
Fields
| |
Instances
newCustomVerificationEmailTemplate :: CustomVerificationEmailTemplate Source #
Create a value of CustomVerificationEmailTemplate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureRedirectionURL:CustomVerificationEmailTemplate', customVerificationEmailTemplate_failureRedirectionURL - The URL that the recipient of the verification email is sent to if his
or her address is not successfully verified.
$sel:fromEmailAddress:CustomVerificationEmailTemplate', customVerificationEmailTemplate_fromEmailAddress - The email address that the custom verification email is sent from.
$sel:successRedirectionURL:CustomVerificationEmailTemplate', customVerificationEmailTemplate_successRedirectionURL - The URL that the recipient of the verification email is sent to if his
or her address is successfully verified.
$sel:templateName:CustomVerificationEmailTemplate', customVerificationEmailTemplate_templateName - The name of the custom verification email template.
$sel:templateSubject:CustomVerificationEmailTemplate', customVerificationEmailTemplate_templateSubject - The subject line of the custom verification email.
customVerificationEmailTemplate_failureRedirectionURL :: Lens' CustomVerificationEmailTemplate (Maybe Text) Source #
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
customVerificationEmailTemplate_fromEmailAddress :: Lens' CustomVerificationEmailTemplate (Maybe Text) Source #
The email address that the custom verification email is sent from.
customVerificationEmailTemplate_successRedirectionURL :: Lens' CustomVerificationEmailTemplate (Maybe Text) Source #
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
customVerificationEmailTemplate_templateName :: Lens' CustomVerificationEmailTemplate (Maybe Text) Source #
The name of the custom verification email template.
customVerificationEmailTemplate_templateSubject :: Lens' CustomVerificationEmailTemplate (Maybe Text) Source #
The subject line of the custom verification email.
DeliveryOptions
data DeliveryOptions Source #
Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
See: newDeliveryOptions smart constructor.
Constructors
| DeliveryOptions' | |
Fields
| |
Instances
newDeliveryOptions :: DeliveryOptions Source #
Create a value of DeliveryOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tlsPolicy:DeliveryOptions', deliveryOptions_tlsPolicy - Specifies whether messages that use the configuration set are required
to use Transport Layer Security (TLS). If the value is Require,
messages are only delivered if a TLS connection can be established. If
the value is Optional, messages can be delivered in plain text if a
TLS connection can't be established.
deliveryOptions_tlsPolicy :: Lens' DeliveryOptions (Maybe TlsPolicy) Source #
Specifies whether messages that use the configuration set are required
to use Transport Layer Security (TLS). If the value is Require,
messages are only delivered if a TLS connection can be established. If
the value is Optional, messages can be delivered in plain text if a
TLS connection can't be established.
Destination
data Destination Source #
Represents the destination of the message, consisting of To:, CC:, and BCC: fields.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.
See: newDestination smart constructor.
Constructors
| Destination' | |
Fields
| |
Instances
newDestination :: Destination Source #
Create a value of Destination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bccAddresses:Destination', destination_bccAddresses - The recipients to place on the BCC: line of the message.
$sel:ccAddresses:Destination', destination_ccAddresses - The recipients to place on the CC: line of the message.
$sel:toAddresses:Destination', destination_toAddresses - The recipients to place on the To: line of the message.
destination_bccAddresses :: Lens' Destination (Maybe [Text]) Source #
The recipients to place on the BCC: line of the message.
destination_ccAddresses :: Lens' Destination (Maybe [Text]) Source #
The recipients to place on the CC: line of the message.
destination_toAddresses :: Lens' Destination (Maybe [Text]) Source #
The recipients to place on the To: line of the message.
EventDestination
data EventDestination Source #
Contains information about the event destination that the specified email sending events will be published to.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).
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: newEventDestination smart constructor.
Constructors
| EventDestination' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> EventDestination |
Create a value of EventDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cloudWatchDestination:EventDestination', eventDestination_cloudWatchDestination - An object that contains the names, default values, and sources of the
dimensions associated with an Amazon CloudWatch event destination.
$sel:enabled:EventDestination', eventDestination_enabled - 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.
$sel:kinesisFirehoseDestination:EventDestination', eventDestination_kinesisFirehoseDestination - An object that contains the delivery stream ARN and the IAM role ARN
associated with an Amazon Kinesis Firehose event destination.
$sel:sNSDestination:EventDestination', eventDestination_sNSDestination - An object that contains the topic ARN associated with an Amazon Simple
Notification Service (Amazon SNS) event destination.
$sel:name:EventDestination', eventDestination_name - 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.
$sel:matchingEventTypes:EventDestination', eventDestination_matchingEventTypes - The type of email sending events to publish to the event destination.
eventDestination_cloudWatchDestination :: Lens' EventDestination (Maybe CloudWatchDestination) Source #
An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
eventDestination_enabled :: Lens' EventDestination (Maybe Bool) Source #
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.
eventDestination_kinesisFirehoseDestination :: Lens' EventDestination (Maybe KinesisFirehoseDestination) Source #
An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
eventDestination_sNSDestination :: Lens' EventDestination (Maybe SNSDestination) Source #
An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
eventDestination_name :: Lens' EventDestination Text Source #
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.
eventDestination_matchingEventTypes :: Lens' EventDestination [EventType] Source #
The type of email sending events to publish to the event destination.
ExtensionField
data ExtensionField Source #
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: newExtensionField smart constructor.
Constructors
| ExtensionField' | |
Fields | |
Instances
Create a value of ExtensionField with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:ExtensionField', extensionField_name - 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.
$sel:value:ExtensionField', extensionField_value - The value of the header to add. Must be less than 2048 characters, and
must not contain newline characters ("\r" or "\n").
extensionField_name :: Lens' ExtensionField Text Source #
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.
extensionField_value :: Lens' ExtensionField Text Source #
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 Source #
Represents the DKIM attributes of a verified email address or a domain.
See: newIdentityDkimAttributes smart constructor.
Constructors
| IdentityDkimAttributes' | |
Fields
| |
Instances
newIdentityDkimAttributes Source #
Arguments
| :: Bool | |
| -> VerificationStatus | |
| -> IdentityDkimAttributes |
Create a value of IdentityDkimAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dkimTokens:IdentityDkimAttributes', identityDkimAttributes_dkimTokens - A set of character strings that represent the domain's identity. Using
these tokens, you need to create DNS CNAME records that point to DKIM
public keys that are hosted by Amazon SES. Amazon Web Services
eventually detects that you've updated your DNS records. This detection
process might take up to 72 hours. After successful detection, Amazon
SES is 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, see the Amazon SES Developer Guide.
$sel:dkimEnabled:IdentityDkimAttributes', identityDkimAttributes_dkimEnabled - Is true if DKIM signing is enabled for email sent from the identity.
It's false otherwise. The default value is true.
$sel:dkimVerificationStatus:IdentityDkimAttributes', identityDkimAttributes_dkimVerificationStatus - 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.)
identityDkimAttributes_dkimTokens :: Lens' IdentityDkimAttributes (Maybe [Text]) Source #
A set of character strings that represent the domain's identity. Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is 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, see the Amazon SES Developer Guide.
identityDkimAttributes_dkimEnabled :: Lens' IdentityDkimAttributes Bool Source #
Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default value is true.
identityDkimAttributes_dkimVerificationStatus :: Lens' IdentityDkimAttributes VerificationStatus Source #
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 Source #
Represents the custom MAIL FROM domain attributes of a verified identity (email address or domain).
See: newIdentityMailFromDomainAttributes smart constructor.
Constructors
| IdentityMailFromDomainAttributes' | |
Fields
| |
Instances
newIdentityMailFromDomainAttributes Source #
Arguments
| :: Text | |
| -> CustomMailFromStatus | |
| -> BehaviorOnMXFailure | |
| -> IdentityMailFromDomainAttributes |
Create a value of IdentityMailFromDomainAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mailFromDomain:IdentityMailFromDomainAttributes', identityMailFromDomainAttributes_mailFromDomain - The custom MAIL FROM domain that the identity is configured to use.
$sel:mailFromDomainStatus:IdentityMailFromDomainAttributes', identityMailFromDomainAttributes_mailFromDomainStatus - 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.
$sel:behaviorOnMXFailure:IdentityMailFromDomainAttributes', 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.
identityMailFromDomainAttributes_mailFromDomain :: Lens' IdentityMailFromDomainAttributes Text Source #
The custom MAIL FROM domain that the identity is configured to use.
identityMailFromDomainAttributes_mailFromDomainStatus :: Lens' IdentityMailFromDomainAttributes CustomMailFromStatus Source #
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.
identityMailFromDomainAttributes_behaviorOnMXFailure :: Lens' IdentityMailFromDomainAttributes BehaviorOnMXFailure Source #
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 Source #
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: newIdentityNotificationAttributes smart constructor.
Constructors
| IdentityNotificationAttributes' | |
Fields
| |
Instances
newIdentityNotificationAttributes Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Bool | |
| -> IdentityNotificationAttributes |
Create a value of IdentityNotificationAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:headersInBounceNotificationsEnabled:IdentityNotificationAttributes', identityNotificationAttributes_headersInBounceNotificationsEnabled - 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.
$sel:headersInComplaintNotificationsEnabled:IdentityNotificationAttributes', identityNotificationAttributes_headersInComplaintNotificationsEnabled - 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.
$sel:headersInDeliveryNotificationsEnabled:IdentityNotificationAttributes', identityNotificationAttributes_headersInDeliveryNotificationsEnabled - 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.
$sel:bounceTopic:IdentityNotificationAttributes', identityNotificationAttributes_bounceTopic - The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES
will publish bounce notifications.
$sel:complaintTopic:IdentityNotificationAttributes', identityNotificationAttributes_complaintTopic - The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES
will publish complaint notifications.
$sel:deliveryTopic:IdentityNotificationAttributes', identityNotificationAttributes_deliveryTopic - The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES
will publish delivery notifications.
$sel:forwardingEnabled:IdentityNotificationAttributes', identityNotificationAttributes_forwardingEnabled - 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.
identityNotificationAttributes_headersInBounceNotificationsEnabled :: Lens' IdentityNotificationAttributes (Maybe Bool) Source #
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.
identityNotificationAttributes_headersInComplaintNotificationsEnabled :: Lens' IdentityNotificationAttributes (Maybe Bool) Source #
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.
identityNotificationAttributes_headersInDeliveryNotificationsEnabled :: Lens' IdentityNotificationAttributes (Maybe Bool) Source #
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.
identityNotificationAttributes_bounceTopic :: Lens' IdentityNotificationAttributes Text Source #
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.
identityNotificationAttributes_complaintTopic :: Lens' IdentityNotificationAttributes Text Source #
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.
identityNotificationAttributes_deliveryTopic :: Lens' IdentityNotificationAttributes Text Source #
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.
identityNotificationAttributes_forwardingEnabled :: Lens' IdentityNotificationAttributes Bool Source #
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 Source #
Represents the verification attributes of a single identity.
See: newIdentityVerificationAttributes smart constructor.
Constructors
| IdentityVerificationAttributes' | |
Fields
| |
Instances
newIdentityVerificationAttributes Source #
Arguments
| :: VerificationStatus | |
| -> IdentityVerificationAttributes |
Create a value of IdentityVerificationAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:verificationToken:IdentityVerificationAttributes', identityVerificationAttributes_verificationToken - The verification token for a domain identity. Null for email address
identities.
$sel:verificationStatus:IdentityVerificationAttributes', identityVerificationAttributes_verificationStatus - The verification status of the identity: "Pending", "Success",
"Failed", or "TemporaryFailure".
identityVerificationAttributes_verificationToken :: Lens' IdentityVerificationAttributes (Maybe Text) Source #
The verification token for a domain identity. Null for email address identities.
identityVerificationAttributes_verificationStatus :: Lens' IdentityVerificationAttributes VerificationStatus Source #
The verification status of the identity: "Pending", "Success", "Failed", or "TemporaryFailure".
KinesisFirehoseDestination
data KinesisFirehoseDestination Source #
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: newKinesisFirehoseDestination smart constructor.
Constructors
| KinesisFirehoseDestination' | |
Fields
| |
Instances
newKinesisFirehoseDestination Source #
Arguments
| :: Text | |
| -> Text | |
| -> KinesisFirehoseDestination |
Create a value of KinesisFirehoseDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iAMRoleARN:KinesisFirehoseDestination', kinesisFirehoseDestination_iAMRoleARN - The ARN of the IAM role under which Amazon SES publishes email sending
events to the Amazon Kinesis Firehose stream.
$sel:deliveryStreamARN:KinesisFirehoseDestination', kinesisFirehoseDestination_deliveryStreamARN - The ARN of the Amazon Kinesis Firehose stream that email sending events
should be published to.
kinesisFirehoseDestination_iAMRoleARN :: Lens' KinesisFirehoseDestination Text Source #
The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.
kinesisFirehoseDestination_deliveryStreamARN :: Lens' KinesisFirehoseDestination Text Source #
The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.
LambdaAction
data LambdaAction Source #
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: newLambdaAction smart constructor.
Constructors
| LambdaAction' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> LambdaAction |
Create a value of LambdaAction with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:invocationType:LambdaAction', lambdaAction_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.
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.
$sel:topicArn:LambdaAction', lambdaAction_topicArn - 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.
$sel:functionArn:LambdaAction', lambdaAction_functionArn - 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.
lambdaAction_invocationType :: Lens' LambdaAction (Maybe InvocationType) Source #
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.
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.
lambdaAction_topicArn :: Lens' LambdaAction (Maybe Text) Source #
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.
lambdaAction_functionArn :: Lens' LambdaAction Text Source #
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: newMessage smart constructor.
Constructors
| Message' | |
Instances
| ToQuery Message Source # | |
Defined in Amazonka.SES.Types.Message Methods toQuery :: Message -> QueryString # | |
| Generic Message Source # | |
| Read Message Source # | |
| Show Message Source # | |
| NFData Message Source # | |
Defined in Amazonka.SES.Types.Message | |
| Eq Message Source # | |
| Hashable Message Source # | |
Defined in Amazonka.SES.Types.Message | |
| type Rep Message Source # | |
Defined in Amazonka.SES.Types.Message type Rep Message = D1 ('MetaData "Message" "Amazonka.SES.Types.Message" "amazonka-ses-2.0-Gc6VkOIX7Sd2eunWehphuf" 'False) (C1 ('MetaCons "Message'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Content) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body))) | |
Create a value of Message with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subject:Message', message_subject - The subject of the message: A short summary of the content, which will
appear in the recipient's inbox.
$sel:body:Message', message_body - The message body.
message_subject :: Lens' Message Content Source #
The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
MessageDsn
data MessageDsn Source #
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: newMessageDsn smart constructor.
Constructors
| MessageDsn' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> MessageDsn |
Create a value of MessageDsn with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arrivalDate:MessageDsn', messageDsn_arrivalDate - When the message was received by the reporting mail transfer agent
(MTA), in RFC 822 date-time
format.
$sel:extensionFields:MessageDsn', messageDsn_extensionFields - Additional X-headers to include in the DSN.
$sel:reportingMta:MessageDsn', messageDsn_reportingMta - 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.
messageDsn_arrivalDate :: Lens' MessageDsn (Maybe UTCTime) Source #
When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.
messageDsn_extensionFields :: Lens' MessageDsn (Maybe [ExtensionField]) Source #
Additional X-headers to include in the DSN.
messageDsn_reportingMta :: Lens' MessageDsn Text Source #
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 Source #
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: newMessageTag smart constructor.
Constructors
| MessageTag' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> MessageTag |
Create a value of MessageTag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:MessageTag', messageTag_name - The name of the 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.
$sel:value:MessageTag', messageTag_value - 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.
messageTag_name :: Lens' MessageTag Text Source #
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.
messageTag_value :: Lens' MessageTag Text Source #
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 Source #
Represents the raw data of the message.
See: newRawMessage smart constructor.
Constructors
| RawMessage' | |
Fields
| |
Instances
Arguments
| :: ByteString | |
| -> RawMessage |
Create a value of RawMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:data':RawMessage', rawMessage_data - The raw 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.
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.
rawMessage_data :: Lens' RawMessage ByteString Source #
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.
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 Source #
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: newReceiptAction smart constructor.
Constructors
| ReceiptAction' | |
Fields
| |
Instances
newReceiptAction :: ReceiptAction Source #
Create a value of ReceiptAction with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:addHeaderAction:ReceiptAction', receiptAction_addHeaderAction - Adds a header to the received email.
$sel:bounceAction:ReceiptAction', receiptAction_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).
$sel:lambdaAction:ReceiptAction', receiptAction_lambdaAction - Calls an AWS Lambda function, and optionally, publishes a notification
to Amazon SNS.
$sel:s3Action:ReceiptAction', receiptAction_s3Action - Saves the received message to an Amazon Simple Storage Service (Amazon
S3) bucket and, optionally, publishes a notification to Amazon SNS.
$sel:sNSAction:ReceiptAction', receiptAction_sNSAction - Publishes the email content within a notification to Amazon SNS.
$sel:stopAction:ReceiptAction', receiptAction_stopAction - Terminates the evaluation of the receipt rule set and optionally
publishes a notification to Amazon SNS.
$sel:workmailAction:ReceiptAction', receiptAction_workmailAction - Calls Amazon WorkMail and, optionally, publishes a notification to
Amazon Amazon SNS.
receiptAction_addHeaderAction :: Lens' ReceiptAction (Maybe AddHeaderAction) Source #
Adds a header to the received email.
receiptAction_bounceAction :: Lens' ReceiptAction (Maybe BounceAction) Source #
Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
receiptAction_lambdaAction :: Lens' ReceiptAction (Maybe LambdaAction) Source #
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
receiptAction_s3Action :: Lens' ReceiptAction (Maybe S3Action) Source #
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
receiptAction_sNSAction :: Lens' ReceiptAction (Maybe SNSAction) Source #
Publishes the email content within a notification to Amazon SNS.
receiptAction_stopAction :: Lens' ReceiptAction (Maybe StopAction) Source #
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
receiptAction_workmailAction :: Lens' ReceiptAction (Maybe WorkmailAction) Source #
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.
ReceiptFilter
data ReceiptFilter Source #
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: newReceiptFilter smart constructor.
Constructors
| ReceiptFilter' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ReceiptIpFilter | |
| -> ReceiptFilter |
Create a value of ReceiptFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:ReceiptFilter', receiptFilter_name - 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.
$sel:ipFilter:ReceiptFilter', receiptFilter_ipFilter - A structure that provides the IP addresses to block or allow, and
whether to block or allow incoming mail from them.
receiptFilter_name :: Lens' ReceiptFilter Text Source #
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.
receiptFilter_ipFilter :: Lens' ReceiptFilter ReceiptIpFilter Source #
A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.
ReceiptIpFilter
data ReceiptIpFilter Source #
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: newReceiptIpFilter smart constructor.
Constructors
| ReceiptIpFilter' | |
Fields
| |
Instances
Arguments
| :: ReceiptFilterPolicy | |
| -> Text | |
| -> ReceiptIpFilter |
Create a value of ReceiptIpFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policy:ReceiptIpFilter', receiptIpFilter_policy - Indicates whether to block or allow incoming mail from the specified IP
addresses.
$sel:cidr:ReceiptIpFilter', receiptIpFilter_cidr - 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.1/24. For more information about CIDR notation,
see RFC 2317.
receiptIpFilter_policy :: Lens' ReceiptIpFilter ReceiptFilterPolicy Source #
Indicates whether to block or allow incoming mail from the specified IP addresses.
receiptIpFilter_cidr :: Lens' ReceiptIpFilter Text Source #
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.1/24. For more information about CIDR notation, see RFC 2317.
ReceiptRule
data ReceiptRule Source #
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: newReceiptRule smart constructor.
Constructors
| ReceiptRule' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ReceiptRule |
Create a value of ReceiptRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actions:ReceiptRule', receiptRule_actions - 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.
$sel:enabled:ReceiptRule', receiptRule_enabled - If true, the receipt rule is active. The default value is false.
$sel:recipients:ReceiptRule', receiptRule_recipients - 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.
$sel:scanEnabled:ReceiptRule', receiptRule_scanEnabled - If true, then messages that this receipt rule applies to are scanned
for spam and viruses. The default value is false.
$sel:tlsPolicy:ReceiptRule', receiptRule_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.
$sel:name:ReceiptRule', receiptRule_name - 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.
receiptRule_actions :: Lens' ReceiptRule (Maybe [ReceiptAction]) Source #
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.
receiptRule_enabled :: Lens' ReceiptRule (Maybe Bool) Source #
If true, the receipt rule is active. The default value is false.
receiptRule_recipients :: Lens' ReceiptRule (Maybe [Text]) Source #
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.
receiptRule_scanEnabled :: Lens' ReceiptRule (Maybe Bool) Source #
If true, then messages that this receipt rule applies to are scanned
for spam and viruses. The default value is false.
receiptRule_tlsPolicy :: Lens' ReceiptRule (Maybe TlsPolicy) Source #
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.
receiptRule_name :: Lens' ReceiptRule Text Source #
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 Source #
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: newReceiptRuleSetMetadata smart constructor.
Constructors
| ReceiptRuleSetMetadata' | |
Fields
| |
Instances
newReceiptRuleSetMetadata :: ReceiptRuleSetMetadata Source #
Create a value of ReceiptRuleSetMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdTimestamp:ReceiptRuleSetMetadata', receiptRuleSetMetadata_createdTimestamp - The date and time the receipt rule set was created.
$sel:name:ReceiptRuleSetMetadata', receiptRuleSetMetadata_name - 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.
receiptRuleSetMetadata_createdTimestamp :: Lens' ReceiptRuleSetMetadata (Maybe UTCTime) Source #
The date and time the receipt rule set was created.
receiptRuleSetMetadata_name :: Lens' ReceiptRuleSetMetadata (Maybe Text) Source #
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.
RecipientDsnFields
data RecipientDsnFields Source #
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: newRecipientDsnFields smart constructor.
Constructors
| RecipientDsnFields' | |
Fields
| |
Instances
newRecipientDsnFields Source #
Arguments
| :: DsnAction | |
| -> Text | |
| -> RecipientDsnFields |
Create a value of RecipientDsnFields with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:diagnosticCode:RecipientDsnFields', recipientDsnFields_diagnosticCode - An extended explanation of what went wrong; this is usually an SMTP
response. See RFC 3463 for the
correct formatting of this parameter.
$sel:extensionFields:RecipientDsnFields', recipientDsnFields_extensionFields - Additional X-headers to include in the DSN.
$sel:finalRecipient:RecipientDsnFields', recipientDsnFields_finalRecipient - 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.
Do not prepend the FinalRecipient email address with rfc 822;, as
described in RFC 3798.
$sel:lastAttemptDate:RecipientDsnFields', recipientDsnFields_lastAttemptDate - The time the final delivery attempt was made, in
RFC 822 date-time format.
$sel:remoteMta:RecipientDsnFields', recipientDsnFields_remoteMta - 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.
$sel:action:RecipientDsnFields', recipientDsnFields_action - 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.
$sel:status:RecipientDsnFields', recipientDsnFields_status - The status code that indicates what went wrong. This is required by
RFC 3464.
recipientDsnFields_diagnosticCode :: Lens' RecipientDsnFields (Maybe Text) Source #
An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.
recipientDsnFields_extensionFields :: Lens' RecipientDsnFields (Maybe [ExtensionField]) Source #
Additional X-headers to include in the DSN.
recipientDsnFields_finalRecipient :: Lens' RecipientDsnFields (Maybe Text) Source #
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.
Do not prepend the FinalRecipient email address with rfc 822;, as
described in RFC 3798.
recipientDsnFields_lastAttemptDate :: Lens' RecipientDsnFields (Maybe UTCTime) Source #
The time the final delivery attempt was made, in RFC 822 date-time format.
recipientDsnFields_remoteMta :: Lens' RecipientDsnFields (Maybe Text) Source #
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.
recipientDsnFields_action :: Lens' RecipientDsnFields DsnAction Source #
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.
recipientDsnFields_status :: Lens' RecipientDsnFields Text Source #
The status code that indicates what went wrong. This is required by RFC 3464.
ReputationOptions
data ReputationOptions Source #
Contains information about the reputation settings for a configuration set.
See: newReputationOptions smart constructor.
Constructors
| ReputationOptions' | |
Fields
| |
Instances
newReputationOptions :: ReputationOptions Source #
Create a value of ReputationOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastFreshStart:ReputationOptions', reputationOptions_lastFreshStart - The date and time 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.
$sel:reputationMetricsEnabled:ReputationOptions', reputationOptions_reputationMetricsEnabled - 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.
$sel:sendingEnabled:ReputationOptions', reputationOptions_sendingEnabled - 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.
reputationOptions_lastFreshStart :: Lens' ReputationOptions (Maybe UTCTime) Source #
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.
reputationOptions_reputationMetricsEnabled :: Lens' ReputationOptions (Maybe Bool) Source #
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.
reputationOptions_sendingEnabled :: Lens' ReputationOptions (Maybe Bool) Source #
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.
When you save your emails to an Amazon S3 bucket, the maximum email size (including headers) is 30 MB. Emails larger than that will bounce.
For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide.
See: newS3Action smart constructor.
Constructors
| S3Action' | |
Fields
| |
Instances
Create a value of S3Action with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKeyArn:S3Action', s3Action_kmsKeyArn - 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:alias/aws/ses. 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:alias/aws/ses. 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.
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 SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.
$sel:objectKeyPrefix:S3Action', s3Action_objectKeyPrefix - 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.
$sel:topicArn:S3Action', s3Action_topicArn - 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.
$sel:bucketName:S3Action', s3Action_bucketName - The name of the Amazon S3 bucket that incoming email will be saved to.
s3Action_kmsKeyArn :: Lens' S3Action (Maybe Text) Source #
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:alias/aws/ses. 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:alias/aws/ses. 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.
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 SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.
s3Action_objectKeyPrefix :: Lens' S3Action (Maybe Text) Source #
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.
s3Action_topicArn :: Lens' S3Action (Maybe Text) Source #
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.
s3Action_bucketName :: Lens' S3Action Text Source #
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.
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: newSNSAction smart constructor.
Constructors
| SNSAction' | |
Fields
| |
Instances
| ToQuery SNSAction Source # | |
Defined in Amazonka.SES.Types.SNSAction Methods toQuery :: SNSAction -> QueryString # | |
| FromXML SNSAction Source # | |
| Generic SNSAction Source # | |
| Read SNSAction Source # | |
| Show SNSAction Source # | |
| NFData SNSAction Source # | |
Defined in Amazonka.SES.Types.SNSAction | |
| Eq SNSAction Source # | |
| Hashable SNSAction Source # | |
Defined in Amazonka.SES.Types.SNSAction | |
| type Rep SNSAction Source # | |
Defined in Amazonka.SES.Types.SNSAction type Rep SNSAction = D1 ('MetaData "SNSAction" "Amazonka.SES.Types.SNSAction" "amazonka-ses-2.0-Gc6VkOIX7Sd2eunWehphuf" 'False) (C1 ('MetaCons "SNSAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "encoding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SNSActionEncoding)) :*: S1 ('MetaSel ('Just "topicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of SNSAction with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encoding:SNSAction', sNSAction_encoding - 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.
$sel:topicArn:SNSAction', sNSAction_topicArn - 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.
sNSAction_encoding :: Lens' SNSAction (Maybe SNSActionEncoding) Source #
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.
sNSAction_topicArn :: Lens' SNSAction Text Source #
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 Source #
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: newSNSDestination smart constructor.
Constructors
| SNSDestination' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> SNSDestination |
Create a value of SNSDestination with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:topicARN:SNSDestination', sNSDestination_topicARN - The 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.
sNSDestination_topicARN :: Lens' SNSDestination Text Source #
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 Source #
Represents sending statistics data. Each SendDataPoint contains
statistics for a 15-minute period of sending activity.
See: newSendDataPoint smart constructor.
Constructors
| SendDataPoint' | |
Fields
| |
Instances
newSendDataPoint :: SendDataPoint Source #
Create a value of SendDataPoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bounces:SendDataPoint', sendDataPoint_bounces - Number of emails that have bounced.
$sel:complaints:SendDataPoint', sendDataPoint_complaints - Number of unwanted emails that were rejected by recipients.
$sel:deliveryAttempts:SendDataPoint', sendDataPoint_deliveryAttempts - Number of emails that have been sent.
$sel:rejects:SendDataPoint', sendDataPoint_rejects - Number of emails rejected by Amazon SES.
$sel:timestamp:SendDataPoint', sendDataPoint_timestamp - Time of the data point.
sendDataPoint_bounces :: Lens' SendDataPoint (Maybe Integer) Source #
Number of emails that have bounced.
sendDataPoint_complaints :: Lens' SendDataPoint (Maybe Integer) Source #
Number of unwanted emails that were rejected by recipients.
sendDataPoint_deliveryAttempts :: Lens' SendDataPoint (Maybe Integer) Source #
Number of emails that have been sent.
sendDataPoint_rejects :: Lens' SendDataPoint (Maybe Integer) Source #
Number of emails rejected by Amazon SES.
sendDataPoint_timestamp :: Lens' SendDataPoint (Maybe UTCTime) Source #
Time of the data point.
StopAction
data StopAction Source #
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: newStopAction smart constructor.
Constructors
| StopAction' | |
Fields
| |
Instances
Arguments
| :: StopScope | |
| -> StopAction |
Create a value of StopAction with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:topicArn:StopAction', stopAction_topicArn - 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.
$sel:scope:StopAction', stopAction_scope - The scope of the StopAction. The only acceptable value is RuleSet.
stopAction_topicArn :: Lens' StopAction (Maybe Text) Source #
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.
stopAction_scope :: Lens' StopAction StopScope Source #
The scope of the StopAction. The only acceptable value is RuleSet.
Template
The content of the email, composed of a subject line, an HTML part, and a text-only part.
See: newTemplate smart constructor.
Constructors
| Template' | |
Fields
| |
Instances
Create a value of Template with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:htmlPart:Template', template_htmlPart - The HTML body of the email.
$sel:subjectPart:Template', template_subjectPart - The subject line of the email.
$sel:textPart:Template', template_textPart - The email body that will be visible to recipients whose email clients do
not display HTML.
$sel:templateName:Template', template_templateName - The name of the template. You will refer to this name when you send
email using the SendTemplatedEmail or SendBulkTemplatedEmail
operations.
template_textPart :: Lens' Template (Maybe Text) Source #
The email body that will be visible to recipients whose email clients do not display HTML.
template_templateName :: Lens' Template Text Source #
The name of the template. You will refer to this name when you send
email using the SendTemplatedEmail or SendBulkTemplatedEmail
operations.
TemplateMetadata
data TemplateMetadata Source #
Contains information about an email template.
See: newTemplateMetadata smart constructor.
Constructors
| TemplateMetadata' | |
Instances
newTemplateMetadata :: TemplateMetadata Source #
Create a value of TemplateMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdTimestamp:TemplateMetadata', templateMetadata_createdTimestamp - The time and date the template was created.
$sel:name:TemplateMetadata', templateMetadata_name - The name of the template.
templateMetadata_createdTimestamp :: Lens' TemplateMetadata (Maybe UTCTime) Source #
The time and date the template was created.
templateMetadata_name :: Lens' TemplateMetadata (Maybe Text) Source #
The name of the template.
TrackingOptions
data TrackingOptions Source #
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: newTrackingOptions smart constructor.
Constructors
| TrackingOptions' | |
Fields
| |
Instances
newTrackingOptions :: TrackingOptions Source #
Create a value of TrackingOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customRedirectDomain:TrackingOptions', trackingOptions_customRedirectDomain - The custom subdomain that will be used to redirect email recipients to
the Amazon SES event tracking domain.
trackingOptions_customRedirectDomain :: Lens' TrackingOptions (Maybe Text) Source #
The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.
WorkmailAction
data WorkmailAction Source #
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: newWorkmailAction smart constructor.
Constructors
| WorkmailAction' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> WorkmailAction |
Create a value of WorkmailAction with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:topicArn:WorkmailAction', workmailAction_topicArn - 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.
$sel:organizationArn:WorkmailAction', workmailAction_organizationArn - 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.
workmailAction_topicArn :: Lens' WorkmailAction (Maybe Text) Source #
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.
workmailAction_organizationArn :: Lens' WorkmailAction Text Source #
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.