libZSservicesZSamazonka-sesZSamazonka-ses
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SES.Lens

Contents

Description

 
Synopsis

Operations

CreateTemplate

createTemplate_template :: Lens' CreateTemplate Template Source #

The content of the email, composed of a subject line, an HTML part, and a text-only part.

DeleteConfigurationSetTrackingOptions

deleteConfigurationSetTrackingOptions_configurationSetName :: Lens' DeleteConfigurationSetTrackingOptions Text Source #

The name of the configuration set from which you want to delete the tracking options.

UpdateConfigurationSetTrackingOptions

updateConfigurationSetTrackingOptions_configurationSetName :: Lens' UpdateConfigurationSetTrackingOptions Text Source #

The name of the configuration set for which you want to update the custom tracking domain.

CreateReceiptRuleSet

createReceiptRuleSet_ruleSetName :: Lens' CreateReceiptRuleSet Text Source #

The name of the rule set to create. 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.

SetIdentityHeadersInNotificationsEnabled

setIdentityHeadersInNotificationsEnabled_identity :: Lens' SetIdentityHeadersInNotificationsEnabled Text Source #

The identity for which to enable or disable headers in notifications. Examples: user@example.com, example.com.

setIdentityHeadersInNotificationsEnabled_notificationType :: Lens' SetIdentityHeadersInNotificationsEnabled NotificationType Source #

The notification type for which to enable or disable headers in notifications.

setIdentityHeadersInNotificationsEnabled_enabled :: Lens' SetIdentityHeadersInNotificationsEnabled Bool Source #

Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES will include headers in notifications, and a value of false specifies that Amazon SES will not include headers in notifications.

This value can only be set when NotificationType is already set to use a particular Amazon SNS topic.

GetSendQuota

getSendQuotaResponse_maxSendRate :: Lens' GetSendQuotaResponse (Maybe Double) Source #

The maximum number of emails that Amazon SES can accept from the user's account per second.

The rate at which Amazon SES accepts the user's messages might be less than the maximum send rate.

getSendQuotaResponse_sentLast24Hours :: Lens' GetSendQuotaResponse (Maybe Double) Source #

The number of emails sent during the previous 24 hours.

getSendQuotaResponse_max24HourSend :: Lens' GetSendQuotaResponse (Maybe Double) Source #

The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota.

PutConfigurationSetDeliveryOptions

putConfigurationSetDeliveryOptions_deliveryOptions :: Lens' PutConfigurationSetDeliveryOptions (Maybe DeliveryOptions) Source #

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

putConfigurationSetDeliveryOptions_configurationSetName :: Lens' PutConfigurationSetDeliveryOptions Text Source #

The name of the configuration set that you want to specify the delivery options for.

DescribeConfigurationSet

describeConfigurationSetResponse_trackingOptions :: Lens' DescribeConfigurationSetResponse (Maybe TrackingOptions) Source #

The name of the custom open and click tracking domain associated with the configuration set.

describeConfigurationSetResponse_configurationSet :: Lens' DescribeConfigurationSetResponse (Maybe ConfigurationSet) Source #

The configuration set object associated with the specified configuration set.

describeConfigurationSetResponse_reputationOptions :: Lens' DescribeConfigurationSetResponse (Maybe ReputationOptions) Source #

An object that represents the reputation settings for the configuration set.

describeConfigurationSetResponse_eventDestinations :: Lens' DescribeConfigurationSetResponse (Maybe [EventDestination]) Source #

A list of event destinations associated with the configuration set.

PutIdentityPolicy

putIdentityPolicy_identity :: Lens' PutIdentityPolicy Text Source #

The identity that the policy will apply to. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

putIdentityPolicy_policyName :: Lens' PutIdentityPolicy Text Source #

The name of the policy.

The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

putIdentityPolicy_policy :: Lens' PutIdentityPolicy Text Source #

The text of the policy in JSON format. The policy cannot exceed 4 KB.

For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.

DeleteCustomVerificationEmailTemplate

deleteCustomVerificationEmailTemplate_templateName :: Lens' DeleteCustomVerificationEmailTemplate Text Source #

