IdentityVerificationAttributes
Represents the verification attributes of a single identity.
Contents
VerificationStatus
The verification status of the identity: "Pending", "Success", "Failed", or "TemporaryFailure".
Type: String
Valid Values: Pending | Success | Failed | TemporaryFailure | NotStarted Required: Yes
VerificationToken
The verification token for a domain identity. Null for email address identities.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
KinesisFirehoseDestination
KinesisFirehoseDestination
Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
Event destinations, such as Amazon Kinesis Firehose, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
Contents
DeliveryStreamARN
The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.
Type: String Required: Yes IAMRoleARN
The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
LambdaAction
LambdaAction
When included in a receipt rule, this action calls an AWS Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
To enable Amazon SES to call your AWS Lambda function or to publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide.
For information about using AWS Lambda actions in receipt rules, see the Amazon SES Developer Guide.
Contents
FunctionArn
The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.
Type: String Required: Yes InvocationType
The invocation type of the AWS 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 AWS Lambda invocation types, see the AWS Lambda Developer Guide.
Important
There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
Type: String
Valid Values: Event | RequestResponse Required: No
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.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
See Also
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Message
Message
Represents the message to be sent, composed of a subject and a body.
Contents
Body
The message body.
Type: Body (p. 137) object Required: Yes
Subject
The subject of the message: A short summary of the content, which appears in the recipient's inbox.
Type: Content (p. 148) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
MessageDsn
MessageDsn
Message-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
Contents
ArrivalDate
When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.
Type: Timestamp Required: No
ExtensionFields.member.N
Additional X-headers to include in the DSN.
Type: Array of ExtensionField (p. 154) objects Required: No
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.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
MessageTag
MessageTag
Contains the name and value of a tag that you can provide to SendEmail or SendRawEmail to apply to an email.
Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
Contents
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.
Type: String Required: Yes 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.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
RawMessage
RawMessage
Represents the raw data of the message.
Contents
Data
The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding.
The To:, CC:, and BCC: headers in the raw message can contain a group list.
If you are using SendRawEmail with sending authorization, you can include X-headers in the raw message to specify the "Source," "From," and "Return-Path" addresses. For more information, see the documentation for SendRawEmail.
Important
Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.
For more information, go to the Amazon SES Developer Guide.
Type: Base64-encoded binary data object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ReceiptAction
ReceiptAction
An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
Contents
AddHeaderAction
Adds a header to the received email.
Type: AddHeaderAction (p. 136) object Required: No
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).
Type: BounceAction (p. 138) object Required: No
LambdaAction
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
Type: LambdaAction (p. 161) object Required: No
S3Action
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
Type: S3Action (p. 177) object Required: No
SNSAction
Publishes the email content within a notification to Amazon SNS.
Type: SNSAction (p. 180) object Required: No
StopAction
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
Type: StopAction (p. 182) object Required: No
WorkmailAction
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.
See Also
Type: WorkmailAction (p. 186) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ReceiptFilter
ReceiptFilter
A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.
For information about setting up IP address filters, see the Amazon SES Developer Guide.
Contents
IpFilter
A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.
Type: ReceiptIpFilter (p. 170) object Required: Yes
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.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ReceiptIpFilter
ReceiptIpFilter
A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.
For information about setting up IP address filters, see the Amazon SES Developer Guide.
Contents
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.
Type: String Required: Yes Policy
Indicates whether to block or allow incoming mail from the specified IP addresses.
Type: String
Valid Values: Block | Allow Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ReceiptRule
ReceiptRule
Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.
Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
Contents
Actions.member.N
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.
Type: Array of ReceiptAction (p. 167) objects Required: No
Enabled
If true, the receipt rule is active. The default value is false.
Type: Boolean Required: No 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 (_), or dashes (-).
• Start and end with a letter or number.
• Contain 64 characters or fewer.
Type: String Required: Yes Recipients.member.N
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.
Type: Array of strings Required: No
ScanEnabled
If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.
Type: Boolean Required: No
See Also
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.
Type: String
Valid Values: Require | Optional Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ReceiptRuleSetMetadata
ReceiptRuleSetMetadata
Information about a receipt rule set.
A receipt rule set is a collection of rules that specify what Amazon SES should do with mail it receives on behalf of your account's verified domains.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
Contents
CreatedTimestamp
The date and time the receipt rule set was created.
Type: Timestamp Required: No 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.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
RecipientDsnFields
RecipientDsnFields
Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
Contents
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.
Type: String
Valid Values: failed | delayed | delivered | relayed | expanded Required: Yes
DiagnosticCode
An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.
Type: String Required: No
ExtensionFields.member.N
Additional X-headers to include in the DSN.
Type: Array of ExtensionField (p. 154) objects Required: No
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.
NoteDo not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.
Type: String Required: No LastAttemptDate
The time the final delivery attempt was made, in RFC 822 date-time format.
Type: Timestamp Required: No 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.
See Also
Type: String Required: No Status
The status code that indicates what went wrong. This is required by RFC 3464.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ReputationOptions
ReputationOptions
Contains information about the reputation settings for a configuration set.
Contents
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 (p. 119) 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.
Type: Timestamp Required: No
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.
Type: Boolean Required: No 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 (p. 119).
Type: Boolean Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
S3Action
S3Action
When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
To enable Amazon SES to write emails to your Amazon S3 bucket, use an AWS KMS key to encrypt your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about granting permissions, see the Amazon SES Developer Guide.
Note
When you save your emails to an Amazon S3 bucket, the maximum email size (including headers) is 30 MB. Emails larger than that bounces.
For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide.
Contents
BucketName
The name of the Amazon S3 bucket for incoming email.
Type: String Required: Yes 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 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 that 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 does not encrypt your emails.
Important
Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS 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.
Type: String Required: No
See Also
ObjectKeyPrefix
The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables
The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables