Module types 

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that MailManager can respond with.

Structs

AddHeaderAction

The action to add a header to a message. When executed, this action will add the given header to the message.

AddonInstance

An Add On instance represents a specific configuration of an Add On.

AddonSubscription

A subscription for an Add On representing the acceptance of its terms of use and additional pricing.

AddressFilter

Filtering options for ListMembersOfAddressList operation.

AddressList

An address list contains a list of emails and domains that are used in MailManager Ingress endpoints and Rules for email management.

Analysis

The result of an analysis can be used in conditions to trigger actions. Analyses can inspect the email content and report a certain aspect of the email.

Archive

An archive resource for storing and retaining emails.

ArchiveAction

The action to archive the email by delivering the email to an Amazon SES archive.

ArchiveBooleanExpression

A boolean expression to evaluate email attribute values.

ArchiveFilters

A set of filter conditions to include and/or exclude emails.

ArchiveStringExpression

A string expression to evaluate an email attribute value against one or more string values.

DeliverToMailboxAction

This action to delivers an email to a mailbox.

DeliverToQBusinessAction

The action to deliver incoming emails to an Amazon Q Business application for indexing.

DropAction

This action causes processing to stop and the email to be dropped. If the action applies only to certain recipients, only those recipients are dropped, and processing continues for other recipients.

Envelope

The SMTP envelope information of the email.

ExportStatus

The current status of an archive export job.

ExportSummary

Summary statuses of an archive export job.

ImportDataFormat

The import data format contains the specifications of the input file that would be passed to the address list import job.

ImportJob

Details about an import job.

IngressAnalysis

The Add On ARN and its returned value that is evaluated in a policy statement's conditional expression to either deny or block the incoming email.

IngressBooleanExpression

The structure for a boolean condition matching on the incoming mail.

IngressIpv4Expression

The union type representing the allowed types for the left hand side of an IP condition.

IngressIpv6Expression

The union type representing the allowed types for the left hand side of an IPv6 condition.

IngressIsInAddressList

The address lists and the address list attribute value that is evaluated in a policy statement's conditional expression to either deny or block the incoming email.

IngressPoint

The structure of an ingress endpoint resource.

IngressPointAuthConfiguration

The authentication configuration for the ingress endpoint resource.

IngressPointPasswordConfiguration

The password configuration of the ingress endpoint resource.

IngressStringExpression

The structure for a string based condition matching on the incoming mail.

IngressTlsProtocolExpression

The structure for a TLS related condition matching on the incoming mail.

MessageBody

The textual body content of an email message.

Metadata

The metadata about the email.

NoAuthentication

Explicitly indicate that the relay destination server does not require SMTP credential authentication.

PolicyStatement

The structure containing traffic policy conditions and actions.

PrivateNetworkConfiguration

Specifies the network configuration for the private ingress point.

PublicNetworkConfiguration

Specifies the network configuration for the public ingress point.

Relay

The relay resource that can be used as a rule to relay receiving emails to the destination relay server.

RelayAction

The action relays the email via SMTP to another specific SMTP server.

ReplaceRecipientAction

This action replaces the email envelope recipients with the given list of recipients. If the condition of this action applies only to a subset of recipients, only those recipients are replaced with the recipients specified in the action. The message contents and headers are unaffected by this action, only the envelope recipients are updated.

Row

A result row containing metadata for an archived email message.

Rule

A rule contains conditions, "unless conditions" and actions. For each envelope recipient of an email, if all conditions match and none of the "unless conditions" match, then all of the actions are executed sequentially. If no conditions are provided, the rule always applies and the actions are implicitly executed. If only "unless conditions" are provided, the rule applies if the email does not match the evaluation of the "unless conditions".

RuleBooleanExpression

A boolean expression to be used in a rule condition.

RuleDmarcExpression

A DMARC policy expression. The condition matches if the given DMARC policy matches that of the incoming email.

RuleIpExpression

An IP address expression matching certain IP addresses within a given range of IP addresses.

RuleIsInAddressList

The structure type for a boolean condition that provides the address lists and address list attribute to evaluate.

RuleNumberExpression

A number expression to match numeric conditions with integers from the incoming email.

RuleSet

A rule set contains a list of rules that are evaluated in order. Each rule is evaluated sequentially for each email.

RuleStringExpression

A string expression is evaluated against strings or substrings of the email.

RuleVerdictExpression

A verdict expression is evaluated against verdicts of the email.

S3Action

Writes the MIME content of the email to an S3 bucket.

S3ExportDestinationConfiguration

The configuration for exporting email data to an Amazon S3 bucket.

SavedAddress

An address that is a member of an address list.

SearchStatus

The current status of an archive search job.

SearchSummary

Summary details of an archive search job.

SendAction

Sends the email to the internet using the ses:SendRawEmail API.

SnsAction

The action to publish the email content to an Amazon SNS topic. When executed, this action will send the email as a notification to the specified SNS topic.

Tag

A key-value pair (the value is optional), that you can define and assign to Amazon Web Services resources.