The name of the custom verification email template that you want to delete.

DeleteIdentityPolicy

deleteIdentityPolicy_identity :: Lens' DeleteIdentityPolicy Text Source #

The identity that is associated with the policy that you want to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

deleteIdentityPolicy_policyName :: Lens' DeleteIdentityPolicy Text Source #

The name of the policy to be deleted.

UpdateCustomVerificationEmailTemplate

updateCustomVerificationEmailTemplate_fromEmailAddress :: Lens' UpdateCustomVerificationEmailTemplate (Maybe Text) Source #

The email address that the custom verification email is sent from.

updateCustomVerificationEmailTemplate_failureRedirectionURL :: Lens' UpdateCustomVerificationEmailTemplate (Maybe Text) Source #

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

updateCustomVerificationEmailTemplate_successRedirectionURL :: Lens' UpdateCustomVerificationEmailTemplate (Maybe Text) Source #

The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

updateCustomVerificationEmailTemplate_templateContent :: Lens' UpdateCustomVerificationEmailTemplate (Maybe Text) Source #

The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.

updateCustomVerificationEmailTemplate_templateName :: Lens' UpdateCustomVerificationEmailTemplate Text Source #

The name of the custom verification email template that you want to update.

SendCustomVerificationEmail

sendCustomVerificationEmail_configurationSetName :: Lens' SendCustomVerificationEmail (Maybe Text) Source #

Name of a configuration set to use when sending the verification email.

sendCustomVerificationEmail_templateName :: Lens' SendCustomVerificationEmail Text Source #

The name of the custom verification email template to use when sending the verification email.

sendCustomVerificationEmailResponse_messageId :: Lens' SendCustomVerificationEmailResponse (Maybe Text) Source #

The unique message identifier returned from the SendCustomVerificationEmail operation.

GetIdentityNotificationAttributes

getIdentityNotificationAttributes_identities :: Lens' GetIdentityNotificationAttributes [Text] Source #

A list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

UpdateConfigurationSetReputationMetricsEnabled

updateConfigurationSetReputationMetricsEnabled_enabled :: Lens' UpdateConfigurationSetReputationMetricsEnabled Bool Source #

Describes whether or not Amazon SES will publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.

ListIdentityPolicies

listIdentityPolicies_identity :: Lens' ListIdentityPolicies Text Source #

The identity that is associated with the policy for which the policies will be listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

listIdentityPoliciesResponse_policyNames :: Lens' ListIdentityPoliciesResponse [Text] Source #

A list of names of policies that apply to the specified identity.

SetIdentityDkimEnabled

setIdentityDkimEnabled_identity :: Lens' SetIdentityDkimEnabled Text Source #

The identity for which DKIM signing should be enabled or disabled.

setIdentityDkimEnabled_dkimEnabled :: Lens' SetIdentityDkimEnabled Bool Source #

Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it.

ListReceiptFilters

listReceiptFiltersResponse_filters :: Lens' ListReceiptFiltersResponse (Maybe [ReceiptFilter]) Source #

A list of IP address filter data structures, which each consist of a name, an IP address range, and whether to allow or block mail from it.

DescribeReceiptRuleSet

describeReceiptRuleSet_ruleSetName :: Lens' DescribeReceiptRuleSet Text Source #

The name of the receipt rule set to describe.

describeReceiptRuleSetResponse_rules :: Lens' DescribeReceiptRuleSetResponse (Maybe [ReceiptRule]) Source #

A list of the receipt rules that belong to the specified receipt rule set.

describeReceiptRuleSetResponse_metadata :: Lens' DescribeReceiptRuleSetResponse (Maybe ReceiptRuleSetMetadata) Source #

The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created.

GetIdentityMailFromDomainAttributes

CreateReceiptFilter

createReceiptFilter_filter :: Lens' CreateReceiptFilter ReceiptFilter Source #

A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.

UpdateConfigurationSetEventDestination

updateConfigurationSetEventDestination_configurationSetName :: Lens' UpdateConfigurationSetEventDestination Text Source #

The name of the configuration set that contains the event destination that you want to update.

