String headerName
The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.
String headerValue
The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (
\n) or carriage return (\r) characters.
String name
Indicates that a resource could not be created because the resource name already exists.
Content 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).
Content 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.
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
String smtpReplyCode
The SMTP reply code, as defined by RFC 5321.
String statusCode
The SMTP enhanced status code, as defined by RFC 3463.
String message
Human-readable text to include in the bounce message.
String sender
The email address of the sender of the bounced email. This is the address from which the bounce message is sent.
String recipient
The email address of the recipient of the bounced email.
String 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.
String bounceType
The reason for the bounce. You must provide either this parameter or RecipientDsnFields.
RecipientDsnFields 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.
Destination destination
SdkInternalList<T> 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.
String 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.
String status
The status of a message sent using the SendBulkTemplatedEmail operation.
Possible values for this parameter include:
Success: Amazon SES accepted the message, and attempts 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.
String error
A description of an error that prevented a message being sent using the SendBulkTemplatedEmail
operation.
String messageId
The unique message identifier returned from the SendBulkTemplatedEmail operation.
String name
Indicates that a resource could not be deleted because no resource with the specified name exists.
String ruleSetName
The name of the rule set to create. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain 64 characters or fewer.
String originalRuleSetName
The name of the rule set to clone.
SdkInternalList<T> dimensionConfigurations
A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.
String dimensionName
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or colons (:).
Contain 256 characters or fewer.
String dimensionValueSource
The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use the message
tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the
SendEmail/SendRawEmail API, specify messageTag. To use your own email
headers, specify emailHeader. To put a custom tag on any link included in your email, specify
linkTag.
String 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 meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), at signs (@), or periods (.).
Contain 256 characters or fewer.
String 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.
String configurationSetName
Indicates that the configuration set does not exist.
String configurationSetName
Indicates that the configuration set does not exist.
String configurationSetName
The name of the configuration set for which email sending is disabled.
String configurationSetName
The name of the configuration set that the event destination should be associated with.
EventDestination eventDestination
An object that describes the Amazon Web Services service that email sending event where information is published.
ConfigurationSet configurationSet
A data structure that contains the name of the configuration set.
String configurationSetName
The name of the configuration set that the tracking options should be associated with.
TrackingOptions trackingOptions
String templateName
The name of the custom verification email template.
String fromEmailAddress
The email address that the custom verification email is sent from.
String templateSubject
The subject line of the custom verification email.
String templateContent
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.
String successRedirectionURL
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
String failureRedirectionURL
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
ReceiptFilter filter
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.
String ruleSetName
The name of the rule set where the receipt rule is added.
String after
The name of an existing rule after which the new rule is placed. If this parameter is null, the new rule is inserted at the beginning of the rule list.
ReceiptRule rule
A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
String ruleSetName
The name of the rule set to create. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain 64 characters or fewer.
Template template
The content of the email, composed of a subject line and either an HTML part or a text-only part.
String templateName
The name of the custom verification email template.
String fromEmailAddress
The email address that the custom verification email is sent from.
String templateSubject
The subject line of the custom verification email.
String successRedirectionURL
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
String failureRedirectionURL
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
String customVerificationEmailTemplateName
Indicates that the provided custom verification email template with the specified template name already exists.
String customVerificationEmailTemplateName
Indicates that the provided custom verification email template does not exist.
String configurationSetName
The name of the configuration set to delete.
String configurationSetName
The name of the configuration set.
String templateName
The name of the custom verification email template to delete.
String identity
The identity that is associated with the policy to delete. You can specify the identity by using its name or by
using its Amazon Resource Name (ARN). Examples: [email protected], example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this operation, you must own the identity.
String policyName
The name of the policy to be deleted.
String identity
The identity to be removed from the list of identities for the Amazon Web Services account.
String filterName
The name of the IP address filter to delete.
String ruleSetName
The name of the receipt rule set to delete.
String templateName
The name of the template to be deleted.
String emailAddress
An email address to be removed from the list of verified addresses.
String 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.
ReceiptRuleSetMetadata metadata
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.
SdkInternalList<T> rules
The receipt rules that belong to the active rule set.
String configurationSetName
The name of the configuration set to describe.
SdkInternalList<T> configurationSetAttributeNames
A list of configuration set attributes to return.
ConfigurationSet configurationSet
The configuration set object associated with the specified configuration set.
SdkInternalList<T> eventDestinations
A list of event destinations associated with the configuration set.
TrackingOptions trackingOptions
The name of the custom open and click tracking domain associated with the configuration set.
DeliveryOptions deliveryOptions
ReputationOptions reputationOptions
An object that represents the reputation settings for the configuration set.
ReceiptRule rule
A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.
String ruleSetName
The name of the receipt rule set to describe.
ReceiptRuleSetMetadata metadata
The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created.
SdkInternalList<T> rules
A list of the receipt rules that belong to the specified receipt rule set.
SdkInternalList<T> toAddresses
The recipients to place on the To: line of the message.
SdkInternalList<T> ccAddresses
The recipients to place on the CC: line of the message.
SdkInternalList<T> bccAddresses
The recipients to place on the BCC: line of the message.
String name
The name of the event destination. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain 64 characters or fewer.
Boolean 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.
SdkInternalList<T> matchingEventTypes
The type of email sending events to publish to the event destination.
send - The call was successful and Amazon SES is attempting to deliver the email.
reject - Amazon SES determined that the email contained a virus and rejected it.
bounce - The recipient's mail server permanently rejected the email. This corresponds to a hard
bounce.
complaint - The recipient marked the email as spam.
delivery - Amazon SES successfully delivered the email to the recipient's mail server.
open - The recipient received the email and opened it in their email client.
click - The recipient clicked one or more links in the email.
renderingFailure - Amazon SES did not send the email because of a template rendering issue.
KinesisFirehoseDestination kinesisFirehoseDestination
An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
CloudWatchDestination cloudWatchDestination
An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
SNSDestination sNSDestination
An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
String 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.
String value
The value of the header to add. Must contain 2048 characters or fewer, and must not contain newline characters ("\r" or "\n").
String fromEmailAddress
Indicates that the from email address associated with the custom verification email template is not verified.
Boolean enabled
Describes whether email sending is enabled or disabled for your Amazon SES account in the current Amazon Web Services Region.
String templateName
The name of the custom verification email template to retrieve.
String templateName
The name of the custom verification email template.
String fromEmailAddress
The email address that the custom verification email is sent from.
String templateSubject
The subject line of the custom verification email.
String templateContent
The content of the custom verification email.
String successRedirectionURL
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
String failureRedirectionURL
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
SdkInternalList<T> identities
A list of one or more verified identities - email addresses, domains, or both.
SdkInternalMap<K,V> dkimAttributes
The DKIM attributes for an email address or a domain.
SdkInternalList<T> identities
A list of one or more identities.
SdkInternalMap<K,V> mailFromDomainAttributes
A map of identities to custom MAIL FROM attributes.
SdkInternalList<T> identities
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: [email protected], example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.
SdkInternalMap<K,V> notificationAttributes
A map of Identity to IdentityNotificationAttributes.
String identity
The identity for which the policies are retrieved. You can specify an identity by using its name or by using its
Amazon Resource Name (ARN). Examples: [email protected], example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this operation, you must own the identity.
SdkInternalList<T> policyNames
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.
SdkInternalMap<K,V> policies
A map of policy names to policies.
SdkInternalList<T> identities
A list of identities.
SdkInternalMap<K,V> verificationAttributes
A map of Identities to IdentityVerificationAttributes objects.
Double max24HourSend
The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota.
Double maxSendRate
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.
Double sentLast24Hours
The number of emails sent during the previous 24 hours.
SdkInternalList<T> sendDataPoints
A list of data points, each of which represents 15 minutes of activity.
String templateName
The name of the template to retrieve.
Template template
Boolean dkimEnabled
Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default value is true.
String 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.)
SdkInternalList<T> 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.
String mailFromDomain
The custom MAIL FROM domain that the identity is configured to use.
String 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.
String 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.
String bounceTopic
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes bounce notifications.
String complaintTopic
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes complaint notifications.
String deliveryTopic
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes delivery notifications.
Boolean forwardingEnabled
Describes whether Amazon SES forwards bounce and complaint notifications as email. true indicates
that Amazon SES forwards bounce and complaint notifications as email, while false indicates that
bounce and complaint notifications are published only to the specified bounce and complaint Amazon SNS topics.
Boolean 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 includes headers in bounce
notifications, and a value of false specifies that Amazon SES does not include headers in bounce
notifications.
Boolean 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 includes headers in complaint
notifications, and a value of false specifies that Amazon SES does not include headers in complaint
notifications.
Boolean 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 includes headers in delivery
notifications, and a value of false specifies that Amazon SES does not include headers in delivery
notifications.
String functionArn
Indicates that the ARN of the function was not found.
String templateName
String bucket
Indicated that the S3 Bucket was not found.
String topic
Indicates that the topic does not exist.
String templateName
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
String functionArn
The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function. An example of an Amazon Web Services
Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information
about Amazon Web Services Lambda, see the Amazon Web Services Lambda Developer Guide.
String invocationType
The invocation type of the Amazon Web Services Lambda function. An invocation type of
RequestResponse means that the execution of the function immediately results in a response, and a
value of Event means that the function is invoked asynchronously. The default value is
Event. For information about Amazon Web Services Lambda invocation types, see the Amazon Web Services Lambda Developer
Guide.
There is a 30-second timeout on RequestResponse invocations. You should use Event
invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to
stop the receipt rule or the receipt rule set.
SdkInternalList<T> configurationSets
A list of configuration sets.
String nextToken
A token indicating that there are additional configuration sets available to be listed. Pass this token to
successive calls of ListConfigurationSets.
String nextToken
An array the contains the name and creation time stamp for each template in your Amazon SES account.
Integer maxResults
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 returns up to 50 results.
SdkInternalList<T> customVerificationEmailTemplates
A list of the custom verification email templates that exist in your account.
String nextToken
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.
String identityType
The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities are listed.
String nextToken
The token to use for pagination.
Integer maxItems
The maximum number of identities per page. Possible values are 1-1000 inclusive.
SdkInternalList<T> identities
A list of identities.
String nextToken
The token used for pagination.
String identity
The identity that is associated with the policy for which the policies are listed. You can specify an identity by
using its name or by using its Amazon Resource Name (ARN). Examples: [email protected],
example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this operation, you must own the identity.
SdkInternalList<T> policyNames
A list of names of policies that apply to the specified identity.
SdkInternalList<T> filters
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.
String nextToken
A token returned from a previous call to ListReceiptRuleSets to indicate the position in the receipt
rule set list.
SdkInternalList<T> ruleSets
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.
String nextToken
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.
String nextToken
A token returned from a previous call to ListTemplates to indicate the position in the list of email
templates.
Integer maxItems
The maximum number of templates to return. This value must be at least 1 and less than or equal to 100. If more than 100 items are requested, the page size will automatically set to 100. If you do not specify a value, 10 is the default page size.
SdkInternalList<T> templatesMetadata
An array the contains the name and creation time stamp for each template in your Amazon SES account.
String nextToken
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 set of email templates within your page size.
SdkInternalList<T> verifiedEmailAddresses
A list of email addresses that have been verified.
String 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.
Date arrivalDate
When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.
SdkInternalList<T> extensionFields
Additional X-headers to include in the DSN.
String name
The name of the tag. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain 256 characters or fewer.
String value
The value of the tag. The value must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain 256 characters or fewer.
String templateName
String configurationSetName
The name of the configuration set.
DeliveryOptions deliveryOptions
Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
String identity
The identity to which that the policy applies. You can specify an identity by using its name or by using its
Amazon Resource Name (ARN). Examples: [email protected], example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this operation, you must own the identity.
String policyName
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
String policy
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.
ByteBuffer 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 Amazon Web Services 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.
S3Action s3Action
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
BounceAction 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).
WorkmailAction workmailAction
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.
LambdaAction lambdaAction
Calls an Amazon Web Services Lambda function, and optionally, publishes a notification to Amazon SNS.
StopAction stopAction
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
AddHeaderAction addHeaderAction
Adds a header to the received email.
SNSAction sNSAction
Publishes the email content within a notification to Amazon SNS.
String name
The name of the IP address filter. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain 64 characters or fewer.
ReceiptIpFilter ipFilter
A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.
String policy
Indicates whether to block or allow incoming mail from the specified IP addresses.
String cidr
A single IP address or a range of IP addresses 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.
String name
The name of the receipt rule. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.).
Start and end with a letter or number.
Contain 64 characters or fewer.
Boolean enabled
If true, the receipt rule is active. The default value is false.
String 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 bounces emails that
are not received over TLS. The default is Optional.
SdkInternalList<T> recipients
The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.
SdkInternalList<T> 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.
Boolean scanEnabled
If true, then messages that this receipt rule applies to are scanned for spam and viruses. The
default value is false.
String name
The name of the receipt rule set. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain 64 characters or fewer.
Date createdTimestamp
The date and time the receipt rule set was created.
String finalRecipient
The email address that the message was ultimately delivered to. This corresponds to the
Final-Recipient in the DSN. If not specified, FinalRecipient is 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.
String 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.
String 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.
String status
The status code that indicates what went wrong. This is required by RFC 3464.
String diagnosticCode
An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.
Date lastAttemptDate
The time the final delivery attempt was made, in RFC 822 date-time format.
SdkInternalList<T> extensionFields
Additional X-headers to include in the DSN.
String ruleSetName
The name of the receipt rule set to reorder.
SdkInternalList<T> ruleNames
The specified receipt rule set's receipt rules, in order.
Boolean sendingEnabled
Describes whether email sending is enabled or disabled for the configuration set. If the value is
true, then Amazon SES sends emails that use the configuration set. If the value is
false, Amazon SES does not send emails that use the configuration set. The default value is
true. You can change this setting using UpdateConfigurationSetSendingEnabled.
Boolean 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.
Date 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.
String name
Indicates that the named receipt rule does not exist.
String name
Indicates that the named receipt rule set does not exist.
String topicArn
The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
String bucketName
The name of the Amazon S3 bucket for incoming email.
String 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.
String 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 that you created in Amazon Web Services 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 Amazon Web
Services 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 that you created in Amazon Web Services 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 Amazon Web Services KMS Developer Guide. If you do not specify a master key, Amazon SES does 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 Amazon Web Services KMS keys for decryption. This encryption client is currently available with the Amazon Web Services SDK for Java and Amazon Web Services SDK for Ruby only. For more information about client-side encryption using Amazon Web Services KMS master keys, see the Amazon S3 Developer Guide.
String originalMessageId
The message ID of the message to be bounced.
String bounceSender
The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.
String explanation
Human-readable text for the bounce message to explain the failure. If not specified, the text is auto-generated based on the bounced recipient information.
MessageDsn messageDsn
Message-related DSN fields. If not specified, Amazon SES chooses the values.
SdkInternalList<T> bouncedRecipientInfoList
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.
String bounceSenderArn
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.
String messageId
The message ID of the bounce message.
String 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 email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
String sourceArn
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 [email protected], then you would specify the SourceArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be
[email protected].
For more information about sending authorization, see the Amazon SES Developer Guide.
SdkInternalList<T> replyToAddresses
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
String returnPath
The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the
message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this
message is 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.
String returnPathArn
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 [email protected], then you would specify the ReturnPathArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be
[email protected].
For more information about sending authorization, see the Amazon SES Developer Guide.
String configurationSetName
The name of the configuration set to use when you send an email using SendBulkTemplatedEmail.
SdkInternalList<T> defaultTags
A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using
SendBulkTemplatedEmail.
String template
The template to use when sending this email.
String templateArn
The ARN of the template to use when sending this email.
String defaultTemplateData
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.
SdkInternalList<T> destinations
One or more Destination objects. All of the recipients in a Destination receive the
same version of the email. You can specify up to 50 Destination objects within a
Destinations array.
SdkInternalList<T> status
One object per intended recipient. Check each response object and retry any messages with a failure status. (Note that order of responses will be respective to order of destinations in the request.)Receipt rules enable you to specify which actions
String emailAddress
The email address to verify.
String templateName
The name of the custom verification email template to use when sending the verification email.
String configurationSetName
Name of a configuration set to use when sending the verification email.
String messageId
The unique message identifier returned from the SendCustomVerificationEmail operation.
Date timestamp
Time of the data point.
Long deliveryAttempts
Number of emails that have been sent.
Long bounces
Number of emails that have bounced.
Long complaints
Number of unwanted emails that were rejected by recipients.
Long rejects
Number of emails rejected by Amazon SES.
String 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 email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
Destination destination
The destination for this email, composed of To:, CC:, and BCC: fields.
Message message
The message to be sent.
SdkInternalList<T> replyToAddresses
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
String returnPath
The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the
message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this
message is 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.
String sourceArn
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 [email protected], then you would specify the SourceArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be
[email protected].
For more information about sending authorization, see the Amazon SES Developer Guide.
String returnPathArn
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 [email protected], then you would specify the ReturnPathArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be
[email protected].
For more information about sending authorization, see the Amazon SES Developer Guide.
SdkInternalList<T> tags
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.
String configurationSetName
The name of the configuration set to use when you send an email using SendEmail.
String messageId
The unique message identifier returned from the SendEmail action.
String 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 email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
If you specify the Source parameter and have feedback forwarding enabled, then bounces and
complaints are sent to this email address. This takes precedence over any Return-Path header that you might
include in the raw text of the message.
SdkInternalList<T> destinations
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
RawMessage rawMessage
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.
String fromArn
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.
String sourceArn
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 [email protected], then you would specify the SourceArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be
[email protected].
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.
String returnPathArn
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 [email protected], then you would specify the ReturnPathArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be
[email protected].
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.
SdkInternalList<T> tags
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.
String configurationSetName
The name of the configuration set to use when you send an email using SendRawEmail.
String messageId
The unique message identifier returned from the SendRawEmail action.
String 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 email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
Destination destination
The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.
SdkInternalList<T> replyToAddresses
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
String returnPath
The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the
message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this
message is 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.
String sourceArn
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 [email protected], then you would specify the SourceArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be
[email protected].
For more information about sending authorization, see the Amazon SES Developer Guide.
String returnPathArn
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 [email protected], then you would specify the ReturnPathArn to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be
[email protected].
For more information about sending authorization, see the Amazon SES Developer Guide.
SdkInternalList<T> tags
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.
String configurationSetName
The name of the configuration set to use when you send an email using SendTemplatedEmail.
String template
The template to use when sending this email.
String templateArn
The ARN of the template to use when sending this email.
String templateData
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.
String messageId
The unique message identifier returned from the SendTemplatedEmail action.
String ruleSetName
The name of the receipt rule set to make active. Setting this value to null disables all email receiving.
String identity
The identity for which to set bounce and complaint notification forwarding. Examples:
[email protected], example.com.
Boolean forwardingEnabled
Sets whether Amazon SES forwards bounce and complaint notifications as email. true specifies that
Amazon SES forwards bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing
otherwise specified. false specifies that Amazon SES publishes 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.
String identity
The identity for which to enable or disable headers in notifications. Examples: [email protected],
example.com.
String notificationType
The notification type for which to enable or disable headers in notifications.
Boolean enabled
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 includes headers in notifications, and
a value of false specifies that Amazon SES does not include headers in notifications.
This value can only be set when NotificationType is already set to use a particular Amazon SNS
topic.
String identity
The verified identity.
String mailFromDomain
The custom MAIL FROM domain for 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.
String behaviorOnMXFailure
The action for Amazon SES to take if it cannot successfully read the required MX record when you send an email.
If you choose UseDefaultValue, Amazon SES uses amazonses.com (or a subdomain of that) as the MAIL
FROM domain. If you choose RejectMessage, Amazon SES returns 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.
String identity
The identity (email address or domain) for the Amazon SNS topic.
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: [email protected], example.com,
arn:aws:ses:us-east-1:123456789012:identity/example.com.
String notificationType
The type of notifications that are published to the specified Amazon SNS topic.
String snsTopic
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.
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
String 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.
String topicARN
The ARN of the Amazon SNS topic for email sending events. You can find the ARN of a topic by using the ListTopics Amazon SNS operation.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
String scope
The scope of the StopAction. The only acceptable value is RuleSet.
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. You can find the ARN of a topic by using the ListTopics Amazon SNS operation.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
String templateName
The name of the template. You use this name when you send email using the SendTemplatedEmail or
SendBulkTemplatedEmail operations.
String subjectPart
The subject line of the email.
String textPart
The email body that is visible to recipients whose email clients do not display HTML content.
String htmlPart
The HTML body of the email.
String templateName
String templateName
The name of the template to render.
String templateData
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.
String renderedTemplate
The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.
String customRedirectDomain
The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.
String configurationSetName
Indicates that a TrackingOptions object already exists in the specified configuration set.
String configurationSetName
Indicates that a TrackingOptions object does not exist in the specified configuration set.
Boolean enabled
Describes whether email sending is enabled or disabled for your Amazon SES account in the current Amazon Web Services Region.
String configurationSetName
The name of the configuration set that contains the event destination.
EventDestination eventDestination
The event destination object.
String configurationSetName
The name of the configuration set.
TrackingOptions trackingOptions
String templateName
The name of the custom verification email template to update.
String fromEmailAddress
The email address that the custom verification email is sent from.
String templateSubject
The subject line of the custom verification email.
String templateContent
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.
String successRedirectionURL
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
String failureRedirectionURL
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
String ruleSetName
The name of the receipt rule set that the receipt rule belongs to.
ReceiptRule rule
A data structure that contains the updated receipt rule information.
Template template
String domain
The name of the domain to be verified for Easy DKIM signing.
SdkInternalList<T> dkimTokens
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.
String domain
The domain to be verified.
String verificationToken
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, to verify the domain, you must restart the verification process from the beginning. The domain's verification status also changes to "Success" when it is DKIM verified.
String emailAddress
The email address to be verified.
String emailAddress
The email address to be verified.
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
String organizationArn
The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format:
arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId>
You can find the ID of your organization by using the ListOrganizations
operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "m-", followed by a string
of alphanumeric characters.
For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.
Copyright © 2023. All rights reserved.