TrafficPolicy

The structure of a traffic policy resource which is a container for policy statements.

Enums

AcceptAction

When writing a match expression against AcceptAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ActionFailurePolicy

When writing a match expression against ActionFailurePolicy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ArchiveBooleanEmailAttribute

When writing a match expression against ArchiveBooleanEmailAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ArchiveBooleanOperator

When writing a match expression against ArchiveBooleanOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ArchiveBooleanToEvaluate

The attribute to evaluate in a boolean expression.

ArchiveFilterCondition

A filter condition used to include or exclude emails when exporting from or searching an archive.

ArchiveRetention

The retention policy for an email archive that specifies how long emails are kept before being automatically deleted.

ArchiveState

When writing a match expression against ArchiveState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ArchiveStringEmailAttribute

When writing a match expression against ArchiveStringEmailAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ArchiveStringOperator

When writing a match expression against ArchiveStringOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ArchiveStringToEvaluate

Specifies the email attribute to evaluate in a string expression.

ExportDestinationConfiguration

The destination configuration for delivering exported email data.

ExportState

When writing a match expression against ExportState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ImportDataType

When writing a match expression against ImportDataType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ImportJobStatus

When writing a match expression against ImportJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IngressAddressListEmailAttribute

When writing a match expression against IngressAddressListEmailAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IngressBooleanOperator

When writing a match expression against IngressBooleanOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IngressBooleanToEvaluate

The union type representing the allowed types of operands for a boolean condition.

IngressIpOperator

When writing a match expression against IngressIpOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IngressIpToEvaluate

The structure for an IP based condition matching on the incoming mail.

IngressIpv4Attribute

When writing a match expression against IngressIpv4Attribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IngressIpv6Attribute

When writing a match expression against IngressIpv6Attribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IngressIpv6ToEvaluate

The structure for an IPv6 based condition matching on the incoming mail.

IngressPointConfiguration

The configuration of the ingress endpoint resource.

IngressPointStatus

When writing a match expression against IngressPointStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IngressPointStatusToUpdate

When writing a match expression against IngressPointStatusToUpdate, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IngressPointType

When writing a match expression against IngressPointType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IngressStringEmailAttribute

When writing a match expression against IngressStringEmailAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IngressStringOperator

When writing a match expression against IngressStringOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IngressStringToEvaluate

The union type representing the allowed types for the left hand side of a string condition.

IngressTlsAttribute

When writing a match expression against IngressTlsAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IngressTlsProtocolAttribute

When writing a match expression against IngressTlsProtocolAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IngressTlsProtocolOperator

When writing a match expression against IngressTlsProtocolOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IngressTlsProtocolToEvaluate

The union type representing the allowed types for the left hand side of a TLS condition.

IpType

When writing a match expression against IpType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MailFrom

When writing a match expression against MailFrom, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

NetworkConfiguration

The network type (IPv4-only, Dual-Stack, PrivateLink) of the ingress endpoint resource.

PolicyCondition

The email traffic filtering conditions which are contained in a traffic policy resource.

RelayAuthentication

Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored, or specify an empty NoAuthentication structure if the relay destination server does not require SMTP credential authentication.

RetentionPeriod

When writing a match expression against RetentionPeriod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RuleAction

The action for a rule to take. Only one of the contained actions can be set.

RuleAddressListEmailAttribute

When writing a match expression against RuleAddressListEmailAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RuleBooleanEmailAttribute

When writing a match expression against RuleBooleanEmailAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RuleBooleanOperator

When writing a match expression against RuleBooleanOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RuleBooleanToEvaluate

The union type representing the allowed types of operands for a boolean condition.

RuleCondition

The conditional expression used to evaluate an email for determining if a rule action should be taken.

RuleDmarcOperator

When writing a match expression against RuleDmarcOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RuleDmarcPolicy

When writing a match expression against RuleDmarcPolicy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RuleIpEmailAttribute

When writing a match expression against RuleIpEmailAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RuleIpOperator

When writing a match expression against RuleIpOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RuleIpToEvaluate

The IP address to evaluate for this condition.

RuleNumberEmailAttribute

When writing a match expression against RuleNumberEmailAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RuleNumberOperator

When writing a match expression against RuleNumberOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RuleNumberToEvaluate

The number to evaluate in a numeric condition expression.

RuleStringEmailAttribute

When writing a match expression against RuleStringEmailAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RuleStringOperator

When writing a match expression against RuleStringOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RuleStringToEvaluate

The string to evaluate in a string condition expression.

RuleVerdict

When writing a match expression against RuleVerdict, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RuleVerdictAttribute

When writing a match expression against RuleVerdictAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RuleVerdictOperator

When writing a match expression against RuleVerdictOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RuleVerdictToEvaluate

The verdict to evaluate in a verdict condition expression.

SearchState

When writing a match expression against SearchState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SnsNotificationEncoding

When writing a match expression against SnsNotificationEncoding, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SnsNotificationPayloadType

When writing a match expression against SnsNotificationPayloadType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.