updateConfigurationSetEventDestination_eventDestination :: Lens' UpdateConfigurationSetEventDestination EventDestination Source #

The event destination object that you want to apply to the specified configuration set.

DeleteConfigurationSetEventDestination

deleteConfigurationSetEventDestination_configurationSetName :: Lens' DeleteConfigurationSetEventDestination Text Source #

The name of the configuration set from which to delete the event destination.

SetIdentityMailFromDomain

setIdentityMailFromDomain_mailFromDomain :: Lens' SetIdentityMailFromDomain (Maybe Text) Source #

The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a "From" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of null disables the custom MAIL FROM setting for the identity.

setIdentityMailFromDomain_behaviorOnMXFailure :: Lens' SetIdentityMailFromDomain (Maybe BehaviorOnMXFailure) Source #

The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES will return a MailFromDomainNotVerified error and not send the email.

The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup is in the Pending, Failed, and TemporaryFailure states.

setIdentityMailFromDomain_identity :: Lens' SetIdentityMailFromDomain Text Source #

The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.

SetIdentityFeedbackForwardingEnabled

setIdentityFeedbackForwardingEnabled_identity :: Lens' SetIdentityFeedbackForwardingEnabled Text Source #

The identity for which to set bounce and complaint notification forwarding. Examples: user@example.com, example.com.

setIdentityFeedbackForwardingEnabled_forwardingEnabled :: Lens' SetIdentityFeedbackForwardingEnabled Bool Source #

Sets whether Amazon SES will forward bounce and complaint notifications as email. true specifies that Amazon SES will forward bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. false specifies that Amazon SES will publish bounce and complaint notifications only through Amazon SNS. This value can only be set to false when Amazon SNS topics are set for both Bounce and Complaint notification types.

ListConfigurationSets

listConfigurationSets_nextToken :: Lens' ListConfigurationSets (Maybe Text) Source #

A token returned from a previous call to ListConfigurationSets to indicate the position of the configuration set in the configuration set list.

listConfigurationSets_maxItems :: Lens' ListConfigurationSets (Maybe Int) Source #

The number of configuration sets to return.

listConfigurationSetsResponse_nextToken :: Lens' ListConfigurationSetsResponse (Maybe Text) Source #

A token indicating that there are additional configuration sets available to be listed. Pass this token to successive calls of ListConfigurationSets.

DeleteConfigurationSet

GetIdentityVerificationAttributes

GetIdentityPolicies

getIdentityPolicies_identity :: Lens' GetIdentityPolicies Text Source #

The identity for which the policies will be retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

getIdentityPolicies_policyNames :: Lens' GetIdentityPolicies [Text] Source #

A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies.

ListTemplates

listTemplates_nextToken :: Lens' ListTemplates (Maybe Text) Source #

A token returned from a previous call to ListTemplates to indicate the position in the list of email templates.

listTemplates_maxItems :: Lens' ListTemplates (Maybe Int) Source #

The maximum number of templates to return. This value must be at least 1 and less than or equal to 10. If you do not specify a value, or if you specify a value less than 1 or greater than 10, the operation will return up to 10 results.

listTemplatesResponse_templatesMetadata :: Lens' ListTemplatesResponse (Maybe [TemplateMetadata]) Source #

An array the contains the name and creation time stamp for each template in your Amazon SES account.

listTemplatesResponse_nextToken :: Lens' ListTemplatesResponse (Maybe Text) Source #

A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 email templates.

VerifyDomainIdentity

verifyDomainIdentityResponse_verificationToken :: Lens' VerifyDomainIdentityResponse Text Source #

A TXT record that you must place in the DNS settings of the domain to complete domain verification with Amazon SES.

As Amazon SES searches for the TXT record, the domain's verification status is "Pending". When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning.

UpdateTemplate

DeleteTemplate

deleteTemplate_templateName :: Lens' DeleteTemplate Text Source #

The name of the template to be deleted.

ReorderReceiptRuleSet

reorderReceiptRuleSet_ruleSetName :: Lens' ReorderReceiptRuleSet Text Source #

The name of the receipt rule set to reorder.

reorderReceiptRuleSet_ruleNames :: Lens' ReorderReceiptRuleSet [Text] Source #

A list of the specified receipt rule set's receipt rules in the order that you want to put them.

ListReceiptRuleSets

listReceiptRuleSets_nextToken :: Lens' ListReceiptRuleSets (Maybe Text) Source #

A token returned from a previous call to ListReceiptRuleSets to indicate the position in the receipt rule set list.

listReceiptRuleSetsResponse_ruleSets :: Lens' ListReceiptRuleSetsResponse (Maybe [ReceiptRuleSetMetadata]) Source #

The metadata for the currently active receipt rule set. The metadata consists of the rule set name and the timestamp of when the rule set was created.

listReceiptRuleSetsResponse_nextToken :: Lens' ListReceiptRuleSetsResponse (Maybe Text) Source #

A token indicating that there are additional receipt rule sets available to be listed. Pass this token to successive calls of ListReceiptRuleSets to retrieve up to 100 receipt rule sets at a time.

DeleteReceiptRuleSet

deleteReceiptRuleSet_ruleSetName :: Lens' DeleteReceiptRuleSet Text Source #

The name of the receipt rule set to delete.

SetReceiptRulePosition

setReceiptRulePosition_after :: Lens' SetReceiptRulePosition (Maybe Text) Source #

The name of the receipt rule after which to place the specified receipt rule.

setReceiptRulePosition_ruleSetName :: Lens' SetReceiptRulePosition Text Source #

The name of the receipt rule set that contains the receipt rule to reposition.

setReceiptRulePosition_ruleName :: Lens' SetReceiptRulePosition Text Source #

The name of the receipt rule to reposition.

SendBounce

sendBounce_messageDsn :: Lens' SendBounce (Maybe MessageDsn) Source #

Message-related DSN fields. If not specified, Amazon SES will choose the values.

sendBounce_explanation :: Lens' SendBounce (Maybe Text) Source #

Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.

sendBounce_bounceSenderArn :: Lens' SendBounce (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 use the address in the "From" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.

sendBounce_originalMessageId :: Lens' SendBounce Text Source #

The message ID of the message to be bounced.

sendBounce_bounceSender :: Lens' SendBounce Text Source #

The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.

sendBounce_bouncedRecipientInfoList :: Lens' SendBounce [BouncedRecipientInfo] Source #

A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.

sendBounceResponse_messageId :: Lens' SendBounceResponse (Maybe Text) Source #

The message ID of the bounce message.

GetIdentityDkimAttributes

getIdentityDkimAttributes_identities :: Lens' GetIdentityDkimAttributes [Text] Source #

A list of one or more verified identities - email addresses, domains, or both.

SendTemplatedEmail

sendTemplatedEmail_returnPath :: Lens' SendTemplatedEmail (Maybe Text) Source #

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

sendTemplatedEmail_configurationSetName :: Lens' SendTemplatedEmail (Maybe Text) Source #

The name of the configuration set to use when you send an email using SendTemplatedEmail.

sendTemplatedEmail_sourceArn :: Lens' SendTemplatedEmail (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 send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

sendTemplatedEmail_returnPathArn :: Lens' SendTemplatedEmail (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 use the email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

sendTemplatedEmail_templateArn :: Lens' SendTemplatedEmail (Maybe Text) Source #

The ARN of the template to use when sending this email.

sendTemplatedEmail_tags :: Lens' SendTemplatedEmail (Maybe [MessageTag]) Source #

A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

sendTemplatedEmail_replyToAddresses :: Lens' SendTemplatedEmail (Maybe [Text]) Source #

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

sendTemplatedEmail_source :: Lens' SendTemplatedEmail Text Source #

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source 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. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

sendTemplatedEmail_destination :: Lens' SendTemplatedEmail Destination Source #

The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.

sendTemplatedEmail_template :: Lens' SendTemplatedEmail Text Source #

The template to use when sending this email.

sendTemplatedEmail_templateData :: Lens' SendTemplatedEmail 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.

sendTemplatedEmailResponse_messageId :: Lens' SendTemplatedEmailResponse Text Source #

The unique message identifier returned from the SendTemplatedEmail action.

VerifyDomainDkim

verifyDomainDkim_domain :: Lens' VerifyDomainDkim Text Source #

The name of the domain to be verified for Easy DKIM signing.

verifyDomainDkimResponse_dkimTokens :: Lens' VerifyDomainDkimResponse [Text] Source #

A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address.

Using these tokens, you 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.

TestRenderTemplate

testRenderTemplate_templateName :: Lens' TestRenderTemplate Text Source #

The name of the template that you want to render.

testRenderTemplate_templateData :: Lens' TestRenderTemplate 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.

testRenderTemplateResponse_renderedTemplate :: Lens' TestRenderTemplateResponse (Maybe Text) Source #

The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.

SendBulkTemplatedEmail

sendBulkTemplatedEmail_returnPath :: Lens' SendBulkTemplatedEmail (Maybe Text) Source #

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

sendBulkTemplatedEmail_configurationSetName :: Lens' SendBulkTemplatedEmail (Maybe Text) Source #

The name of the configuration set to use when you send an email using SendBulkTemplatedEmail.

sendBulkTemplatedEmail_sourceArn :: Lens' SendBulkTemplatedEmail (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 send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

sendBulkTemplatedEmail_defaultTags :: Lens' SendBulkTemplatedEmail (Maybe [MessageTag]) Source #

A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

sendBulkTemplatedEmail_returnPathArn :: Lens' SendBulkTemplatedEmail (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 use the email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

sendBulkTemplatedEmail_templateArn :: Lens' SendBulkTemplatedEmail (Maybe Text) Source #

The ARN of the template to use when sending this email.

sendBulkTemplatedEmail_defaultTemplateData :: Lens' SendBulkTemplatedEmail (Maybe Text) Source #

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

sendBulkTemplatedEmail_replyToAddresses :: Lens' SendBulkTemplatedEmail (Maybe [Text]) Source #

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

sendBulkTemplatedEmail_source :: Lens' SendBulkTemplatedEmail Text Source #

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source 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. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

sendBulkTemplatedEmail_template :: Lens' SendBulkTemplatedEmail Text Source #

The template to use when sending this email.

sendBulkTemplatedEmail_destinations :: Lens' SendBulkTemplatedEmail [BulkEmailDestination] Source #

One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

sendBulkTemplatedEmailResponse_status :: Lens' SendBulkTemplatedEmailResponse [BulkEmailDestinationStatus] Source #

The unique message identifier returned from the SendBulkTemplatedEmail action.

SendRawEmail

sendRawEmail_configurationSetName :: Lens' SendRawEmail (Maybe Text) Source #

The name of the configuration set to use when you send an email using SendRawEmail.

sendRawEmail_sourceArn :: Lens' SendRawEmail (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 send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

Instead of using this parameter, you can use the X-header X-SES-SOURCE-ARN in the raw message of the email. If you use both the SourceArn parameter and the corresponding X-header, Amazon SES uses the value of the SourceArn parameter.

For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

sendRawEmail_destinations :: Lens' SendRawEmail (Maybe [Text]) Source #

A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.

sendRawEmail_returnPathArn :: Lens' SendRawEmail (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 use the email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

Instead of using this parameter, you can use the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both the ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the value of the ReturnPathArn parameter.

For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

sendRawEmail_source :: Lens' SendRawEmail (Maybe Text) Source #

The identity's email address. If you do not provide a value for this parameter, you must specify a "From" address in the raw text of the message. (You can also specify both.)

Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the local part of a source 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. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

If you specify the Source parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.

sendRawEmail_fromArn :: Lens' SendRawEmail (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 specify a particular "From" address in the header of the raw email.

Instead of using this parameter, you can use the X-header X-SES-FROM-ARN in the raw message of the email. If you use both the FromArn parameter and the corresponding X-header, Amazon SES uses the value of the FromArn parameter.

For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

sendRawEmail_tags :: Lens' SendRawEmail (Maybe [MessageTag]) Source #

A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

sendRawEmail_rawMessage :: Lens' SendRawEmail RawMessage Source #

The raw email message itself. The message has to meet the following criteria:

  • The message has to contain a header and a body, separated by a blank line.
  • All of the required header fields must be present in the message.
  • Each part of a multipart MIME message must be formatted properly.
  • Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide.
  • The entire message must be base64-encoded.
  • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide.
  • Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.

sendRawEmailResponse_messageId :: Lens' SendRawEmailResponse Text Source #

The unique message identifier returned from the SendRawEmail action.

GetSendStatistics

getSendStatisticsResponse_sendDataPoints :: Lens' GetSendStatisticsResponse (Maybe [SendDataPoint]) Source #

A list of data points, each of which represents 15 minutes of activity.

ListCustomVerificationEmailTemplates

listCustomVerificationEmailTemplates_nextToken :: Lens' ListCustomVerificationEmailTemplates (Maybe Text) Source #

An array the contains the name and creation time stamp for each template in your Amazon SES account.

listCustomVerificationEmailTemplates_maxResults :: Lens' ListCustomVerificationEmailTemplates (Maybe Natural) Source #

The maximum number of custom verification email templates to return. This value must be at least 1 and less than or equal to 50. If you do not specify a value, or if you specify a value less than 1 or greater than 50, the operation will return up to 50 results.

listCustomVerificationEmailTemplatesResponse_nextToken :: Lens' ListCustomVerificationEmailTemplatesResponse (Maybe Text) Source #

A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 custom verification email templates.

DeleteIdentity

deleteIdentity_identity :: Lens' DeleteIdentity Text Source #

The identity to be removed from the list of identities for the AWS Account.

DescribeReceiptRule

describeReceiptRule_ruleSetName :: Lens' DescribeReceiptRule Text Source #

The name of the receipt rule set that the receipt rule belongs to.

describeReceiptRuleResponse_rule :: Lens' DescribeReceiptRuleResponse (Maybe ReceiptRule) Source #

A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.

ListIdentities

listIdentities_identityType :: Lens' ListIdentities (Maybe IdentityType) Source #

The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed.

listIdentities_nextToken :: Lens' ListIdentities (Maybe Text) Source #

The token to use for pagination.

listIdentities_maxItems :: Lens' ListIdentities (Maybe Int) Source #

The maximum number of identities per page. Possible values are 1-1000 inclusive.

UpdateConfigurationSetSendingEnabled

updateConfigurationSetSendingEnabled_enabled :: Lens' UpdateConfigurationSetSendingEnabled Bool Source #

Describes whether email sending is enabled or disabled for the configuration set.

CreateCustomVerificationEmailTemplate

createCustomVerificationEmailTemplate_fromEmailAddress :: Lens' CreateCustomVerificationEmailTemplate Text Source #

The email address that the custom verification email is sent from.

createCustomVerificationEmailTemplate_templateContent :: Lens' CreateCustomVerificationEmailTemplate Text Source #

The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.

createCustomVerificationEmailTemplate_successRedirectionURL :: Lens' CreateCustomVerificationEmailTemplate Text Source #

The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

createCustomVerificationEmailTemplate_failureRedirectionURL :: Lens' CreateCustomVerificationEmailTemplate Text Source #

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

VerifyEmailIdentity

VerifyEmailAddress

DeleteVerifiedEmailAddress

deleteVerifiedEmailAddress_emailAddress :: Lens' DeleteVerifiedEmailAddress Text Source #

An email address to be removed from the list of verified addresses.

DeleteReceiptFilter

deleteReceiptFilter_filterName :: Lens' DeleteReceiptFilter Text Source #

The name of the IP address filter to delete.

ListVerifiedEmailAddresses

GetCustomVerificationEmailTemplate

getCustomVerificationEmailTemplate_templateName :: Lens' GetCustomVerificationEmailTemplate Text Source #

The name of the custom verification email template that you want to retrieve.

getCustomVerificationEmailTemplateResponse_failureRedirectionURL :: Lens' GetCustomVerificationEmailTemplateResponse (Maybe Text) Source #

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

getCustomVerificationEmailTemplateResponse_successRedirectionURL :: Lens' GetCustomVerificationEmailTemplateResponse (Maybe Text) Source #

The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

SetIdentityNotificationTopic

setIdentityNotificationTopic_snsTopic :: Lens' SetIdentityNotificationTopic (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, SnsTopic is cleared and publishing is disabled.

setIdentityNotificationTopic_identity :: Lens' SetIdentityNotificationTopic Text Source #

The identity (email address or domain) that you want to set the Amazon SNS topic for.

You can only specify a verified identity for this parameter.

You can specify an identity by using its name or by using its Amazon Resource Name (ARN). The following examples are all valid identities: sender@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

setIdentityNotificationTopic_notificationType :: Lens' SetIdentityNotificationTopic NotificationType Source #

The type of notifications that will be published to the specified Amazon SNS topic.

SendEmail

sendEmail_returnPath :: Lens' SendEmail (Maybe Text) Source #

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

sendEmail_configurationSetName :: Lens' SendEmail (Maybe Text) Source #

The name of the configuration set to use when you send an email using SendEmail.

sendEmail_sourceArn :: Lens' SendEmail (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 send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

sendEmail_returnPathArn :: Lens' SendEmail (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 use the email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

sendEmail_tags :: Lens' SendEmail (Maybe [MessageTag]) Source #

A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

sendEmail_replyToAddresses :: Lens' SendEmail (Maybe [Text]) Source #

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

sendEmail_source :: Lens' SendEmail Text Source #

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source 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. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

sendEmail_destination :: Lens' SendEmail Destination Source #

The destination for this email, composed of To:, CC:, and BCC: fields.

sendEmail_message :: Lens' SendEmail Message Source #

The message to be sent.

sendEmailResponse_httpStatus :: Lens' SendEmailResponse Int Source #

The response's http status code.

sendEmailResponse_messageId :: Lens' SendEmailResponse Text Source #

The unique message identifier returned from the SendEmail action.

DeleteReceiptRule

deleteReceiptRule_ruleSetName :: Lens' DeleteReceiptRule Text Source #

The name of the receipt rule set that contains the receipt rule to delete.

deleteReceiptRule_ruleName :: Lens' DeleteReceiptRule Text Source #

The name of the receipt rule to delete.

UpdateReceiptRule

updateReceiptRule_ruleSetName :: Lens' UpdateReceiptRule Text Source #

The name of the receipt rule set that the receipt rule belongs to.

updateReceiptRule_rule :: Lens' UpdateReceiptRule ReceiptRule Source #

A data structure that contains the updated receipt rule information.

CloneReceiptRuleSet

cloneReceiptRuleSet_ruleSetName :: Lens' CloneReceiptRuleSet Text Source #

The name of the rule set to create. 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.

CreateConfigurationSetEventDestination

createConfigurationSetEventDestination_configurationSetName :: Lens' CreateConfigurationSetEventDestination Text Source #

The name of the configuration set that the event destination should be associated with.

createConfigurationSetEventDestination_eventDestination :: Lens' CreateConfigurationSetEventDestination EventDestination Source #

An object that describes the AWS service that email sending event information will be published to.

GetAccountSendingEnabled

getAccountSendingEnabledResponse_enabled :: Lens' GetAccountSendingEnabledResponse (Maybe Bool) Source #

Describes whether email sending is enabled or disabled for your Amazon SES account in the current AWS Region.

CreateReceiptRule

createReceiptRule_after :: Lens' CreateReceiptRule (Maybe Text) Source #

The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list.

createReceiptRule_ruleSetName :: Lens' CreateReceiptRule Text Source #

The name of the rule set that the receipt rule will be added to.

createReceiptRule_rule :: Lens' CreateReceiptRule ReceiptRule Source #

A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.

GetTemplate

getTemplate_templateName :: Lens' GetTemplate Text Source #

The name of the template you want to retrieve.

SetActiveReceiptRuleSet

setActiveReceiptRuleSet_ruleSetName :: Lens' SetActiveReceiptRuleSet (Maybe Text) Source #

The name of the receipt rule set to make active. Setting this value to null disables all email receiving.

CreateConfigurationSet

createConfigurationSet_configurationSet :: Lens' CreateConfigurationSet ConfigurationSet Source #

A data structure that contains the name of the configuration set.

UpdateAccountSendingEnabled

updateAccountSendingEnabled_enabled :: Lens' UpdateAccountSendingEnabled (Maybe Bool) Source #

Describes whether email sending is enabled or disabled for your Amazon SES account in the current AWS Region.

CreateConfigurationSetTrackingOptions

createConfigurationSetTrackingOptions_configurationSetName :: Lens' CreateConfigurationSetTrackingOptions Text Source #

The name of the configuration set that the tracking options should be associated with.

DescribeActiveReceiptRuleSet

describeActiveReceiptRuleSetResponse_metadata :: Lens' DescribeActiveReceiptRuleSetResponse (Maybe ReceiptRuleSetMetadata) Source #

The metadata for the currently active receipt rule set. The metadata consists of the rule set name and a timestamp of when the rule set was created.

Types

AddHeaderAction

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

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).

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.

BounceAction

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_statusCode :: Lens' BounceAction (Maybe Text) Source #

The SMTP enhanced status code, as defined by RFC 3463.

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

bouncedRecipientInfo_bounceType :: Lens' BouncedRecipientInfo (Maybe BounceType) Source #

The reason for the bounce. You must provide either this parameter or RecipientDsnFields.

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_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_recipient :: Lens' BouncedRecipientInfo Text Source #

The email address of the recipient of the bounced email.

BulkEmailDestination

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_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.

BulkEmailDestinationStatus

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.

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.

CloudWatchDestination

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

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

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

content_charset :: Lens' Content (Maybe Text) Source #

The character set of the content.

content_data :: Lens' Content Text Source #

The textual data of the content.

CustomVerificationEmailTemplate

customVerificationEmailTemplate_fromEmailAddress :: Lens' CustomVerificationEmailTemplate (Maybe Text) Source #

The email address that the custom verification email is sent from.

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_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.

DeliveryOptions

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

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

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_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_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

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

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

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

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_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_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_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

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

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

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

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.

message_body :: Lens' Message Body Source #

The message body.

MessageDsn

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

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

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

receiptAction_sNSAction :: Lens' ReceiptAction (Maybe SNSAction) Source #

Publishes the email content within a notification to Amazon SNS.

receiptAction_workmailAction :: Lens' ReceiptAction (Maybe WorkmailAction) Source #

Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.

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_stopAction :: Lens' ReceiptAction (Maybe StopAction) Source #

Terminates the evaluation of the receipt rule set 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.

ReceiptFilter

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

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

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_enabled :: Lens' ReceiptRule (Maybe Bool) Source #

If true, the receipt rule is active. The default value is false.

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_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_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

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.

receiptRuleSetMetadata_createdTimestamp :: Lens' ReceiptRuleSetMetadata (Maybe UTCTime) Source #

The date and time the receipt rule set was created.

RecipientDsnFields

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_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_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_extensionFields :: Lens' RecipientDsnFields (Maybe [ExtensionField]) Source #

Additional X-headers to include in the DSN.

recipientDsnFields_lastAttemptDate :: Lens' RecipientDsnFields (Maybe UTCTime) Source #

The time the final delivery attempt was made, in RFC 822 date-time format.

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

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

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 be arn: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_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_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_bucketName :: Lens' S3Action Text Source #

The name of the Amazon S3 bucket that incoming email will be saved to.

SNSAction

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

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

sendDataPoint_rejects :: Lens' SendDataPoint (Maybe Integer) Source #

Number of emails rejected by Amazon SES.

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_bounces :: Lens' SendDataPoint (Maybe Integer) Source #

Number of emails that have bounced.

StopAction

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

template_textPart :: Lens' Template (Maybe Text) Source #

The email body that will be visible to recipients whose email clients do not display HTML.

template_subjectPart :: Lens' Template (Maybe Text) Source #

The subject line of the email.

template_htmlPart :: Lens' Template (Maybe Text) Source #

The HTML body of the email.

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

templateMetadata_createdTimestamp :: Lens' TemplateMetadata (Maybe UTCTime) Source #

The time and date the template was created.

TrackingOptions

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

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.