# frozen_string_literal: true
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
module Aws::SES
module Types
# Indicates that email sending is disabled for your entire Amazon SES
# account.
#
# You can enable or disable email sending for your Amazon SES account
# using UpdateAccountSendingEnabled.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/AccountSendingPausedException AWS API Documentation
#
class AccountSendingPausedException < Aws::EmptyStructure; end
# When included in a receipt rule, this action adds a header to the
# received email.
#
# For information about adding a header using a receipt rule, see the
# [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-add-header.html
#
# @!attribute [rw] header_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.
# @return [String]
#
# @!attribute [rw] header_value
# Must be less than 2048 characters, and must not contain newline
# characters ("\\r" or "\\n").
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/AddHeaderAction AWS API Documentation
#
class AddHeaderAction < Struct.new(
:header_name,
:header_value)
SENSITIVE = []
include Aws::Structure
end
# Indicates that a resource could not be created because of a naming
# conflict.
#
# @!attribute [rw] name
# Indicates that a resource could not be created because the resource
# name already exists.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/AlreadyExistsException AWS API Documentation
#
class AlreadyExistsException < Struct.new(
:name)
SENSITIVE = []
include Aws::Structure
end
# Represents the body of the message. You can specify text, HTML, or
# both. If you use both, then the message should display correctly in
# the widest variety of email clients.
#
# @!attribute [rw] 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).
# @return [Types::Content]
#
# @!attribute [rw] 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.
# @return [Types::Content]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/Body AWS API Documentation
#
class Body < Struct.new(
:text,
:html)
SENSITIVE = []
include Aws::Structure
end
# When included in a receipt rule, this action rejects the received
# email by returning a bounce response to the sender and, optionally,
# publishes a notification to Amazon Simple Notification Service (Amazon
# SNS).
#
# For information about sending a bounce message in response to a
# received email, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-bounce.html
#
# @!attribute [rw] topic_arn
# The Amazon Resource Name (ARN) of the Amazon SNS topic to notify
# when the bounce action is taken. An example of an Amazon SNS topic
# ARN is `arn:aws:sns:us-west-2:123456789012:MyTopic`. For more
# information about Amazon SNS topics, see the [Amazon SNS Developer
# Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
# @return [String]
#
# @!attribute [rw] smtp_reply_code
# The SMTP reply code, as defined by [RFC 5321][1].
#
#
#
# [1]: https://tools.ietf.org/html/rfc5321
# @return [String]
#
# @!attribute [rw] status_code
# The SMTP enhanced status code, as defined by [RFC 3463][1].
#
#
#
# [1]: https://tools.ietf.org/html/rfc3463
# @return [String]
#
# @!attribute [rw] message
# Human-readable text to include in the bounce message.
# @return [String]
#
# @!attribute [rw] sender
# The email address of the sender of the bounced email. This is the
# address from which the bounce message will be sent.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/BounceAction AWS API Documentation
#
class BounceAction < Struct.new(
:topic_arn,
:smtp_reply_code,
:status_code,
:message,
:sender)
SENSITIVE = []
include Aws::Structure
end
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html
#
# @!attribute [rw] recipient
# The email address of the recipient of the bounced email.
# @return [String]
#
# @!attribute [rw] recipient_arn
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
# @return [String]
#
# @!attribute [rw] bounce_type
# The reason for the bounce. You must provide either this parameter or
# `RecipientDsnFields`.
# @return [String]
#
# @!attribute [rw] recipient_dsn_fields
# 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`.
# @return [Types::RecipientDsnFields]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/BouncedRecipientInfo AWS API Documentation
#
class BouncedRecipientInfo < Struct.new(
:recipient,
:recipient_arn,
:bounce_type,
:recipient_dsn_fields)
SENSITIVE = []
include Aws::Structure
end
# An array that contains one or more Destinations, as well as the tags
# and replacement data associated with each of those Destinations.
#
# @!attribute [rw] destination
# Represents the destination of the message, consisting of To:, CC:,
# and BCC: fields.
#
# <note markdown="1"> Amazon SES does not support the SMTPUTF8 extension, as described in
# [RFC6531][1]. For this reason, the *local part* of a destination
# email address (the part of the email address that precedes the @
# sign) may only contain [7-bit ASCII characters][2]. If the *domain
# part* of an address (the part after the @ sign) contains non-ASCII
# characters, they must be encoded using Punycode, as described in
# [RFC3492][3].
#
# </note>
#
#
#
# [1]: https://tools.ietf.org/html/rfc6531
# [2]: https://en.wikipedia.org/wiki/Email_address#Local-part
# [3]: https://tools.ietf.org/html/rfc3492.html
# @return [Types::Destination]
#
# @!attribute [rw] replacement_tags
# 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.
# @return [Array<Types::MessageTag>]
#
# @!attribute [rw] replacement_template_data
# 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.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/BulkEmailDestination AWS API Documentation
#
class BulkEmailDestination < Struct.new(
:destination,
:replacement_tags,
:replacement_template_data)
SENSITIVE = []
include Aws::Structure
end
# An object that contains the response from the `SendBulkTemplatedEmail`
# operation.
#
# @!attribute [rw] status
# The status of a message sent using the `SendBulkTemplatedEmail`
# operation.
#
# Possible values for this parameter include:
#
# * `Success`: Amazon SES accepted the message, and will attempt to
# deliver it to the recipients.
#
# * `MessageRejected`: The message was rejected because it contained a
# virus.
#
# * `MailFromDomainNotVerified`: The sender's email address or domain
# was not verified.
#
# * `ConfigurationSetDoesNotExist`: The configuration set you
# specified does not exist.
#
# * `TemplateDoesNotExist`: The template you specified does not exist.
#
# * `AccountSuspended`: Your account has been shut down because of
# issues related to your email sending practices.
#
# * `AccountThrottled`: The number of emails you can send has been
# reduced because your account has exceeded its allocated sending
# limit.
#
# * `AccountDailyQuotaExceeded`: You have reached or exceeded the
# maximum number of emails you can send from your account in a
# 24-hour period.
#
# * `InvalidSendingPoolName`: The configuration set you specified
# refers to an IP pool that does not exist.
#
# * `AccountSendingPaused`: Email sending for the Amazon SES account
# was disabled using the UpdateAccountSendingEnabled operation.
#
# * `ConfigurationSetSendingPaused`: Email sending for this
# configuration set was disabled using the
# UpdateConfigurationSetSendingEnabled operation.
#
# * `InvalidParameterValue`: One or more of the parameters you
# specified when calling this operation was invalid. See the error
# message for additional information.
#
# * `TransientFailure`: Amazon SES was unable to process your request
# because of a temporary issue.
#
# * `Failed`: Amazon SES was unable to process your request. See the
# error message for additional information.
# @return [String]
#
# @!attribute [rw] error
# A description of an error that prevented a message being sent using
# the `SendBulkTemplatedEmail` operation.
# @return [String]
#
# @!attribute [rw] message_id
# The unique message identifier returned from the
# `SendBulkTemplatedEmail` operation.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/BulkEmailDestinationStatus AWS API Documentation
#
class BulkEmailDestinationStatus < Struct.new(
:status,
:error,
:message_id)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the delete operation could not be completed.
#
# @!attribute [rw] name
# Indicates that a resource could not be deleted because no resource
# with the specified name exists.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CannotDeleteException AWS API Documentation
#
class CannotDeleteException < Struct.new(
:name)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to create a receipt rule set by cloning an
# existing one. You use receipt rule sets to receive email with Amazon
# SES. For more information, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
#
# @!attribute [rw] rule_set_name
# The name of the rule set to create. The name must:
#
# * This value can only contain ASCII letters (a-z, A-Z), numbers
# (0-9), underscores (\_), or dashes (-).
#
# * Start and end with a letter or number.
#
# * Contain less than 64 characters.
# @return [String]
#
# @!attribute [rw] original_rule_set_name
# The name of the rule set to clone.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CloneReceiptRuleSetRequest AWS API Documentation
#
class CloneReceiptRuleSetRequest < Struct.new(
:rule_set_name,
:original_rule_set_name)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CloneReceiptRuleSetResponse AWS API Documentation
#
class CloneReceiptRuleSetResponse < Aws::EmptyStructure; end
# Contains information associated with an Amazon CloudWatch event
# destination to which email sending events are published.
#
# Event destinations, such as Amazon CloudWatch, are associated with
# configuration sets, which enable you to publish email sending events.
# For information about using configuration sets, see the [Amazon SES
# Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
#
# @!attribute [rw] dimension_configurations
# A list of dimensions upon which to categorize your emails when you
# publish email sending events to Amazon CloudWatch.
# @return [Array<Types::CloudWatchDimensionConfiguration>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CloudWatchDestination AWS API Documentation
#
class CloudWatchDestination < Struct.new(
:dimension_configurations)
SENSITIVE = []
include Aws::Structure
end
# Contains the dimension configuration to use when you publish email
# sending events to Amazon CloudWatch.
#
# For information about publishing email sending events to Amazon
# CloudWatch, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
#
# @!attribute [rw] dimension_name
# The name of an Amazon CloudWatch dimension associated with an email
# sending metric. The name must:
#
# * This value can only contain ASCII letters (a-z, A-Z), numbers
# (0-9), underscores (\_), or dashes (-).
#
# * Contain less than 256 characters.
# @return [String]
#
# @!attribute [rw] dimension_value_source
# The place where Amazon SES finds the value of a dimension to publish
# to Amazon CloudWatch. If you want Amazon SES to use the message tags
# that you specify using an `X-SES-MESSAGE-TAGS` header or a parameter
# to the `SendEmail`/`SendRawEmail` API, choose `messageTag`. If you
# want Amazon SES to use your own email headers, choose `emailHeader`.
# @return [String]
#
# @!attribute [rw] default_dimension_value
# The default value of the dimension that is published to Amazon
# CloudWatch if you do not provide the value of the dimension when you
# send an email. The default value must:
#
# * This value can only contain ASCII letters (a-z, A-Z), numbers
# (0-9), underscores (\_), or dashes (-).
#
# * Contain less than 256 characters.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CloudWatchDimensionConfiguration AWS API Documentation
#
class CloudWatchDimensionConfiguration < Struct.new(
:dimension_name,
:dimension_value_source,
:default_dimension_value)
SENSITIVE = []
include Aws::Structure
end
# The name of the configuration set.
#
# Configuration sets let you create groups of rules that you can apply
# to the emails you send using Amazon SES. For more information about
# using configuration sets, see [Using Amazon SES Configuration Sets][1]
# in the [Amazon SES Developer Guide][2].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/using-configuration-sets.html
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/
#
# @!attribute [rw] 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.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ConfigurationSet AWS API Documentation
#
class ConfigurationSet < Struct.new(
:name)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the configuration set could not be created because of a
# naming conflict.
#
# @!attribute [rw] configuration_set_name
# Indicates that the configuration set does not exist.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ConfigurationSetAlreadyExistsException AWS API Documentation
#
class ConfigurationSetAlreadyExistsException < Struct.new(
:configuration_set_name)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the configuration set does not exist.
#
# @!attribute [rw] configuration_set_name
# Indicates that the configuration set does not exist.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ConfigurationSetDoesNotExistException AWS API Documentation
#
class ConfigurationSetDoesNotExistException < Struct.new(
:configuration_set_name)
SENSITIVE = []
include Aws::Structure
end
# Indicates that email sending is disabled for the configuration set.
#
# You can enable or disable email sending for a configuration set using
# UpdateConfigurationSetSendingEnabled.
#
# @!attribute [rw] configuration_set_name
# The name of the configuration set for which email sending is
# disabled.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ConfigurationSetSendingPausedException AWS API Documentation
#
class ConfigurationSetSendingPausedException < Struct.new(
:configuration_set_name)
SENSITIVE = []
include Aws::Structure
end
# Represents textual data, plus an optional character set specification.
#
# By default, the text must be 7-bit ASCII, due to the constraints of
# the SMTP protocol. If the text must contain any other characters, then
# you must also specify a character set. Examples include UTF-8,
# ISO-8859-1, and Shift\_JIS.
#
# @!attribute [rw] data
# The textual data of the content.
# @return [String]
#
# @!attribute [rw] charset
# The character set of the content.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/Content AWS API Documentation
#
class Content < Struct.new(
:data,
:charset)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to create a configuration set event destination.
# A configuration set event destination, which can be either Amazon
# CloudWatch or Amazon Kinesis Firehose, describes an AWS service in
# which Amazon SES publishes the email sending events associated with a
# configuration set. For information about using configuration sets, see
# the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
#
# @!attribute [rw] configuration_set_name
# The name of the configuration set that the event destination should
# be associated with.
# @return [String]
#
# @!attribute [rw] event_destination
# An object that describes the AWS service that email sending event
# information will be published to.
# @return [Types::EventDestination]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateConfigurationSetEventDestinationRequest AWS API Documentation
#
class CreateConfigurationSetEventDestinationRequest < Struct.new(
:configuration_set_name,
:event_destination)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateConfigurationSetEventDestinationResponse AWS API Documentation
#
class CreateConfigurationSetEventDestinationResponse < Aws::EmptyStructure; end
# Represents a request to create a configuration set. Configuration sets
# enable you to publish email sending events. For information about
# using configuration sets, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
#
# @!attribute [rw] configuration_set
# A data structure that contains the name of the configuration set.
# @return [Types::ConfigurationSet]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateConfigurationSetRequest AWS API Documentation
#
class CreateConfigurationSetRequest < Struct.new(
:configuration_set)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateConfigurationSetResponse AWS API Documentation
#
class CreateConfigurationSetResponse < Aws::EmptyStructure; end
# Represents a request to create an open and click tracking option
# object in a configuration set.
#
# @!attribute [rw] configuration_set_name
# The name of the configuration set that the tracking options should
# be associated with.
# @return [String]
#
# @!attribute [rw] tracking_options
# A domain that is used to redirect email recipients to an Amazon
# SES-operated domain. This domain captures open and click events
# generated by Amazon SES emails.
#
# For more information, see [Configuring Custom Domains to Handle Open
# and Click Tracking][1] in the *Amazon SES Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html
# @return [Types::TrackingOptions]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateConfigurationSetTrackingOptionsRequest AWS API Documentation
#
class CreateConfigurationSetTrackingOptionsRequest < Struct.new(
:configuration_set_name,
:tracking_options)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateConfigurationSetTrackingOptionsResponse AWS API Documentation
#
class CreateConfigurationSetTrackingOptionsResponse < Aws::EmptyStructure; end
# Represents a request to create a custom verification email template.
#
# @!attribute [rw] template_name
# The name of the custom verification email template.
# @return [String]
#
# @!attribute [rw] from_email_address
# The email address that the custom verification email is sent from.
# @return [String]
#
# @!attribute [rw] template_subject
# The subject line of the custom verification email.
# @return [String]
#
# @!attribute [rw] template_content
# 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][1] in the *Amazon SES
# Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq
# @return [String]
#
# @!attribute [rw] success_redirection_url
# The URL that the recipient of the verification email is sent to if
# his or her address is successfully verified.
# @return [String]
#
# @!attribute [rw] failure_redirection_url
# The URL that the recipient of the verification email is sent to if
# his or her address is not successfully verified.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateCustomVerificationEmailTemplateRequest AWS API Documentation
#
class CreateCustomVerificationEmailTemplateRequest < Struct.new(
:template_name,
:from_email_address,
:template_subject,
:template_content,
:success_redirection_url,
:failure_redirection_url)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to create a new IP address filter. You use IP
# address filters when you receive email with Amazon SES. For more
# information, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
#
# @!attribute [rw] 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.
# @return [Types::ReceiptFilter]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateReceiptFilterRequest AWS API Documentation
#
class CreateReceiptFilterRequest < Struct.new(
:filter)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateReceiptFilterResponse AWS API Documentation
#
class CreateReceiptFilterResponse < Aws::EmptyStructure; end
# Represents a request to create a receipt rule. You use receipt rules
# to receive email with Amazon SES. For more information, see the
# [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
#
# @!attribute [rw] rule_set_name
# The name of the rule set that the receipt rule will be added to.
# @return [String]
#
# @!attribute [rw] after
# The name of an existing rule after which the new rule will be
# placed. If this parameter is null, the new rule will be inserted at
# the beginning of the rule list.
# @return [String]
#
# @!attribute [rw] rule
# A data structure that contains the specified rule's name, actions,
# recipients, domains, enabled status, scan status, and TLS policy.
# @return [Types::ReceiptRule]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateReceiptRuleRequest AWS API Documentation
#
class CreateReceiptRuleRequest < Struct.new(
:rule_set_name,
:after,
:rule)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateReceiptRuleResponse AWS API Documentation
#
class CreateReceiptRuleResponse < Aws::EmptyStructure; end
# Represents a request to create an empty receipt rule set. You use
# receipt rule sets to receive email with Amazon SES. For more
# information, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
#
# @!attribute [rw] rule_set_name
# The name of the rule set to create. The name must:
#
# * This value can only contain ASCII letters (a-z, A-Z), numbers
# (0-9), underscores (\_), or dashes (-).
#
# * Start and end with a letter or number.
#
# * Contain less than 64 characters.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateReceiptRuleSetRequest AWS API Documentation
#
class CreateReceiptRuleSetRequest < Struct.new(
:rule_set_name)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateReceiptRuleSetResponse AWS API Documentation
#
class CreateReceiptRuleSetResponse < Aws::EmptyStructure; end
# Represents a request to create an email template. For more
# information, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
#
# @!attribute [rw] template
# The content of the email, composed of a subject line, an HTML part,
# and a text-only part.
# @return [Types::Template]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateTemplateRequest AWS API Documentation
#
class CreateTemplateRequest < Struct.new(
:template)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CreateTemplateResponse AWS API Documentation
#
class CreateTemplateResponse < Aws::EmptyStructure; end
# Indicates that custom verification email template provided content is
# invalid.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CustomVerificationEmailInvalidContentException AWS API Documentation
#
class CustomVerificationEmailInvalidContentException < Aws::EmptyStructure; end
# Contains information about a custom verification email template.
#
# @!attribute [rw] template_name
# The name of the custom verification email template.
# @return [String]
#
# @!attribute [rw] from_email_address
# The email address that the custom verification email is sent from.
# @return [String]
#
# @!attribute [rw] template_subject
# The subject line of the custom verification email.
# @return [String]
#
# @!attribute [rw] success_redirection_url
# The URL that the recipient of the verification email is sent to if
# his or her address is successfully verified.
# @return [String]
#
# @!attribute [rw] failure_redirection_url
# The URL that the recipient of the verification email is sent to if
# his or her address is not successfully verified.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CustomVerificationEmailTemplate AWS API Documentation
#
class CustomVerificationEmailTemplate < Struct.new(
:template_name,
:from_email_address,
:template_subject,
:success_redirection_url,
:failure_redirection_url)
SENSITIVE = []
include Aws::Structure
end
# Indicates that a custom verification email template with the name you
# specified already exists.
#
# @!attribute [rw] custom_verification_email_template_name
# Indicates that the provided custom verification email template with
# the specified template name already exists.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CustomVerificationEmailTemplateAlreadyExistsException AWS API Documentation
#
class CustomVerificationEmailTemplateAlreadyExistsException < Struct.new(
:custom_verification_email_template_name)
SENSITIVE = []
include Aws::Structure
end
# Indicates that a custom verification email template with the name you
# specified does not exist.
#
# @!attribute [rw] custom_verification_email_template_name
# Indicates that the provided custom verification email template does
# not exist.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/CustomVerificationEmailTemplateDoesNotExistException AWS API Documentation
#
class CustomVerificationEmailTemplateDoesNotExistException < Struct.new(
:custom_verification_email_template_name)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to delete a configuration set event destination.
# Configuration set event destinations 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
#
# @!attribute [rw] configuration_set_name
# The name of the configuration set from which to delete the event
# destination.
# @return [String]
#
# @!attribute [rw] event_destination_name
# The name of the event destination to delete.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteConfigurationSetEventDestinationRequest AWS API Documentation
#
class DeleteConfigurationSetEventDestinationRequest < Struct.new(
:configuration_set_name,
:event_destination_name)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteConfigurationSetEventDestinationResponse AWS API Documentation
#
class DeleteConfigurationSetEventDestinationResponse < Aws::EmptyStructure; end
# Represents a request to delete a configuration set. Configuration sets
# enable you to publish email sending events. For information about
# using configuration sets, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
#
# @!attribute [rw] configuration_set_name
# The name of the configuration set to delete.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteConfigurationSetRequest AWS API Documentation
#
class DeleteConfigurationSetRequest < Struct.new(
:configuration_set_name)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteConfigurationSetResponse AWS API Documentation
#
class DeleteConfigurationSetResponse < Aws::EmptyStructure; end
# Represents a request to delete open and click tracking options in a
# configuration set.
#
# @!attribute [rw] configuration_set_name
# The name of the configuration set from which you want to delete the
# tracking options.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteConfigurationSetTrackingOptionsRequest AWS API Documentation
#
class DeleteConfigurationSetTrackingOptionsRequest < Struct.new(
:configuration_set_name)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteConfigurationSetTrackingOptionsResponse AWS API Documentation
#
class DeleteConfigurationSetTrackingOptionsResponse < Aws::EmptyStructure; end
# Represents a request to delete an existing custom verification email
# template.
#
# @!attribute [rw] template_name
# The name of the custom verification email template that you want to
# delete.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteCustomVerificationEmailTemplateRequest AWS API Documentation
#
class DeleteCustomVerificationEmailTemplateRequest < Struct.new(
:template_name)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to delete a sending authorization policy for an
# identity. Sending authorization is an Amazon SES feature that enables
# you to authorize other senders to use your identities. For
# information, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
#
# @!attribute [rw] identity
# The identity that is associated with the policy that you want to
# delete. You can specify the identity by using its name or by using
# its Amazon Resource Name (ARN). Examples: `user@example.com`,
# `example.com`,
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`.
#
# To successfully call this API, you must own the identity.
# @return [String]
#
# @!attribute [rw] policy_name
# The name of the policy to be deleted.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteIdentityPolicyRequest AWS API Documentation
#
class DeleteIdentityPolicyRequest < Struct.new(
:identity,
:policy_name)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteIdentityPolicyResponse AWS API Documentation
#
class DeleteIdentityPolicyResponse < Aws::EmptyStructure; end
# Represents a request to delete one of your Amazon SES identities (an
# email address or domain).
#
# @!attribute [rw] identity
# The identity to be removed from the list of identities for the AWS
# Account.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteIdentityRequest AWS API Documentation
#
class DeleteIdentityRequest < Struct.new(
:identity)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteIdentityResponse AWS API Documentation
#
class DeleteIdentityResponse < Aws::EmptyStructure; end
# Represents a request to delete an IP address filter. You use IP
# address filters when you receive email with Amazon SES. For more
# information, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
#
# @!attribute [rw] filter_name
# The name of the IP address filter to delete.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteReceiptFilterRequest AWS API Documentation
#
class DeleteReceiptFilterRequest < Struct.new(
:filter_name)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteReceiptFilterResponse AWS API Documentation
#
class DeleteReceiptFilterResponse < Aws::EmptyStructure; end
# Represents a request to delete a receipt rule. You use receipt rules
# to receive email with Amazon SES. For more information, see the
# [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
#
# @!attribute [rw] rule_set_name
# The name of the receipt rule set that contains the receipt rule to
# delete.
# @return [String]
#
# @!attribute [rw] rule_name
# The name of the receipt rule to delete.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteReceiptRuleRequest AWS API Documentation
#
class DeleteReceiptRuleRequest < Struct.new(
:rule_set_name,
:rule_name)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteReceiptRuleResponse AWS API Documentation
#
class DeleteReceiptRuleResponse < Aws::EmptyStructure; end
# Represents a request to delete a receipt rule set and all of the
# receipt rules it contains. You use receipt rule sets to receive email
# with Amazon SES. For more information, see the [Amazon SES Developer
# Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
#
# @!attribute [rw] rule_set_name
# The name of the receipt rule set to delete.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteReceiptRuleSetRequest AWS API Documentation
#
class DeleteReceiptRuleSetRequest < Struct.new(
:rule_set_name)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteReceiptRuleSetResponse AWS API Documentation
#
class DeleteReceiptRuleSetResponse < Aws::EmptyStructure; end
# Represents a request to delete an email template. For more
# information, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
#
# @!attribute [rw] template_name
# The name of the template to be deleted.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteTemplateRequest AWS API Documentation
#
class DeleteTemplateRequest < Struct.new(
:template_name)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteTemplateResponse AWS API Documentation
#
class DeleteTemplateResponse < Aws::EmptyStructure; end
# Represents a request to delete an email address from the list of email
# addresses you have attempted to verify under your AWS account.
#
# @!attribute [rw] email_address
# An email address to be removed from the list of verified addresses.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeleteVerifiedEmailAddressRequest AWS API Documentation
#
class DeleteVerifiedEmailAddressRequest < Struct.new(
:email_address)
SENSITIVE = []
include Aws::Structure
end
# Specifies whether messages that use the configuration set are required
# to use Transport Layer Security (TLS).
#
# @!attribute [rw] tls_policy
# 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.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DeliveryOptions AWS API Documentation
#
class DeliveryOptions < Struct.new(
:tls_policy)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to return the metadata and receipt rules for the
# receipt rule set that is currently active. You use receipt rule sets
# to receive email with Amazon SES. For more information, see the
# [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
#
# @api private
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DescribeActiveReceiptRuleSetRequest AWS API Documentation
#
class DescribeActiveReceiptRuleSetRequest < Aws::EmptyStructure; end
# Represents the metadata and receipt rules for the receipt rule set
# that is currently active.
#
# @!attribute [rw] 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.
# @return [Types::ReceiptRuleSetMetadata]
#
# @!attribute [rw] rules
# The receipt rules that belong to the active rule set.
# @return [Array<Types::ReceiptRule>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DescribeActiveReceiptRuleSetResponse AWS API Documentation
#
class DescribeActiveReceiptRuleSetResponse < Struct.new(
:metadata,
:rules)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to return the details of a configuration set.
# Configuration sets enable you to publish email sending events. For
# information about using configuration sets, see the [Amazon SES
# Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
#
# @!attribute [rw] configuration_set_name
# The name of the configuration set to describe.
# @return [String]
#
# @!attribute [rw] configuration_set_attribute_names
# A list of configuration set attributes to return.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DescribeConfigurationSetRequest AWS API Documentation
#
class DescribeConfigurationSetRequest < Struct.new(
:configuration_set_name,
:configuration_set_attribute_names)
SENSITIVE = []
include Aws::Structure
end
# Represents the details of a configuration set. Configuration sets
# enable you to publish email sending events. For information about
# using configuration sets, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
#
# @!attribute [rw] configuration_set
# The configuration set object associated with the specified
# configuration set.
# @return [Types::ConfigurationSet]
#
# @!attribute [rw] event_destinations
# A list of event destinations associated with the configuration set.
# @return [Array<Types::EventDestination>]
#
# @!attribute [rw] tracking_options
# The name of the custom open and click tracking domain associated
# with the configuration set.
# @return [Types::TrackingOptions]
#
# @!attribute [rw] delivery_options
# Specifies whether messages that use the configuration set are
# required to use Transport Layer Security (TLS).
# @return [Types::DeliveryOptions]
#
# @!attribute [rw] reputation_options
# An object that represents the reputation settings for the
# configuration set.
# @return [Types::ReputationOptions]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DescribeConfigurationSetResponse AWS API Documentation
#
class DescribeConfigurationSetResponse < Struct.new(
:configuration_set,
:event_destinations,
:tracking_options,
:delivery_options,
:reputation_options)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to return the details of a receipt rule. You use
# receipt rules to receive email with Amazon SES. For more information,
# see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
#
# @!attribute [rw] rule_set_name
# The name of the receipt rule set that the receipt rule belongs to.
# @return [String]
#
# @!attribute [rw] rule_name
# The name of the receipt rule.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DescribeReceiptRuleRequest AWS API Documentation
#
class DescribeReceiptRuleRequest < Struct.new(
:rule_set_name,
:rule_name)
SENSITIVE = []
include Aws::Structure
end
# Represents the details of a receipt rule.
#
# @!attribute [rw] 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.
# @return [Types::ReceiptRule]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DescribeReceiptRuleResponse AWS API Documentation
#
class DescribeReceiptRuleResponse < Struct.new(
:rule)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to return the details of a receipt rule set. You
# use receipt rule sets to receive email with Amazon SES. For more
# information, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
#
# @!attribute [rw] rule_set_name
# The name of the receipt rule set to describe.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DescribeReceiptRuleSetRequest AWS API Documentation
#
class DescribeReceiptRuleSetRequest < Struct.new(
:rule_set_name)
SENSITIVE = []
include Aws::Structure
end
# Represents the details of the specified receipt rule set.
#
# @!attribute [rw] 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.
# @return [Types::ReceiptRuleSetMetadata]
#
# @!attribute [rw] rules
# A list of the receipt rules that belong to the specified receipt
# rule set.
# @return [Array<Types::ReceiptRule>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/DescribeReceiptRuleSetResponse AWS API Documentation
#
class DescribeReceiptRuleSetResponse < Struct.new(
:metadata,
:rules)
SENSITIVE = []
include Aws::Structure
end
# Represents the destination of the message, consisting of To:, CC:, and
# BCC: fields.
#
# <note markdown="1"> Amazon SES does not support the SMTPUTF8 extension, as described in
# [RFC6531][1]. For this reason, the *local part* of a destination email
# address (the part of the email address that precedes the @ sign) may
# only contain [7-bit ASCII characters][2]. If the *domain part* of an
# address (the part after the @ sign) contains non-ASCII characters,
# they must be encoded using Punycode, as described in [RFC3492][3].
#
# </note>
#
#
#
# [1]: https://tools.ietf.org/html/rfc6531
# [2]: https://en.wikipedia.org/wiki/Email_address#Local-part
# [3]: https://tools.ietf.org/html/rfc3492.html
#
# @!attribute [rw] to_addresses
# The recipients to place on the To: line of the message.
# @return [Array<String>]
#
# @!attribute [rw] cc_addresses
# The recipients to place on the CC: line of the message.
# @return [Array<String>]
#
# @!attribute [rw] bcc_addresses
# The recipients to place on the BCC: line of the message.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/Destination AWS API Documentation
#
class Destination < Struct.new(
:to_addresses,
:cc_addresses,
:bcc_addresses)
SENSITIVE = []
include Aws::Structure
end
# Contains information about the event destination that the specified
# email sending events will be published to.
#
# <note markdown="1"> When you create or update an event destination, you must provide one,
# and only one, destination. The destination can be Amazon CloudWatch,
# Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon
# SNS).
#
# </note>
#
# Event destinations are associated with configuration sets, which
# enable you to publish email sending events to Amazon CloudWatch,
# Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon
# SNS). For information about using configuration sets, see the [Amazon
# SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
#
# @!attribute [rw] name
# The name of the event destination. The name must:
#
# * This value can only contain ASCII letters (a-z, A-Z), numbers
# (0-9), underscores (\_), or dashes (-).
#
# * Contain less than 64 characters.
# @return [String]
#
# @!attribute [rw] 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`.
# @return [Boolean]
#
# @!attribute [rw] matching_event_types
# The type of email sending events to publish to the event
# destination.
# @return [Array<String>]
#
# @!attribute [rw] kinesis_firehose_destination
# An object that contains the delivery stream ARN and the IAM role ARN
# associated with an Amazon Kinesis Firehose event destination.
# @return [Types::KinesisFirehoseDestination]
#
# @!attribute [rw] cloud_watch_destination
# An object that contains the names, default values, and sources of
# the dimensions associated with an Amazon CloudWatch event
# destination.
# @return [Types::CloudWatchDestination]
#
# @!attribute [rw] sns_destination
# An object that contains the topic ARN associated with an Amazon
# Simple Notification Service (Amazon SNS) event destination.
# @return [Types::SNSDestination]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/EventDestination AWS API Documentation
#
class EventDestination < Struct.new(
:name,
:enabled,
:matching_event_types,
:kinesis_firehose_destination,
:cloud_watch_destination,
:sns_destination)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the event destination could not be created because of a
# naming conflict.
#
# @!attribute [rw] configuration_set_name
# Indicates that the configuration set does not exist.
# @return [String]
#
# @!attribute [rw] event_destination_name
# Indicates that the event destination does not exist.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/EventDestinationAlreadyExistsException AWS API Documentation
#
class EventDestinationAlreadyExistsException < Struct.new(
:configuration_set_name,
:event_destination_name)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the event destination does not exist.
#
# @!attribute [rw] configuration_set_name
# Indicates that the configuration set does not exist.
# @return [String]
#
# @!attribute [rw] event_destination_name
# Indicates that the event destination does not exist.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/EventDestinationDoesNotExistException AWS API Documentation
#
class EventDestinationDoesNotExistException < Struct.new(
:configuration_set_name,
:event_destination_name)
SENSITIVE = []
include Aws::Structure
end
# Additional X-headers to include in the Delivery Status Notification
# (DSN) when an email that Amazon SES receives on your behalf bounces.
#
# For information about receiving email through Amazon SES, see the
# [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html
#
# @!attribute [rw] 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.
# @return [String]
#
# @!attribute [rw] value
# The value of the header to add. Must be less than 2048 characters,
# and must not contain newline characters ("\\r" or "\\n").
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ExtensionField AWS API Documentation
#
class ExtensionField < Struct.new(
:name,
:value)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the sender address specified for a custom verification
# email is not verified, and is therefore not eligible to send the
# custom verification email.
#
# @!attribute [rw] from_email_address
# Indicates that the from email address associated with the custom
# verification email template is not verified.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/FromEmailAddressNotVerifiedException AWS API Documentation
#
class FromEmailAddressNotVerifiedException < Struct.new(
:from_email_address)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to return the email sending status for your
# Amazon SES account in the current AWS Region.
#
# @!attribute [rw] enabled
# Describes whether email sending is enabled or disabled for your
# Amazon SES account in the current AWS Region.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetAccountSendingEnabledResponse AWS API Documentation
#
class GetAccountSendingEnabledResponse < Struct.new(
:enabled)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to retrieve an existing custom verification email
# template.
#
# @!attribute [rw] template_name
# The name of the custom verification email template that you want to
# retrieve.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetCustomVerificationEmailTemplateRequest AWS API Documentation
#
class GetCustomVerificationEmailTemplateRequest < Struct.new(
:template_name)
SENSITIVE = []
include Aws::Structure
end
# The content of the custom verification email template.
#
# @!attribute [rw] template_name
# The name of the custom verification email template.
# @return [String]
#
# @!attribute [rw] from_email_address
# The email address that the custom verification email is sent from.
# @return [String]
#
# @!attribute [rw] template_subject
# The subject line of the custom verification email.
# @return [String]
#
# @!attribute [rw] template_content
# The content of the custom verification email.
# @return [String]
#
# @!attribute [rw] success_redirection_url
# The URL that the recipient of the verification email is sent to if
# his or her address is successfully verified.
# @return [String]
#
# @!attribute [rw] failure_redirection_url
# The URL that the recipient of the verification email is sent to if
# his or her address is not successfully verified.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetCustomVerificationEmailTemplateResponse AWS API Documentation
#
class GetCustomVerificationEmailTemplateResponse < Struct.new(
:template_name,
:from_email_address,
:template_subject,
:template_content,
:success_redirection_url,
:failure_redirection_url)
SENSITIVE = []
include Aws::Structure
end
# Represents a request for the status of Amazon SES Easy DKIM signing
# for an identity. For domain identities, this request also returns the
# DKIM tokens that are required for Easy DKIM signing, and whether
# Amazon SES successfully verified that these tokens were published. For
# more information about Easy DKIM, see the [Amazon SES Developer
# Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
#
# @!attribute [rw] identities
# A list of one or more verified identities - email addresses,
# domains, or both.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetIdentityDkimAttributesRequest AWS API Documentation
#
class GetIdentityDkimAttributesRequest < Struct.new(
:identities)
SENSITIVE = []
include Aws::Structure
end
# Represents the status of Amazon SES Easy DKIM signing for an identity.
# For domain identities, this response also contains the DKIM tokens
# that are required for Easy DKIM signing, and whether Amazon SES
# successfully verified that these tokens were published.
#
# @!attribute [rw] dkim_attributes
# The DKIM attributes for an email address or a domain.
# @return [Hash<String,Types::IdentityDkimAttributes>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetIdentityDkimAttributesResponse AWS API Documentation
#
class GetIdentityDkimAttributesResponse < Struct.new(
:dkim_attributes)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to return the Amazon SES custom MAIL FROM
# attributes for a list of identities. For information about using a
# custom MAIL FROM domain, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html
#
# @!attribute [rw] identities
# A list of one or more identities.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetIdentityMailFromDomainAttributesRequest AWS API Documentation
#
class GetIdentityMailFromDomainAttributesRequest < Struct.new(
:identities)
SENSITIVE = []
include Aws::Structure
end
# Represents the custom MAIL FROM attributes for a list of identities.
#
# @!attribute [rw] mail_from_domain_attributes
# A map of identities to custom MAIL FROM attributes.
# @return [Hash<String,Types::IdentityMailFromDomainAttributes>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetIdentityMailFromDomainAttributesResponse AWS API Documentation
#
class GetIdentityMailFromDomainAttributesResponse < Struct.new(
:mail_from_domain_attributes)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to return the notification attributes for a list
# of identities you verified with Amazon SES. For information about
# Amazon SES notifications, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html
#
# @!attribute [rw] 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:
# `user@example.com`, `example.com`,
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetIdentityNotificationAttributesRequest AWS API Documentation
#
class GetIdentityNotificationAttributesRequest < Struct.new(
:identities)
SENSITIVE = []
include Aws::Structure
end
# Represents the notification attributes for a list of identities.
#
# @!attribute [rw] notification_attributes
# A map of Identity to IdentityNotificationAttributes.
# @return [Hash<String,Types::IdentityNotificationAttributes>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetIdentityNotificationAttributesResponse AWS API Documentation
#
class GetIdentityNotificationAttributesResponse < Struct.new(
:notification_attributes)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to return the requested sending authorization
# policies for an identity. Sending authorization is an Amazon SES
# feature that enables you to authorize other senders to use your
# identities. For information, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
#
# @!attribute [rw] identity
# The identity for which the policies will be retrieved. You can
# specify an identity by using its name or by using its Amazon
# Resource Name (ARN). Examples: `user@example.com`, `example.com`,
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`.
#
# To successfully call this API, you must own the identity.
# @return [String]
#
# @!attribute [rw] policy_names
# 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`.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetIdentityPoliciesRequest AWS API Documentation
#
class GetIdentityPoliciesRequest < Struct.new(
:identity,
:policy_names)
SENSITIVE = []
include Aws::Structure
end
# Represents the requested sending authorization policies.
#
# @!attribute [rw] policies
# A map of policy names to policies.
# @return [Hash<String,String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetIdentityPoliciesResponse AWS API Documentation
#
class GetIdentityPoliciesResponse < Struct.new(
:policies)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to return the Amazon SES verification status of a
# list of identities. For domain identities, this request also returns
# the verification token. For information about verifying identities
# with Amazon SES, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
#
# @!attribute [rw] identities
# A list of identities.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetIdentityVerificationAttributesRequest AWS API Documentation
#
class GetIdentityVerificationAttributesRequest < Struct.new(
:identities)
SENSITIVE = []
include Aws::Structure
end
# The Amazon SES verification status of a list of identities. For domain
# identities, this response also contains the verification token.
#
# @!attribute [rw] verification_attributes
# A map of Identities to IdentityVerificationAttributes objects.
# @return [Hash<String,Types::IdentityVerificationAttributes>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetIdentityVerificationAttributesResponse AWS API Documentation
#
class GetIdentityVerificationAttributesResponse < Struct.new(
:verification_attributes)
SENSITIVE = []
include Aws::Structure
end
# Represents your Amazon SES daily sending quota, maximum send rate, and
# the number of emails you have sent in the last 24 hours.
#
# @!attribute [rw] max_24_hour_send
# The maximum number of emails the user is allowed to send in a
# 24-hour interval. A value of -1 signifies an unlimited quota.
# @return [Float]
#
# @!attribute [rw] max_send_rate
# The maximum number of emails that Amazon SES can accept from the
# user's account per second.
#
# <note markdown="1"> The rate at which Amazon SES accepts the user's messages might be
# less than the maximum send rate.
#
# </note>
# @return [Float]
#
# @!attribute [rw] sent_last_24_hours
# The number of emails sent during the previous 24 hours.
# @return [Float]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetSendQuotaResponse AWS API Documentation
#
class GetSendQuotaResponse < Struct.new(
:max_24_hour_send,
:max_send_rate,
:sent_last_24_hours)
SENSITIVE = []
include Aws::Structure
end
# Represents a list of data points. This list contains aggregated data
# from the previous two weeks of your sending activity with Amazon SES.
#
# @!attribute [rw] send_data_points
# A list of data points, each of which represents 15 minutes of
# activity.
# @return [Array<Types::SendDataPoint>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetSendStatisticsResponse AWS API Documentation
#
class GetSendStatisticsResponse < Struct.new(
:send_data_points)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] template_name
# The name of the template you want to retrieve.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetTemplateRequest AWS API Documentation
#
class GetTemplateRequest < Struct.new(
:template_name)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] template
# The content of the email, composed of a subject line, an HTML part,
# and a text-only part.
# @return [Types::Template]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/GetTemplateResponse AWS API Documentation
#
class GetTemplateResponse < Struct.new(
:template)
SENSITIVE = []
include Aws::Structure
end
# Represents the DKIM attributes of a verified email address or a
# domain.
#
# @!attribute [rw] dkim_enabled
# Is true if DKIM signing is enabled for email sent from the identity.
# It's false otherwise. The default value is true.
# @return [Boolean]
#
# @!attribute [rw] dkim_verification_status
# 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.)
# @return [String]
#
# @!attribute [rw] dkim_tokens
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/IdentityDkimAttributes AWS API Documentation
#
class IdentityDkimAttributes < Struct.new(
:dkim_enabled,
:dkim_verification_status,
:dkim_tokens)
SENSITIVE = []
include Aws::Structure
end
# Represents the custom MAIL FROM domain attributes of a verified
# identity (email address or domain).
#
# @!attribute [rw] mail_from_domain
# The custom MAIL FROM domain that the identity is configured to use.
# @return [String]
#
# @!attribute [rw] mail_from_domain_status
# 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`.
# @return [String]
#
# @!attribute [rw] behavior_on_mx_failure
# 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`.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/IdentityMailFromDomainAttributes AWS API Documentation
#
class IdentityMailFromDomainAttributes < Struct.new(
:mail_from_domain,
:mail_from_domain_status,
:behavior_on_mx_failure)
SENSITIVE = []
include Aws::Structure
end
# Represents the notification attributes of an identity, including
# whether an identity has Amazon Simple Notification Service (Amazon
# SNS) topics set for bounce, complaint, and/or delivery notifications,
# and whether feedback forwarding is enabled for bounce and complaint
# notifications.
#
# @!attribute [rw] bounce_topic
# The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon
# SES will publish bounce notifications.
# @return [String]
#
# @!attribute [rw] complaint_topic
# The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon
# SES will publish complaint notifications.
# @return [String]
#
# @!attribute [rw] delivery_topic
# The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon
# SES will publish delivery notifications.
# @return [String]
#
# @!attribute [rw] forwarding_enabled
# Describes whether Amazon SES will forward bounce and complaint
# notifications as email. `true` indicates that Amazon SES will
# forward bounce and complaint notifications as email, while `false`
# indicates that bounce and complaint notifications will be published
# only to the specified bounce and complaint Amazon SNS topics.
# @return [Boolean]
#
# @!attribute [rw] headers_in_bounce_notifications_enabled
# Describes whether Amazon SES includes the original email headers in
# Amazon SNS notifications of type `Bounce`. A value of `true`
# specifies that Amazon SES will include headers in bounce
# notifications, and a value of `false` specifies that Amazon SES will
# not include headers in bounce notifications.
# @return [Boolean]
#
# @!attribute [rw] headers_in_complaint_notifications_enabled
# Describes whether Amazon SES includes the original email headers in
# Amazon SNS notifications of type `Complaint`. A value of `true`
# specifies that Amazon SES will include headers in complaint
# notifications, and a value of `false` specifies that Amazon SES will
# not include headers in complaint notifications.
# @return [Boolean]
#
# @!attribute [rw] headers_in_delivery_notifications_enabled
# Describes whether Amazon SES includes the original email headers in
# Amazon SNS notifications of type `Delivery`. A value of `true`
# specifies that Amazon SES will include headers in delivery
# notifications, and a value of `false` specifies that Amazon SES will
# not include headers in delivery notifications.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/IdentityNotificationAttributes AWS API Documentation
#
class IdentityNotificationAttributes < Struct.new(
:bounce_topic,
:complaint_topic,
:delivery_topic,
:forwarding_enabled,
:headers_in_bounce_notifications_enabled,
:headers_in_complaint_notifications_enabled,
:headers_in_delivery_notifications_enabled)
SENSITIVE = []
include Aws::Structure
end
# Represents the verification attributes of a single identity.
#
# @!attribute [rw] verification_status
# The verification status of the identity: "Pending", "Success",
# "Failed", or "TemporaryFailure".
# @return [String]
#
# @!attribute [rw] verification_token
# The verification token for a domain identity. Null for email address
# identities.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/IdentityVerificationAttributes AWS API Documentation
#
class IdentityVerificationAttributes < Struct.new(
:verification_status,
:verification_token)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the Amazon CloudWatch destination is invalid. See the
# error message for details.
#
# @!attribute [rw] configuration_set_name
# Indicates that the configuration set does not exist.
# @return [String]
#
# @!attribute [rw] event_destination_name
# Indicates that the event destination does not exist.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/InvalidCloudWatchDestinationException AWS API Documentation
#
class InvalidCloudWatchDestinationException < Struct.new(
:configuration_set_name,
:event_destination_name)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the configuration set is invalid. See the error message
# for details.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/InvalidConfigurationSetException AWS API Documentation
#
class InvalidConfigurationSetException < Aws::EmptyStructure; end
# Indicates that provided delivery option is invalid.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/InvalidDeliveryOptionsException AWS API Documentation
#
class InvalidDeliveryOptionsException < Aws::EmptyStructure; end
# Indicates that the Amazon Kinesis Firehose destination is invalid. See
# the error message for details.
#
# @!attribute [rw] configuration_set_name
# Indicates that the configuration set does not exist.
# @return [String]
#
# @!attribute [rw] event_destination_name
# Indicates that the event destination does not exist.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/InvalidFirehoseDestinationException AWS API Documentation
#
class InvalidFirehoseDestinationException < Struct.new(
:configuration_set_name,
:event_destination_name)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the provided AWS Lambda function is invalid, or that
# Amazon SES could not execute the provided function, possibly due to
# permissions issues. For information about giving permissions, see the
# [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html
#
# @!attribute [rw] function_arn
# Indicates that the ARN of the function was not found.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/InvalidLambdaFunctionException AWS API Documentation
#
class InvalidLambdaFunctionException < Struct.new(
:function_arn)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the provided policy is invalid. Check the error stack
# for more information about what caused the error.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/InvalidPolicyException AWS API Documentation
#
class InvalidPolicyException < Aws::EmptyStructure; end
# Indicates that one or more of the replacement values you provided is
# invalid. This error may occur when the TemplateData object contains
# invalid JSON.
#
# @!attribute [rw] template_name
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/InvalidRenderingParameterException AWS API Documentation
#
class InvalidRenderingParameterException < Struct.new(
:template_name)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the provided Amazon S3 bucket or AWS KMS encryption key
# is invalid, or that Amazon SES could not publish to the bucket,
# possibly due to permissions issues. For information about giving
# permissions, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html
#
# @!attribute [rw] bucket
# Indicated that the S3 Bucket was not found.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/InvalidS3ConfigurationException AWS API Documentation
#
class InvalidS3ConfigurationException < Struct.new(
:bucket)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the Amazon Simple Notification Service (Amazon SNS)
# destination is invalid. See the error message for details.
#
# @!attribute [rw] configuration_set_name
# Indicates that the configuration set does not exist.
# @return [String]
#
# @!attribute [rw] event_destination_name
# Indicates that the event destination does not exist.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/InvalidSNSDestinationException AWS API Documentation
#
class InvalidSNSDestinationException < Struct.new(
:configuration_set_name,
:event_destination_name)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the provided Amazon SNS topic is invalid, or that
# Amazon SES could not publish to the topic, possibly due to permissions
# issues. For information about giving permissions, see the [Amazon SES
# Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html
#
# @!attribute [rw] topic
# Indicates that the topic does not exist.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/InvalidSnsTopicException AWS API Documentation
#
class InvalidSnsTopicException < Struct.new(
:topic)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the template that you specified could not be rendered.
# This issue may occur when a template refers to a partial that does not
# exist.
#
# @!attribute [rw] template_name
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/InvalidTemplateException AWS API Documentation
#
class InvalidTemplateException < Struct.new(
:template_name)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the custom domain to be used for open and click
# tracking redirects is invalid. This error appears most often in the
# following situations:
#
# * When the tracking domain you specified is not verified in Amazon
# SES.
#
# * When the tracking domain you specified is not a valid domain or
# subdomain.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/InvalidTrackingOptionsException AWS API Documentation
#
class InvalidTrackingOptionsException < Aws::EmptyStructure; end
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
#
# @!attribute [rw] iam_role_arn
# The ARN of the IAM role under which Amazon SES publishes email
# sending events to the Amazon Kinesis Firehose stream.
# @return [String]
#
# @!attribute [rw] delivery_stream_arn
# The ARN of the Amazon Kinesis Firehose stream that email sending
# events should be published to.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/KinesisFirehoseDestination AWS API Documentation
#
class KinesisFirehoseDestination < Struct.new(
:iam_role_arn,
:delivery_stream_arn)
SENSITIVE = []
include Aws::Structure
end
# 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][1].
#
# For information about using AWS Lambda actions in receipt rules, see
# the [Amazon SES Developer Guide][2].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-lambda.html
#
# @!attribute [rw] topic_arn
# The Amazon Resource Name (ARN) of the Amazon SNS topic to notify
# when the Lambda action is taken. An example of an Amazon SNS topic
# ARN is `arn:aws:sns:us-west-2:123456789012:MyTopic`. For more
# information about Amazon SNS topics, see the [Amazon SNS Developer
# Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
# @return [String]
#
# @!attribute [rw] function_arn
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/lambda/latest/dg/welcome.html
# @return [String]
#
# @!attribute [rw] invocation_type
# The invocation type of the AWS Lambda function. An invocation type
# of `RequestResponse` means that the execution of the function will
# immediately result in a response, and a value of `Event` means that
# the function will be invoked asynchronously. The default value is
# `Event`. For information about AWS Lambda invocation types, see the
# [AWS Lambda Developer Guide][1].
#
# There is a 30-second timeout on `RequestResponse` invocations. You
# should use `Event` invocation in most cases. Use `RequestResponse`
# only when you want to make a mail flow decision, such as whether to
# stop the receipt rule or the receipt rule set.
#
#
#
# [1]: https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/LambdaAction AWS API Documentation
#
class LambdaAction < Struct.new(
:topic_arn,
:function_arn,
:invocation_type)
SENSITIVE = []
include Aws::Structure
end
# Indicates that a resource could not be created because of service
# limits. For a list of Amazon SES limits, see the [Amazon SES Developer
# Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/limits.html
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/LimitExceededException AWS API Documentation
#
class LimitExceededException < Aws::EmptyStructure; end
# Represents a request to list the configuration sets associated with
# your AWS account. Configuration sets enable you to publish email
# sending events. For information about using configuration sets, see
# the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
#
# @!attribute [rw] next_token
# A token returned from a previous call to `ListConfigurationSets` to
# indicate the position of the configuration set in the configuration
# set list.
# @return [String]
#
# @!attribute [rw] max_items
# The number of configuration sets to return.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListConfigurationSetsRequest AWS API Documentation
#
class ListConfigurationSetsRequest < Struct.new(
:next_token,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A list of configuration sets associated with your AWS account.
# Configuration sets enable you to publish email sending events. For
# information about using configuration sets, see the [Amazon SES
# Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
#
# @!attribute [rw] configuration_sets
# A list of configuration sets.
# @return [Array<Types::ConfigurationSet>]
#
# @!attribute [rw] next_token
# A token indicating that there are additional configuration sets
# available to be listed. Pass this token to successive calls of
# `ListConfigurationSets`.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListConfigurationSetsResponse AWS API Documentation
#
class ListConfigurationSetsResponse < Struct.new(
:configuration_sets,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to list the existing custom verification email
# templates for your account.
#
# For more information about custom verification email templates, see
# [Using Custom Verification Email Templates][1] in the *Amazon SES
# Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html
#
# @!attribute [rw] next_token
# An array the contains the name and creation time stamp for each
# template in your Amazon SES account.
# @return [String]
#
# @!attribute [rw] max_results
# The maximum number of custom verification email templates to return.
# This value must be at least 1 and less than or equal to 50. If you
# do not specify a value, or if you specify a value less than 1 or
# greater than 50, the operation will return up to 50 results.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListCustomVerificationEmailTemplatesRequest AWS API Documentation
#
class ListCustomVerificationEmailTemplatesRequest < Struct.new(
:next_token,
:max_results)
SENSITIVE = []
include Aws::Structure
end
# A paginated list of custom verification email templates.
#
# @!attribute [rw] custom_verification_email_templates
# A list of the custom verification email templates that exist in your
# account.
# @return [Array<Types::CustomVerificationEmailTemplate>]
#
# @!attribute [rw] next_token
# 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.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListCustomVerificationEmailTemplatesResponse AWS API Documentation
#
class ListCustomVerificationEmailTemplatesResponse < Struct.new(
:custom_verification_email_templates,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to return a list of all identities (email
# addresses and domains) that you have attempted to verify under your
# AWS account, regardless of verification status.
#
# @!attribute [rw] identity_type
# The type of the identities to list. Possible values are
# "EmailAddress" and "Domain". If this parameter is omitted, then
# all identities will be listed.
# @return [String]
#
# @!attribute [rw] next_token
# The token to use for pagination.
# @return [String]
#
# @!attribute [rw] max_items
# The maximum number of identities per page. Possible values are
# 1-1000 inclusive.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListIdentitiesRequest AWS API Documentation
#
class ListIdentitiesRequest < Struct.new(
:identity_type,
:next_token,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# A list of all identities that you have attempted to verify under your
# AWS account, regardless of verification status.
#
# @!attribute [rw] identities
# A list of identities.
# @return [Array<String>]
#
# @!attribute [rw] next_token
# The token used for pagination.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListIdentitiesResponse AWS API Documentation
#
class ListIdentitiesResponse < Struct.new(
:identities,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to return a list of sending authorization
# policies that are attached to an identity. Sending authorization is an
# Amazon SES feature that enables you to authorize other senders to use
# your identities. For information, see the [Amazon SES Developer
# Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
#
# @!attribute [rw] identity
# The identity that is associated with the policy for which the
# policies will be listed. You can specify an identity by using its
# name or by using its Amazon Resource Name (ARN). Examples:
# `user@example.com`, `example.com`,
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`.
#
# To successfully call this API, you must own the identity.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListIdentityPoliciesRequest AWS API Documentation
#
class ListIdentityPoliciesRequest < Struct.new(
:identity)
SENSITIVE = []
include Aws::Structure
end
# A list of names of sending authorization policies that apply to an
# identity.
#
# @!attribute [rw] policy_names
# A list of names of policies that apply to the specified identity.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListIdentityPoliciesResponse AWS API Documentation
#
class ListIdentityPoliciesResponse < Struct.new(
:policy_names)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to list the IP address filters that exist under
# your AWS account. You use IP address filters when you receive email
# with Amazon SES. For more information, see the [Amazon SES Developer
# Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
#
# @api private
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListReceiptFiltersRequest AWS API Documentation
#
class ListReceiptFiltersRequest < Aws::EmptyStructure; end
# A list of IP address filters that exist under your AWS account.
#
# @!attribute [rw] 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.
# @return [Array<Types::ReceiptFilter>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListReceiptFiltersResponse AWS API Documentation
#
class ListReceiptFiltersResponse < Struct.new(
:filters)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to list the receipt rule sets that exist under
# your AWS account. You use receipt rule sets to receive email with
# Amazon SES. For more information, see the [Amazon SES Developer
# Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
#
# @!attribute [rw] next_token
# A token returned from a previous call to `ListReceiptRuleSets` to
# indicate the position in the receipt rule set list.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListReceiptRuleSetsRequest AWS API Documentation
#
class ListReceiptRuleSetsRequest < Struct.new(
:next_token)
SENSITIVE = []
include Aws::Structure
end
# A list of receipt rule sets that exist under your AWS account.
#
# @!attribute [rw] rule_sets
# 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.
# @return [Array<Types::ReceiptRuleSetMetadata>]
#
# @!attribute [rw] next_token
# 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.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListReceiptRuleSetsResponse AWS API Documentation
#
class ListReceiptRuleSetsResponse < Struct.new(
:rule_sets,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] next_token
# A token returned from a previous call to `ListTemplates` to indicate
# the position in the list of email templates.
# @return [String]
#
# @!attribute [rw] max_items
# The maximum number of templates to return. This value must be at
# least 1 and less than or equal to 10. If you do not specify a value,
# or if you specify a value less than 1 or greater than 10, the
# operation will return up to 10 results.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListTemplatesRequest AWS API Documentation
#
class ListTemplatesRequest < Struct.new(
:next_token,
:max_items)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] templates_metadata
# An array the contains the name and creation time stamp for each
# template in your Amazon SES account.
# @return [Array<Types::TemplateMetadata>]
#
# @!attribute [rw] next_token
# A token indicating that there are additional email templates
# available to be listed. Pass this token to a subsequent call to
# `ListTemplates` to retrieve the next 50 email templates.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListTemplatesResponse AWS API Documentation
#
class ListTemplatesResponse < Struct.new(
:templates_metadata,
:next_token)
SENSITIVE = []
include Aws::Structure
end
# A list of email addresses that you have verified with Amazon SES under
# your AWS account.
#
# @!attribute [rw] verified_email_addresses
# A list of email addresses that have been verified.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ListVerifiedEmailAddressesResponse AWS API Documentation
#
class ListVerifiedEmailAddressesResponse < Struct.new(
:verified_email_addresses)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the message could not be sent because Amazon SES could
# not read the MX record required to use the specified MAIL FROM domain.
# For information about editing the custom MAIL FROM domain settings for
# an identity, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from-edit.html
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/MailFromDomainNotVerifiedException AWS API Documentation
#
class MailFromDomainNotVerifiedException < Aws::EmptyStructure; end
# Represents the message to be sent, composed of a subject and a body.
#
# @!attribute [rw] subject
# The subject of the message: A short summary of the content, which
# will appear in the recipient's inbox.
# @return [Types::Content]
#
# @!attribute [rw] body
# The message body.
# @return [Types::Body]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/Message AWS API Documentation
#
class Message < Struct.new(
:subject,
:body)
SENSITIVE = []
include Aws::Structure
end
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html
#
# @!attribute [rw] reporting_mta
# The reporting MTA that attempted to deliver the message, formatted
# as specified in [RFC 3464][1] (`mta-name-type; mta-name`). The
# default value is `dns; inbound-smtp.[region].amazonaws.com`.
#
#
#
# [1]: https://tools.ietf.org/html/rfc3464
# @return [String]
#
# @!attribute [rw] arrival_date
# When the message was received by the reporting mail transfer agent
# (MTA), in [RFC 822][1] date-time format.
#
#
#
# [1]: https://www.ietf.org/rfc/rfc0822.txt
# @return [Time]
#
# @!attribute [rw] extension_fields
# Additional X-headers to include in the DSN.
# @return [Array<Types::ExtensionField>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/MessageDsn AWS API Documentation
#
class MessageDsn < Struct.new(
:reporting_mta,
:arrival_date,
:extension_fields)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the action failed, and the message could not be sent.
# Check the error stack for more information about what caused the
# error.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/MessageRejected AWS API Documentation
#
class MessageRejected < Aws::EmptyStructure; end
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
#
# @!attribute [rw] name
# The name of the tag. The name must:
#
# * This value can only contain ASCII letters (a-z, A-Z), numbers
# (0-9), underscores (\_), or dashes (-).
#
# * Contain less than 256 characters.
# @return [String]
#
# @!attribute [rw] value
# The value of the tag. The value must:
#
# * This value can only contain ASCII letters (a-z, A-Z), numbers
# (0-9), underscores (\_), or dashes (-).
#
# * Contain less than 256 characters.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/MessageTag AWS API Documentation
#
class MessageTag < Struct.new(
:name,
:value)
SENSITIVE = []
include Aws::Structure
end
# Indicates that one or more of the replacement values for the specified
# template was not specified. Ensure that the TemplateData object
# contains references to all of the replacement tags in the specified
# template.
#
# @!attribute [rw] template_name
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/MissingRenderingAttributeException AWS API Documentation
#
class MissingRenderingAttributeException < Struct.new(
:template_name)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the account has not been granted production access.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ProductionAccessNotGrantedException AWS API Documentation
#
class ProductionAccessNotGrantedException < Aws::EmptyStructure; end
# A request to modify the delivery options for a configuration set.
#
# @!attribute [rw] configuration_set_name
# The name of the configuration set that you want to specify the
# delivery options for.
# @return [String]
#
# @!attribute [rw] delivery_options
# Specifies whether messages that use the configuration set are
# required to use Transport Layer Security (TLS).
# @return [Types::DeliveryOptions]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/PutConfigurationSetDeliveryOptionsRequest AWS API Documentation
#
class PutConfigurationSetDeliveryOptionsRequest < Struct.new(
:configuration_set_name,
:delivery_options)
SENSITIVE = []
include Aws::Structure
end
# An HTTP 200 response if the request succeeds, or an error message if
# the request fails.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/PutConfigurationSetDeliveryOptionsResponse AWS API Documentation
#
class PutConfigurationSetDeliveryOptionsResponse < Aws::EmptyStructure; end
# Represents a request to add or update a sending authorization policy
# for an identity. Sending authorization is an Amazon SES feature that
# enables you to authorize other senders to use your identities. For
# information, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
#
# @!attribute [rw] identity
# The identity that the policy will apply to. You can specify an
# identity by using its name or by using its Amazon Resource Name
# (ARN). Examples: `user@example.com`, `example.com`,
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`.
#
# To successfully call this API, you must own the identity.
# @return [String]
#
# @!attribute [rw] policy_name
# The name of the policy.
#
# The policy name cannot exceed 64 characters and can only include
# alphanumeric characters, dashes, and underscores.
# @return [String]
#
# @!attribute [rw] 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/PutIdentityPolicyRequest AWS API Documentation
#
class PutIdentityPolicyRequest < Struct.new(
:identity,
:policy_name,
:policy)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/PutIdentityPolicyResponse AWS API Documentation
#
class PutIdentityPolicyResponse < Aws::EmptyStructure; end
# Represents the raw data of the message.
#
# @!attribute [rw] data
# The raw data of the message. This data needs to base64-encoded if
# you are accessing Amazon SES directly through the HTTPS interface.
# If you are accessing Amazon SES using an AWS SDK, the SDK takes care
# of the base 64-encoding for you. In all cases, the client must
# ensure that the message format complies with Internet email
# standards regarding email header fields, MIME types, and MIME
# encoding.
#
# The To:, CC:, and BCC: headers in the raw message can contain a
# group list.
#
# If you are using `SendRawEmail` with sending authorization, you can
# include X-headers in the raw message to specify the "Source,"
# "From," and "Return-Path" addresses. For more information, see
# the documentation for `SendRawEmail`.
#
# Do not include these X-headers in the DKIM signature, because they
# are removed by Amazon SES before sending the email.
#
# For more information, go to the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/RawMessage AWS API Documentation
#
class RawMessage < Struct.new(
:data)
SENSITIVE = []
include Aws::Structure
end
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html
#
# @!attribute [rw] s3_action
# Saves the received message to an Amazon Simple Storage Service
# (Amazon S3) bucket and, optionally, publishes a notification to
# Amazon SNS.
# @return [Types::S3Action]
#
# @!attribute [rw] bounce_action
# Rejects the received email by returning a bounce response to the
# sender and, optionally, publishes a notification to Amazon Simple
# Notification Service (Amazon SNS).
# @return [Types::BounceAction]
#
# @!attribute [rw] workmail_action
# Calls Amazon WorkMail and, optionally, publishes a notification to
# Amazon Amazon SNS.
# @return [Types::WorkmailAction]
#
# @!attribute [rw] lambda_action
# Calls an AWS Lambda function, and optionally, publishes a
# notification to Amazon SNS.
# @return [Types::LambdaAction]
#
# @!attribute [rw] stop_action
# Terminates the evaluation of the receipt rule set and optionally
# publishes a notification to Amazon SNS.
# @return [Types::StopAction]
#
# @!attribute [rw] add_header_action
# Adds a header to the received email.
# @return [Types::AddHeaderAction]
#
# @!attribute [rw] sns_action
# Publishes the email content within a notification to Amazon SNS.
# @return [Types::SNSAction]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ReceiptAction AWS API Documentation
#
class ReceiptAction < Struct.new(
:s3_action,
:bounce_action,
:workmail_action,
:lambda_action,
:stop_action,
:add_header_action,
:sns_action)
SENSITIVE = []
include Aws::Structure
end
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html
#
# @!attribute [rw] name
# The name of the IP address filter. The name must:
#
# * This value can only contain ASCII letters (a-z, A-Z), numbers
# (0-9), underscores (\_), or dashes (-).
#
# * Start and end with a letter or number.
#
# * Contain less than 64 characters.
# @return [String]
#
# @!attribute [rw] ip_filter
# A structure that provides the IP addresses to block or allow, and
# whether to block or allow incoming mail from them.
# @return [Types::ReceiptIpFilter]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ReceiptFilter AWS API Documentation
#
class ReceiptFilter < Struct.new(
:name,
:ip_filter)
SENSITIVE = []
include Aws::Structure
end
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html
#
# @!attribute [rw] policy
# Indicates whether to block or allow incoming mail from the specified
# IP addresses.
# @return [String]
#
# @!attribute [rw] cidr
# A single IP address or a range of IP addresses that you want to
# block or allow, specified in Classless Inter-Domain Routing (CIDR)
# notation. An example of a single email address is 10.0.0.1. An
# example of a range of IP addresses is 10.0.0.1/24. For more
# information about CIDR notation, see [RFC 2317][1].
#
#
#
# [1]: https://tools.ietf.org/html/rfc2317
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ReceiptIpFilter AWS API Documentation
#
class ReceiptIpFilter < Struct.new(
:policy,
:cidr)
SENSITIVE = []
include Aws::Structure
end
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html
#
# @!attribute [rw] name
# The name of the receipt rule. The name must:
#
# * This value can only contain ASCII letters (a-z, A-Z), numbers
# (0-9), underscores (\_), or dashes (-).
#
# * Start and end with a letter or number.
#
# * Contain less than 64 characters.
# @return [String]
#
# @!attribute [rw] enabled
# If `true`, the receipt rule is active. The default value is `false`.
# @return [Boolean]
#
# @!attribute [rw] tls_policy
# Specifies whether Amazon SES should require that incoming email is
# delivered over a connection encrypted with Transport Layer Security
# (TLS). If this parameter is set to `Require`, Amazon SES will bounce
# emails that are not received over TLS. The default is `Optional`.
# @return [String]
#
# @!attribute [rw] recipients
# The recipient domains and email addresses that the receipt rule
# applies to. If this field is not specified, this rule will match all
# recipients under all verified domains.
# @return [Array<String>]
#
# @!attribute [rw] 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.
# @return [Array<Types::ReceiptAction>]
#
# @!attribute [rw] scan_enabled
# If `true`, then messages that this receipt rule applies to are
# scanned for spam and viruses. The default value is `false`.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ReceiptRule AWS API Documentation
#
class ReceiptRule < Struct.new(
:name,
:enabled,
:tls_policy,
:recipients,
:actions,
:scan_enabled)
SENSITIVE = []
include Aws::Structure
end
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html
#
# @!attribute [rw] name
# The name of the receipt rule set. The name must:
#
# * This value can only contain ASCII letters (a-z, A-Z), numbers
# (0-9), underscores (\_), or dashes (-).
#
# * Start and end with a letter or number.
#
# * Contain less than 64 characters.
# @return [String]
#
# @!attribute [rw] created_timestamp
# The date and time the receipt rule set was created.
# @return [Time]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ReceiptRuleSetMetadata AWS API Documentation
#
class ReceiptRuleSetMetadata < Struct.new(
:name,
:created_timestamp)
SENSITIVE = []
include Aws::Structure
end
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html
#
# @!attribute [rw] final_recipient
# The email address that the message was ultimately delivered to. This
# corresponds to the `Final-Recipient` in the DSN. If not specified,
# `FinalRecipient` will be set to the `Recipient` specified in the
# `BouncedRecipientInfo` structure. Either `FinalRecipient` or the
# recipient in `BouncedRecipientInfo` must be a recipient of the
# original bounced message.
#
# <note markdown="1"> Do not prepend the `FinalRecipient` email address with `rfc 822;`,
# as described in [RFC 3798][1].
#
# </note>
#
#
#
# [1]: https://tools.ietf.org/html/rfc3798
# @return [String]
#
# @!attribute [rw] 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][1].
#
#
#
# [1]: https://tools.ietf.org/html/rfc3464
# @return [String]
#
# @!attribute [rw] remote_mta
# The MTA to which the remote MTA attempted to deliver the message,
# formatted as specified in [RFC 3464][1] (`mta-name-type; mta-name`).
# This parameter typically applies only to propagating synchronous
# bounces.
#
#
#
# [1]: https://tools.ietf.org/html/rfc3464
# @return [String]
#
# @!attribute [rw] status
# The status code that indicates what went wrong. This is required by
# [RFC 3464][1].
#
#
#
# [1]: https://tools.ietf.org/html/rfc3464
# @return [String]
#
# @!attribute [rw] diagnostic_code
# An extended explanation of what went wrong; this is usually an SMTP
# response. See [RFC 3463][1] for the correct formatting of this
# parameter.
#
#
#
# [1]: https://tools.ietf.org/html/rfc3463
# @return [String]
#
# @!attribute [rw] last_attempt_date
# The time the final delivery attempt was made, in [RFC 822][1]
# date-time format.
#
#
#
# [1]: https://www.ietf.org/rfc/rfc0822.txt
# @return [Time]
#
# @!attribute [rw] extension_fields
# Additional X-headers to include in the DSN.
# @return [Array<Types::ExtensionField>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/RecipientDsnFields AWS API Documentation
#
class RecipientDsnFields < Struct.new(
:final_recipient,
:action,
:remote_mta,
:status,
:diagnostic_code,
:last_attempt_date,
:extension_fields)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to reorder the receipt rules within a receipt
# rule set. You use receipt rule sets to receive email with Amazon SES.
# For more information, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
#
# @!attribute [rw] rule_set_name
# The name of the receipt rule set to reorder.
# @return [String]
#
# @!attribute [rw] rule_names
# A list of the specified receipt rule set's receipt rules in the
# order that you want to put them.
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ReorderReceiptRuleSetRequest AWS API Documentation
#
class ReorderReceiptRuleSetRequest < Struct.new(
:rule_set_name,
:rule_names)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ReorderReceiptRuleSetResponse AWS API Documentation
#
class ReorderReceiptRuleSetResponse < Aws::EmptyStructure; end
# Contains information about the reputation settings for a configuration
# set.
#
# @!attribute [rw] sending_enabled
# Describes whether email sending is enabled or disabled for the
# configuration set. If the value is `true`, then Amazon SES will send
# emails that use the configuration set. If the value is `false`,
# Amazon SES will not send emails that use the configuration set. The
# default value is `true`. You can change this setting using
# UpdateConfigurationSetSendingEnabled.
# @return [Boolean]
#
# @!attribute [rw] reputation_metrics_enabled
# 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`.
# @return [Boolean]
#
# @!attribute [rw] last_fresh_start
# 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`.
# @return [Time]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ReputationOptions AWS API Documentation
#
class ReputationOptions < Struct.new(
:sending_enabled,
:reputation_metrics_enabled,
:last_fresh_start)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the provided receipt rule does not exist.
#
# @!attribute [rw] name
# Indicates that the named receipt rule does not exist.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/RuleDoesNotExistException AWS API Documentation
#
class RuleDoesNotExistException < Struct.new(
:name)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the provided receipt rule set does not exist.
#
# @!attribute [rw] name
# Indicates that the named receipt rule set does not exist.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/RuleSetDoesNotExistException AWS API Documentation
#
class RuleSetDoesNotExistException < Struct.new(
:name)
SENSITIVE = []
include Aws::Structure
end
# When included in a receipt rule, this action saves the received
# message to an Amazon Simple Storage Service (Amazon S3) bucket and,
# optionally, publishes a notification to Amazon Simple Notification
# Service (Amazon SNS).
#
# To enable Amazon SES to write emails to your Amazon S3 bucket, use an
# AWS KMS key to encrypt your emails, or publish to an Amazon SNS topic
# of another account, Amazon SES must have permission to access those
# resources. For information about giving permissions, see the [Amazon
# SES Developer Guide][1].
#
# <note markdown="1"> When you save your emails to an Amazon S3 bucket, the maximum email
# size (including headers) is 30 MB. Emails larger than that will
# bounce.
#
# </note>
#
# For information about specifying Amazon S3 actions in receipt rules,
# see the [Amazon SES Developer Guide][2].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-s3.html
#
# @!attribute [rw] topic_arn
# The ARN of the Amazon SNS topic to notify when the message is saved
# to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is
# `arn:aws:sns:us-west-2:123456789012:MyTopic`. For more information
# about Amazon SNS topics, see the [Amazon SNS Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
# @return [String]
#
# @!attribute [rw] bucket_name
# The name of the Amazon S3 bucket that incoming email will be saved
# to.
# @return [String]
#
# @!attribute [rw] object_key_prefix
# 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.
# @return [String]
#
# @!attribute [rw] kms_key_arn
# The customer master key that Amazon SES should use to encrypt your
# emails before saving them to the Amazon S3 bucket. You can use the
# default master key or a custom master key you created in AWS KMS as
# follows:
#
# * To use the default master key, provide an ARN in the form of
# `arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses`. For
# example, if your AWS account ID is 123456789012 and you want to
# use the default master key in the US West (Oregon) region, the ARN
# of the default master key would be
# `arn:aws:kms:us-west-2:123456789012:alias/aws/ses`. If you use the
# default master key, you don't need to perform any extra steps to
# give Amazon SES permission to use the key.
#
# * To use a custom master key you created in AWS KMS, provide the ARN
# of the master key and ensure that you add a statement to your
# key's policy to give Amazon SES permission to use it. For more
# information about giving permissions, see the [Amazon SES
# Developer Guide][1].
#
# For more information about key policies, see the [AWS KMS Developer
# Guide][2]. If you do not specify a master key, Amazon SES will not
# encrypt your emails.
#
# Your mail is encrypted by Amazon SES using the Amazon S3 encryption
# client before the mail is submitted to Amazon S3 for storage. It is
# not encrypted using Amazon S3 server-side encryption. This means
# that you must use the Amazon S3 encryption client to decrypt the
# email after retrieving it from Amazon S3, as the service has no
# access to use your AWS KMS keys for decryption. This encryption
# client is currently available with the [AWS SDK for Java][3] and
# [AWS SDK for Ruby][4] only. For more information about client-side
# encryption using AWS KMS master keys, see the [Amazon S3 Developer
# Guide][5].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html
# [3]: http://aws.amazon.com/sdk-for-java/
# [4]: http://aws.amazon.com/sdk-for-ruby/
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/S3Action AWS API Documentation
#
class S3Action < Struct.new(
:topic_arn,
:bucket_name,
:object_key_prefix,
:kms_key_arn)
SENSITIVE = []
include Aws::Structure
end
# When included in a receipt rule, this action publishes a notification
# to Amazon Simple Notification Service (Amazon SNS). This action
# includes a complete copy of the email content in the Amazon SNS
# notifications. Amazon SNS notifications for all other actions simply
# provide information about the email. They do not include the email
# content itself.
#
# If you own the Amazon SNS topic, you don't need to do anything to
# give Amazon SES permission to publish emails to it. However, if you
# don't own the Amazon SNS topic, you need to attach a policy to the
# topic to give Amazon SES permissions to access it. For information
# about giving permissions, see the [Amazon SES Developer Guide][1].
#
# You can only publish emails that are 150 KB or less (including the
# header) to Amazon SNS. Larger emails will bounce. If you anticipate
# emails larger than 150 KB, use the S3 action instead.
#
# For information about using a receipt rule to publish an Amazon SNS
# notification, see the [Amazon SES Developer Guide][2].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-sns.html
#
# @!attribute [rw] topic_arn
# The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An
# example of an Amazon SNS topic ARN is
# `arn:aws:sns:us-west-2:123456789012:MyTopic`. For more information
# about Amazon SNS topics, see the [Amazon SNS Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
# @return [String]
#
# @!attribute [rw] 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.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SNSAction AWS API Documentation
#
class SNSAction < Struct.new(
:topic_arn,
:encoding)
SENSITIVE = []
include Aws::Structure
end
# Contains the topic ARN associated with an Amazon Simple Notification
# Service (Amazon SNS) event destination.
#
# Event destinations, such as Amazon SNS, are associated with
# configuration sets, which enable you to publish email sending events.
# For information about using configuration sets, see the [Amazon SES
# Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
#
# @!attribute [rw] topic_arn
# The ARN of the Amazon SNS topic that email sending events will be
# published to. An example of an Amazon SNS topic ARN is
# `arn:aws:sns:us-west-2:123456789012:MyTopic`. For more information
# about Amazon SNS topics, see the [Amazon SNS Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SNSDestination AWS API Documentation
#
class SNSDestination < Struct.new(
:topic_arn)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to send a bounce message to the sender of an
# email you received through Amazon SES.
#
# @!attribute [rw] original_message_id
# The message ID of the message to be bounced.
# @return [String]
#
# @!attribute [rw] bounce_sender
# The address to use in the "From" header of the bounce message.
# This must be an identity that you have verified with Amazon SES.
# @return [String]
#
# @!attribute [rw] explanation
# Human-readable text for the bounce message to explain the failure.
# If not specified, the text will be auto-generated based on the
# bounced recipient information.
# @return [String]
#
# @!attribute [rw] message_dsn
# Message-related DSN fields. If not specified, Amazon SES will choose
# the values.
# @return [Types::MessageDsn]
#
# @!attribute [rw] bounced_recipient_info_list
# 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.
# @return [Array<Types::BouncedRecipientInfo>]
#
# @!attribute [rw] bounce_sender_arn
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendBounceRequest AWS API Documentation
#
class SendBounceRequest < Struct.new(
:original_message_id,
:bounce_sender,
:explanation,
:message_dsn,
:bounced_recipient_info_list,
:bounce_sender_arn)
SENSITIVE = []
include Aws::Structure
end
# Represents a unique message ID.
#
# @!attribute [rw] message_id
# The message ID of the bounce message.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendBounceResponse AWS API Documentation
#
class SendBounceResponse < Struct.new(
:message_id)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to send a templated email to multiple
# destinations using Amazon SES. For more information, see the [Amazon
# SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
#
# @!attribute [rw] 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][1].
#
# 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][2].
#
# <note markdown="1"> Amazon SES does not support the SMTPUTF8 extension, as described in
# [RFC6531][3]. For this reason, the *local part* of a source email
# address (the part of the email address that precedes the @ sign) may
# only contain [7-bit ASCII characters][4]. If the *domain part* of an
# address (the part after the @ sign) contains non-ASCII characters,
# they must be encoded using Punycode, as described in [RFC3492][5].
# The sender name (also known as the *friendly name*) may contain
# non-ASCII characters. These characters must be encoded using MIME
# encoded-word syntax, as described in [RFC 2047][6]. MIME
# encoded-word syntax uses the following form:
# `=?charset?encoding?encoded-text?=`.
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
# [3]: https://tools.ietf.org/html/rfc6531
# [4]: https://en.wikipedia.org/wiki/Email_address#Local-part
# [5]: https://tools.ietf.org/html/rfc3492.html
# [6]: https://tools.ietf.org/html/rfc2047
# @return [String]
#
# @!attribute [rw] source_arn
# This parameter is used only for sending authorization. It is the ARN
# of the identity that is associated with the sending authorization
# policy that permits you to send for the email address specified in
# the `Source` parameter.
#
# For example, if the owner of `example.com` (which has ARN
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches
# a policy to it that authorizes you to send from `user@example.com`,
# then you would specify the `SourceArn` to be
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the
# `Source` to be `user@example.com`.
#
# For more information about sending authorization, see the [Amazon
# SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
# @return [String]
#
# @!attribute [rw] reply_to_addresses
# The reply-to email address(es) for the message. If the recipient
# replies to the message, each reply-to address will receive the
# reply.
# @return [Array<String>]
#
# @!attribute [rw] return_path
# The email address that bounces and complaints will be forwarded to
# when feedback forwarding is enabled. If the message cannot be
# delivered to the recipient, then an error message will be returned
# from the recipient's ISP; this message will then be forwarded to
# the email address specified by the `ReturnPath` parameter. The
# `ReturnPath` parameter is never overwritten. This email address must
# be either individually verified with Amazon SES, or from a domain
# that has been verified with Amazon SES.
# @return [String]
#
# @!attribute [rw] return_path_arn
# This parameter is used only for sending authorization. It is the ARN
# of the identity that is associated with the sending authorization
# policy that permits you to use the email address specified in the
# `ReturnPath` parameter.
#
# For example, if the owner of `example.com` (which has ARN
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches
# a policy to it that authorizes you to use `feedback@example.com`,
# then you would specify the `ReturnPathArn` to be
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the
# `ReturnPath` to be `feedback@example.com`.
#
# For more information about sending authorization, see the [Amazon
# SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
# @return [String]
#
# @!attribute [rw] configuration_set_name
# The name of the configuration set to use when you send an email
# using `SendBulkTemplatedEmail`.
# @return [String]
#
# @!attribute [rw] default_tags
# A list of tags, in the form of name/value pairs, to apply to an
# email that you send to a destination using `SendBulkTemplatedEmail`.
# @return [Array<Types::MessageTag>]
#
# @!attribute [rw] template
# The template to use when sending this email.
# @return [String]
#
# @!attribute [rw] template_arn
# The ARN of the template to use when sending this email.
# @return [String]
#
# @!attribute [rw] default_template_data
# 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.
# @return [String]
#
# @!attribute [rw] destinations
# One or more `Destination` objects. All of the recipients in a
# `Destination` will receive the same version of the email. You can
# specify up to 50 `Destination` objects within a `Destinations`
# array.
# @return [Array<Types::BulkEmailDestination>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendBulkTemplatedEmailRequest AWS API Documentation
#
class SendBulkTemplatedEmailRequest < Struct.new(
:source,
:source_arn,
:reply_to_addresses,
:return_path,
:return_path_arn,
:configuration_set_name,
:default_tags,
:template,
:template_arn,
:default_template_data,
:destinations)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] status
# The unique message identifier returned from the
# `SendBulkTemplatedEmail` action.
# @return [Array<Types::BulkEmailDestinationStatus>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendBulkTemplatedEmailResponse AWS API Documentation
#
class SendBulkTemplatedEmailResponse < Struct.new(
:status)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to send a custom verification email to a
# specified recipient.
#
# @!attribute [rw] email_address
# The email address to verify.
# @return [String]
#
# @!attribute [rw] template_name
# The name of the custom verification email template to use when
# sending the verification email.
# @return [String]
#
# @!attribute [rw] configuration_set_name
# Name of a configuration set to use when sending the verification
# email.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendCustomVerificationEmailRequest AWS API Documentation
#
class SendCustomVerificationEmailRequest < Struct.new(
:email_address,
:template_name,
:configuration_set_name)
SENSITIVE = []
include Aws::Structure
end
# The response received when attempting to send the custom verification
# email.
#
# @!attribute [rw] message_id
# The unique message identifier returned from the
# `SendCustomVerificationEmail` operation.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendCustomVerificationEmailResponse AWS API Documentation
#
class SendCustomVerificationEmailResponse < Struct.new(
:message_id)
SENSITIVE = []
include Aws::Structure
end
# Represents sending statistics data. Each `SendDataPoint` contains
# statistics for a 15-minute period of sending activity.
#
# @!attribute [rw] timestamp
# Time of the data point.
# @return [Time]
#
# @!attribute [rw] delivery_attempts
# Number of emails that have been sent.
# @return [Integer]
#
# @!attribute [rw] bounces
# Number of emails that have bounced.
# @return [Integer]
#
# @!attribute [rw] complaints
# Number of unwanted emails that were rejected by recipients.
# @return [Integer]
#
# @!attribute [rw] rejects
# Number of emails rejected by Amazon SES.
# @return [Integer]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendDataPoint AWS API Documentation
#
class SendDataPoint < Struct.new(
:timestamp,
:delivery_attempts,
:bounces,
:complaints,
:rejects)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to send a single formatted email using Amazon
# SES. For more information, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html
#
# @!attribute [rw] 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][1].
#
# 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][2].
#
# <note markdown="1"> Amazon SES does not support the SMTPUTF8 extension, as described in
# [RFC6531][3]. For this reason, the *local part* of a source email
# address (the part of the email address that precedes the @ sign) may
# only contain [7-bit ASCII characters][4]. If the *domain part* of an
# address (the part after the @ sign) contains non-ASCII characters,
# they must be encoded using Punycode, as described in [RFC3492][5].
# The sender name (also known as the *friendly name*) may contain
# non-ASCII characters. These characters must be encoded using MIME
# encoded-word syntax, as described in [RFC 2047][6]. MIME
# encoded-word syntax uses the following form:
# `=?charset?encoding?encoded-text?=`.
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
# [3]: https://tools.ietf.org/html/rfc6531
# [4]: https://en.wikipedia.org/wiki/Email_address#Local-part
# [5]: https://tools.ietf.org/html/rfc3492.html
# [6]: https://tools.ietf.org/html/rfc2047
# @return [String]
#
# @!attribute [rw] destination
# The destination for this email, composed of To:, CC:, and BCC:
# fields.
# @return [Types::Destination]
#
# @!attribute [rw] message
# The message to be sent.
# @return [Types::Message]
#
# @!attribute [rw] reply_to_addresses
# The reply-to email address(es) for the message. If the recipient
# replies to the message, each reply-to address will receive the
# reply.
# @return [Array<String>]
#
# @!attribute [rw] return_path
# The email address that bounces and complaints will be forwarded to
# when feedback forwarding is enabled. If the message cannot be
# delivered to the recipient, then an error message will be returned
# from the recipient's ISP; this message will then be forwarded to
# the email address specified by the `ReturnPath` parameter. The
# `ReturnPath` parameter is never overwritten. This email address must
# be either individually verified with Amazon SES, or from a domain
# that has been verified with Amazon SES.
# @return [String]
#
# @!attribute [rw] source_arn
# This parameter is used only for sending authorization. It is the ARN
# of the identity that is associated with the sending authorization
# policy that permits you to send for the email address specified in
# the `Source` parameter.
#
# For example, if the owner of `example.com` (which has ARN
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches
# a policy to it that authorizes you to send from `user@example.com`,
# then you would specify the `SourceArn` to be
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the
# `Source` to be `user@example.com`.
#
# For more information about sending authorization, see the [Amazon
# SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
# @return [String]
#
# @!attribute [rw] return_path_arn
# This parameter is used only for sending authorization. It is the ARN
# of the identity that is associated with the sending authorization
# policy that permits you to use the email address specified in the
# `ReturnPath` parameter.
#
# For example, if the owner of `example.com` (which has ARN
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches
# a policy to it that authorizes you to use `feedback@example.com`,
# then you would specify the `ReturnPathArn` to be
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the
# `ReturnPath` to be `feedback@example.com`.
#
# For more information about sending authorization, see the [Amazon
# SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
# @return [String]
#
# @!attribute [rw] 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.
# @return [Array<Types::MessageTag>]
#
# @!attribute [rw] configuration_set_name
# The name of the configuration set to use when you send an email
# using `SendEmail`.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendEmailRequest AWS API Documentation
#
class SendEmailRequest < Struct.new(
:source,
:destination,
:message,
:reply_to_addresses,
:return_path,
:source_arn,
:return_path_arn,
:tags,
:configuration_set_name)
SENSITIVE = []
include Aws::Structure
end
# Represents a unique message ID.
#
# @!attribute [rw] message_id
# The unique message identifier returned from the `SendEmail` action.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendEmailResponse AWS API Documentation
#
class SendEmailResponse < Struct.new(
:message_id)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to send a single raw email using Amazon SES. For
# more information, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html
#
# @!attribute [rw] 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.)
#
# <note markdown="1"> Amazon SES does not support the SMTPUTF8 extension, as described
# in[RFC6531][1]. For this reason, the *local part* of a source email
# address (the part of the email address that precedes the @ sign) may
# only contain [7-bit ASCII characters][2]. If the *domain part* of an
# address (the part after the @ sign) contains non-ASCII characters,
# they must be encoded using Punycode, as described in [RFC3492][3].
# The sender name (also known as the *friendly name*) may contain
# non-ASCII characters. These characters must be encoded using MIME
# encoded-word syntax, as described in [RFC 2047][4]. MIME
# encoded-word syntax uses the following form:
# `=?charset?encoding?encoded-text?=`.
#
# </note>
#
# If you specify the `Source` parameter and have feedback forwarding
# enabled, then bounces and complaints will be sent to this email
# address. This takes precedence over any Return-Path header that you
# might include in the raw text of the message.
#
#
#
# [1]: https://tools.ietf.org/html/rfc6531
# [2]: https://en.wikipedia.org/wiki/Email_address#Local-part
# [3]: https://tools.ietf.org/html/rfc3492.html
# [4]: https://tools.ietf.org/html/rfc2047
# @return [String]
#
# @!attribute [rw] destinations
# A list of destinations for the message, consisting of To:, CC:, and
# BCC: addresses.
# @return [Array<String>]
#
# @!attribute [rw] raw_message
# 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][1] 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][2] in the *Amazon SES Developer Guide*.
#
# * Per [RFC 5321][3], the maximum length of each line of text,
# including the <CRLF>, must not exceed 1,000 characters.
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mime-types.html
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html
# [3]: https://tools.ietf.org/html/rfc5321#section-4.5.3.1.6
# @return [Types::RawMessage]
#
# @!attribute [rw] from_arn
# 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.
#
# <note markdown="1"> For information about when to use this parameter, see the
# description of `SendRawEmail` in this guide, or see the [Amazon SES
# Developer Guide][1].
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html
# @return [String]
#
# @!attribute [rw] source_arn
# This parameter is used only for sending authorization. It is the ARN
# of the identity that is associated with the sending authorization
# policy that permits you to send for the email address specified in
# the `Source` parameter.
#
# For example, if the owner of `example.com` (which has ARN
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches
# a policy to it that authorizes you to send from `user@example.com`,
# then you would specify the `SourceArn` to be
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the
# `Source` to be `user@example.com`.
#
# Instead of using this parameter, you can use the X-header
# `X-SES-SOURCE-ARN` in the raw message of the email. If you use both
# the `SourceArn` parameter and the corresponding X-header, Amazon SES
# uses the value of the `SourceArn` parameter.
#
# <note markdown="1"> For information about when to use this parameter, see the
# description of `SendRawEmail` in this guide, or see the [Amazon SES
# Developer Guide][1].
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html
# @return [String]
#
# @!attribute [rw] return_path_arn
# This parameter is used only for sending authorization. It is the ARN
# of the identity that is associated with the sending authorization
# policy that permits you to use the email address specified in the
# `ReturnPath` parameter.
#
# For example, if the owner of `example.com` (which has ARN
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches
# a policy to it that authorizes you to use `feedback@example.com`,
# then you would specify the `ReturnPathArn` to be
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the
# `ReturnPath` to be `feedback@example.com`.
#
# Instead of using this parameter, you can use the X-header
# `X-SES-RETURN-PATH-ARN` in the raw message of the email. If you use
# both the `ReturnPathArn` parameter and the corresponding X-header,
# Amazon SES uses the value of the `ReturnPathArn` parameter.
#
# <note markdown="1"> For information about when to use this parameter, see the
# description of `SendRawEmail` in this guide, or see the [Amazon SES
# Developer Guide][1].
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-delegate-sender-tasks-email.html
# @return [String]
#
# @!attribute [rw] 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.
# @return [Array<Types::MessageTag>]
#
# @!attribute [rw] configuration_set_name
# The name of the configuration set to use when you send an email
# using `SendRawEmail`.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendRawEmailRequest AWS API Documentation
#
class SendRawEmailRequest < Struct.new(
:source,
:destinations,
:raw_message,
:from_arn,
:source_arn,
:return_path_arn,
:tags,
:configuration_set_name)
SENSITIVE = []
include Aws::Structure
end
# Represents a unique message ID.
#
# @!attribute [rw] message_id
# The unique message identifier returned from the `SendRawEmail`
# action.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendRawEmailResponse AWS API Documentation
#
class SendRawEmailResponse < Struct.new(
:message_id)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to send a templated email using Amazon SES. For
# more information, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html
#
# @!attribute [rw] 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][1].
#
# 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][2].
#
# <note markdown="1"> Amazon SES does not support the SMTPUTF8 extension, as described in
# [RFC6531][3]. For this reason, the *local part* of a source email
# address (the part of the email address that precedes the @ sign) may
# only contain [7-bit ASCII characters][4]. If the *domain part* of an
# address (the part after the @ sign) contains non-ASCII characters,
# they must be encoded using Punycode, as described in [RFC3492][5].
# The sender name (also known as the *friendly name*) may contain
# non-ASCII characters. These characters must be encoded using MIME
# encoded-word syntax, as described in[RFC 2047][6]. MIME encoded-word
# syntax uses the following form: `=?charset?encoding?encoded-text?=`.
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
# [3]: https://tools.ietf.org/html/rfc6531
# [4]: https://en.wikipedia.org/wiki/Email_address#Local-part
# [5]: https://tools.ietf.org/html/rfc3492.html
# [6]: https://tools.ietf.org/html/rfc2047
# @return [String]
#
# @!attribute [rw] 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.
# @return [Types::Destination]
#
# @!attribute [rw] reply_to_addresses
# The reply-to email address(es) for the message. If the recipient
# replies to the message, each reply-to address will receive the
# reply.
# @return [Array<String>]
#
# @!attribute [rw] return_path
# The email address that bounces and complaints will be forwarded to
# when feedback forwarding is enabled. If the message cannot be
# delivered to the recipient, then an error message will be returned
# from the recipient's ISP; this message will then be forwarded to
# the email address specified by the `ReturnPath` parameter. The
# `ReturnPath` parameter is never overwritten. This email address must
# be either individually verified with Amazon SES, or from a domain
# that has been verified with Amazon SES.
# @return [String]
#
# @!attribute [rw] source_arn
# This parameter is used only for sending authorization. It is the ARN
# of the identity that is associated with the sending authorization
# policy that permits you to send for the email address specified in
# the `Source` parameter.
#
# For example, if the owner of `example.com` (which has ARN
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches
# a policy to it that authorizes you to send from `user@example.com`,
# then you would specify the `SourceArn` to be
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the
# `Source` to be `user@example.com`.
#
# For more information about sending authorization, see the [Amazon
# SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
# @return [String]
#
# @!attribute [rw] return_path_arn
# This parameter is used only for sending authorization. It is the ARN
# of the identity that is associated with the sending authorization
# policy that permits you to use the email address specified in the
# `ReturnPath` parameter.
#
# For example, if the owner of `example.com` (which has ARN
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`) attaches
# a policy to it that authorizes you to use `feedback@example.com`,
# then you would specify the `ReturnPathArn` to be
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the
# `ReturnPath` to be `feedback@example.com`.
#
# For more information about sending authorization, see the [Amazon
# SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
# @return [String]
#
# @!attribute [rw] 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.
# @return [Array<Types::MessageTag>]
#
# @!attribute [rw] configuration_set_name
# The name of the configuration set to use when you send an email
# using `SendTemplatedEmail`.
# @return [String]
#
# @!attribute [rw] template
# The template to use when sending this email.
# @return [String]
#
# @!attribute [rw] template_arn
# The ARN of the template to use when sending this email.
# @return [String]
#
# @!attribute [rw] template_data
# 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.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendTemplatedEmailRequest AWS API Documentation
#
class SendTemplatedEmailRequest < Struct.new(
:source,
:destination,
:reply_to_addresses,
:return_path,
:source_arn,
:return_path_arn,
:tags,
:configuration_set_name,
:template,
:template_arn,
:template_data)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] message_id
# The unique message identifier returned from the `SendTemplatedEmail`
# action.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendTemplatedEmailResponse AWS API Documentation
#
class SendTemplatedEmailResponse < Struct.new(
:message_id)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to set a receipt rule set as the active receipt
# rule set. You use receipt rule sets to receive email with Amazon SES.
# For more information, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
#
# @!attribute [rw] rule_set_name
# The name of the receipt rule set to make active. Setting this value
# to null disables all email receiving.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetActiveReceiptRuleSetRequest AWS API Documentation
#
class SetActiveReceiptRuleSetRequest < Struct.new(
:rule_set_name)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetActiveReceiptRuleSetResponse AWS API Documentation
#
class SetActiveReceiptRuleSetResponse < Aws::EmptyStructure; end
# Represents a request to enable or disable Amazon SES Easy DKIM signing
# for an identity. For more information about setting up Easy DKIM, see
# the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
#
# @!attribute [rw] identity
# The identity for which DKIM signing should be enabled or disabled.
# @return [String]
#
# @!attribute [rw] dkim_enabled
# Sets whether DKIM signing is enabled for an identity. Set to `true`
# to enable DKIM signing for this identity; `false` to disable it.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetIdentityDkimEnabledRequest AWS API Documentation
#
class SetIdentityDkimEnabledRequest < Struct.new(
:identity,
:dkim_enabled)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetIdentityDkimEnabledResponse AWS API Documentation
#
class SetIdentityDkimEnabledResponse < Aws::EmptyStructure; end
# Represents a request to enable or disable whether Amazon SES forwards
# you bounce and complaint notifications through email. For information
# about email feedback forwarding, see the [Amazon SES Developer
# Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-email.html
#
# @!attribute [rw] identity
# The identity for which to set bounce and complaint notification
# forwarding. Examples: `user@example.com`, `example.com`.
# @return [String]
#
# @!attribute [rw] forwarding_enabled
# Sets whether Amazon SES will forward bounce and complaint
# notifications as email. `true` specifies that Amazon SES will
# forward bounce and complaint notifications as email, in addition to
# any Amazon SNS topic publishing otherwise specified. `false`
# specifies that Amazon SES will publish bounce and complaint
# notifications only through Amazon SNS. This value can only be set to
# `false` when Amazon SNS topics are set for both `Bounce` and
# `Complaint` notification types.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetIdentityFeedbackForwardingEnabledRequest AWS API Documentation
#
class SetIdentityFeedbackForwardingEnabledRequest < Struct.new(
:identity,
:forwarding_enabled)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetIdentityFeedbackForwardingEnabledResponse AWS API Documentation
#
class SetIdentityFeedbackForwardingEnabledResponse < Aws::EmptyStructure; end
# Represents a request to set whether Amazon SES includes the original
# email headers in the Amazon SNS notifications of a specified type. For
# information about notifications, see the [Amazon SES Developer
# Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-sns.html
#
# @!attribute [rw] identity
# The identity for which to enable or disable headers in
# notifications. Examples: `user@example.com`, `example.com`.
# @return [String]
#
# @!attribute [rw] notification_type
# The notification type for which to enable or disable headers in
# notifications.
# @return [String]
#
# @!attribute [rw] 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 will include headers in
# notifications, and a value of `false` specifies that Amazon SES will
# not include headers in notifications.
#
# This value can only be set when `NotificationType` is already set to
# use a particular Amazon SNS topic.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetIdentityHeadersInNotificationsEnabledRequest AWS API Documentation
#
class SetIdentityHeadersInNotificationsEnabledRequest < Struct.new(
:identity,
:notification_type,
:enabled)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetIdentityHeadersInNotificationsEnabledResponse AWS API Documentation
#
class SetIdentityHeadersInNotificationsEnabledResponse < Aws::EmptyStructure; end
# Represents a request to enable or disable the Amazon SES custom MAIL
# FROM domain setup for a verified identity. For information about using
# a custom MAIL FROM domain, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html
#
# @!attribute [rw] identity
# The verified identity for which you want to enable or disable the
# specified custom MAIL FROM domain.
# @return [String]
#
# @!attribute [rw] mail_from_domain
# The custom MAIL FROM domain that you want the verified identity to
# use. The MAIL FROM domain must 1) be a subdomain of the verified
# identity, 2) not be used in a "From" address if the MAIL FROM
# domain is the destination of email feedback forwarding (for more
# information, see the [Amazon SES Developer Guide][1]), and 3) not be
# used to receive emails. A value of `null` disables the custom MAIL
# FROM setting for the identity.
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html
# @return [String]
#
# @!attribute [rw] behavior_on_mx_failure
# The action that you want Amazon SES to take if it cannot
# successfully read the required MX record when you send an email. If
# you choose `UseDefaultValue`, Amazon SES will use amazonses.com (or
# a subdomain of that) as the MAIL FROM domain. If you choose
# `RejectMessage`, Amazon SES will return a
# `MailFromDomainNotVerified` error and not send the email.
#
# The action specified in `BehaviorOnMXFailure` is taken when the
# custom MAIL FROM domain setup is in the `Pending`, `Failed`, and
# `TemporaryFailure` states.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetIdentityMailFromDomainRequest AWS API Documentation
#
class SetIdentityMailFromDomainRequest < Struct.new(
:identity,
:mail_from_domain,
:behavior_on_mx_failure)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetIdentityMailFromDomainResponse AWS API Documentation
#
class SetIdentityMailFromDomainResponse < Aws::EmptyStructure; end
# Represents a request to specify the Amazon SNS topic to which Amazon
# SES will publish bounce, complaint, or delivery notifications for
# emails sent with that identity as the Source. For information about
# Amazon SES notifications, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications-via-sns.html
#
# @!attribute [rw] identity
# The identity (email address or domain) that you want to set the
# Amazon SNS topic for.
#
# You can only specify a verified identity for this parameter.
#
# You can specify an identity by using its name or by using its Amazon
# Resource Name (ARN). The following examples are all valid
# identities: `sender@example.com`, `example.com`,
# `arn:aws:ses:us-east-1:123456789012:identity/example.com`.
# @return [String]
#
# @!attribute [rw] notification_type
# The type of notifications that will be published to the specified
# Amazon SNS topic.
# @return [String]
#
# @!attribute [rw] sns_topic
# 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.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetIdentityNotificationTopicRequest AWS API Documentation
#
class SetIdentityNotificationTopicRequest < Struct.new(
:identity,
:notification_type,
:sns_topic)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetIdentityNotificationTopicResponse AWS API Documentation
#
class SetIdentityNotificationTopicResponse < Aws::EmptyStructure; end
# Represents a request to set the position of a receipt rule in a
# receipt rule set. You use receipt rule sets to receive email with
# Amazon SES. For more information, see the [Amazon SES Developer
# Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
#
# @!attribute [rw] rule_set_name
# The name of the receipt rule set that contains the receipt rule to
# reposition.
# @return [String]
#
# @!attribute [rw] rule_name
# The name of the receipt rule to reposition.
# @return [String]
#
# @!attribute [rw] after
# The name of the receipt rule after which to place the specified
# receipt rule.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetReceiptRulePositionRequest AWS API Documentation
#
class SetReceiptRulePositionRequest < Struct.new(
:rule_set_name,
:rule_name,
:after)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SetReceiptRulePositionResponse AWS API Documentation
#
class SetReceiptRulePositionResponse < Aws::EmptyStructure; end
# When included in a receipt rule, this action terminates the evaluation
# of the receipt rule set and, optionally, publishes a notification to
# Amazon Simple Notification Service (Amazon SNS).
#
# For information about setting a stop action in a receipt rule, see the
# [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-stop.html
#
# @!attribute [rw] scope
# The scope of the StopAction. The only acceptable value is `RuleSet`.
# @return [String]
#
# @!attribute [rw] topic_arn
# The Amazon Resource Name (ARN) of the Amazon SNS topic to notify
# when the stop action is taken. An example of an Amazon SNS topic ARN
# is `arn:aws:sns:us-west-2:123456789012:MyTopic`. For more
# information about Amazon SNS topics, see the [Amazon SNS Developer
# Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/StopAction AWS API Documentation
#
class StopAction < Struct.new(
:scope,
:topic_arn)
SENSITIVE = []
include Aws::Structure
end
# The content of the email, composed of a subject line, an HTML part,
# and a text-only part.
#
# @!attribute [rw] template_name
# The name of the template. You will refer to this name when you send
# email using the `SendTemplatedEmail` or `SendBulkTemplatedEmail`
# operations.
# @return [String]
#
# @!attribute [rw] subject_part
# The subject line of the email.
# @return [String]
#
# @!attribute [rw] text_part
# The email body that will be visible to recipients whose email
# clients do not display HTML.
# @return [String]
#
# @!attribute [rw] html_part
# The HTML body of the email.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/Template AWS API Documentation
#
class Template < Struct.new(
:template_name,
:subject_part,
:text_part,
:html_part)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the Template object you specified does not exist in
# your Amazon SES account.
#
# @!attribute [rw] template_name
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/TemplateDoesNotExistException AWS API Documentation
#
class TemplateDoesNotExistException < Struct.new(
:template_name)
SENSITIVE = []
include Aws::Structure
end
# Contains information about an email template.
#
# @!attribute [rw] name
# The name of the template.
# @return [String]
#
# @!attribute [rw] created_timestamp
# The time and date the template was created.
# @return [Time]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/TemplateMetadata AWS API Documentation
#
class TemplateMetadata < Struct.new(
:name,
:created_timestamp)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] template_name
# The name of the template that you want to render.
# @return [String]
#
# @!attribute [rw] template_data
# 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.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/TestRenderTemplateRequest AWS API Documentation
#
class TestRenderTemplateRequest < Struct.new(
:template_name,
:template_data)
SENSITIVE = []
include Aws::Structure
end
# @!attribute [rw] rendered_template
# The complete MIME message rendered by applying the data in the
# TemplateData parameter to the template specified in the TemplateName
# parameter.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/TestRenderTemplateResponse AWS API Documentation
#
class TestRenderTemplateResponse < Struct.new(
:rendered_template)
SENSITIVE = []
include Aws::Structure
end
# A domain that is used to redirect email recipients to an Amazon
# SES-operated domain. This domain captures open and click events
# generated by Amazon SES emails.
#
# For more information, see [Configuring Custom Domains to Handle Open
# and Click Tracking][1] in the *Amazon SES Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html
#
# @!attribute [rw] custom_redirect_domain
# The custom subdomain that will be used to redirect email recipients
# to the Amazon SES event tracking domain.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/TrackingOptions AWS API Documentation
#
class TrackingOptions < Struct.new(
:custom_redirect_domain)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the configuration set you specified already contains a
# TrackingOptions object.
#
# @!attribute [rw] configuration_set_name
# Indicates that a TrackingOptions object already exists in the
# specified configuration set.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/TrackingOptionsAlreadyExistsException AWS API Documentation
#
class TrackingOptionsAlreadyExistsException < Struct.new(
:configuration_set_name)
SENSITIVE = []
include Aws::Structure
end
# Indicates that the TrackingOptions object you specified does not
# exist.
#
# @!attribute [rw] configuration_set_name
# Indicates that a TrackingOptions object does not exist in the
# specified configuration set.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/TrackingOptionsDoesNotExistException AWS API Documentation
#
class TrackingOptionsDoesNotExistException < Struct.new(
:configuration_set_name)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to enable or disable the email sending
# capabilities for your entire Amazon SES account.
#
# @!attribute [rw] enabled
# Describes whether email sending is enabled or disabled for your
# Amazon SES account in the current AWS Region.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateAccountSendingEnabledRequest AWS API Documentation
#
class UpdateAccountSendingEnabledRequest < Struct.new(
:enabled)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to update the event destination of a
# configuration set. Configuration sets enable you to publish email
# sending events. For information about using configuration sets, see
# the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html
#
# @!attribute [rw] configuration_set_name
# The name of the configuration set that contains the event
# destination that you want to update.
# @return [String]
#
# @!attribute [rw] event_destination
# The event destination object that you want to apply to the specified
# configuration set.
# @return [Types::EventDestination]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateConfigurationSetEventDestinationRequest AWS API Documentation
#
class UpdateConfigurationSetEventDestinationRequest < Struct.new(
:configuration_set_name,
:event_destination)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateConfigurationSetEventDestinationResponse AWS API Documentation
#
class UpdateConfigurationSetEventDestinationResponse < Aws::EmptyStructure; end
# Represents a request to modify the reputation metric publishing
# settings for a configuration set.
#
# @!attribute [rw] configuration_set_name
# The name of the configuration set that you want to update.
# @return [String]
#
# @!attribute [rw] enabled
# Describes whether or not Amazon SES will publish reputation metrics
# for the configuration set, such as bounce and complaint rates, to
# Amazon CloudWatch.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateConfigurationSetReputationMetricsEnabledRequest AWS API Documentation
#
class UpdateConfigurationSetReputationMetricsEnabledRequest < Struct.new(
:configuration_set_name,
:enabled)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to enable or disable the email sending
# capabilities for a specific configuration set.
#
# @!attribute [rw] configuration_set_name
# The name of the configuration set that you want to update.
# @return [String]
#
# @!attribute [rw] enabled
# Describes whether email sending is enabled or disabled for the
# configuration set.
# @return [Boolean]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateConfigurationSetSendingEnabledRequest AWS API Documentation
#
class UpdateConfigurationSetSendingEnabledRequest < Struct.new(
:configuration_set_name,
:enabled)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to update the tracking options for a
# configuration set.
#
# @!attribute [rw] configuration_set_name
# The name of the configuration set for which you want to update the
# custom tracking domain.
# @return [String]
#
# @!attribute [rw] tracking_options
# A domain that is used to redirect email recipients to an Amazon
# SES-operated domain. This domain captures open and click events
# generated by Amazon SES emails.
#
# For more information, see [Configuring Custom Domains to Handle Open
# and Click Tracking][1] in the *Amazon SES Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html
# @return [Types::TrackingOptions]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateConfigurationSetTrackingOptionsRequest AWS API Documentation
#
class UpdateConfigurationSetTrackingOptionsRequest < Struct.new(
:configuration_set_name,
:tracking_options)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateConfigurationSetTrackingOptionsResponse AWS API Documentation
#
class UpdateConfigurationSetTrackingOptionsResponse < Aws::EmptyStructure; end
# Represents a request to update an existing custom verification email
# template.
#
# @!attribute [rw] template_name
# The name of the custom verification email template that you want to
# update.
# @return [String]
#
# @!attribute [rw] from_email_address
# The email address that the custom verification email is sent from.
# @return [String]
#
# @!attribute [rw] template_subject
# The subject line of the custom verification email.
# @return [String]
#
# @!attribute [rw] template_content
# 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][1] in the *Amazon SES
# Developer Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq
# @return [String]
#
# @!attribute [rw] success_redirection_url
# The URL that the recipient of the verification email is sent to if
# his or her address is successfully verified.
# @return [String]
#
# @!attribute [rw] failure_redirection_url
# The URL that the recipient of the verification email is sent to if
# his or her address is not successfully verified.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateCustomVerificationEmailTemplateRequest AWS API Documentation
#
class UpdateCustomVerificationEmailTemplateRequest < Struct.new(
:template_name,
:from_email_address,
:template_subject,
:template_content,
:success_redirection_url,
:failure_redirection_url)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to update a receipt rule. You use receipt rules
# to receive email with Amazon SES. For more information, see the
# [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html
#
# @!attribute [rw] rule_set_name
# The name of the receipt rule set that the receipt rule belongs to.
# @return [String]
#
# @!attribute [rw] rule
# A data structure that contains the updated receipt rule information.
# @return [Types::ReceiptRule]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateReceiptRuleRequest AWS API Documentation
#
class UpdateReceiptRuleRequest < Struct.new(
:rule_set_name,
:rule)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateReceiptRuleResponse AWS API Documentation
#
class UpdateReceiptRuleResponse < Aws::EmptyStructure; end
# @!attribute [rw] template
# The content of the email, composed of a subject line, an HTML part,
# and a text-only part.
# @return [Types::Template]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateTemplateRequest AWS API Documentation
#
class UpdateTemplateRequest < Struct.new(
:template)
SENSITIVE = []
include Aws::Structure
end
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/UpdateTemplateResponse AWS API Documentation
#
class UpdateTemplateResponse < Aws::EmptyStructure; end
# Represents a request to generate the CNAME records needed to set up
# Easy DKIM with Amazon SES. For more information about setting up Easy
# DKIM, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
#
# @!attribute [rw] domain
# The name of the domain to be verified for Easy DKIM signing.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/VerifyDomainDkimRequest AWS API Documentation
#
class VerifyDomainDkimRequest < Struct.new(
:domain)
SENSITIVE = []
include Aws::Structure
end
# Returns CNAME records that you must publish to the DNS server of your
# domain to set up Easy DKIM with Amazon SES.
#
# @!attribute [rw] dkim_tokens
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html
# @return [Array<String>]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/VerifyDomainDkimResponse AWS API Documentation
#
class VerifyDomainDkimResponse < Struct.new(
:dkim_tokens)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to begin Amazon SES domain verification and to
# generate the TXT records that you must publish to the DNS server of
# your domain to complete the verification. For information about domain
# verification, see the [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domains.html
#
# @!attribute [rw] domain
# The domain to be verified.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/VerifyDomainIdentityRequest AWS API Documentation
#
class VerifyDomainIdentityRequest < Struct.new(
:domain)
SENSITIVE = []
include Aws::Structure
end
# Returns a TXT record that you must publish to the DNS server of your
# domain to complete domain verification with Amazon SES.
#
# @!attribute [rw] verification_token
# A TXT record that you must place in the DNS settings of the domain
# to complete domain verification with Amazon SES.
#
# As Amazon SES searches for the TXT record, the domain's
# verification status is "Pending". When Amazon SES detects the
# record, the domain's verification status changes to "Success". If
# Amazon SES is unable to detect the record within 72 hours, the
# domain's verification status changes to "Failed." In that case,
# if you still want to verify the domain, you must restart the
# verification process from the beginning.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/VerifyDomainIdentityResponse AWS API Documentation
#
class VerifyDomainIdentityResponse < Struct.new(
:verification_token)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to begin email address verification with Amazon
# SES. For information about email address verification, see the [Amazon
# SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html
#
# @!attribute [rw] email_address
# The email address to be verified.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/VerifyEmailAddressRequest AWS API Documentation
#
class VerifyEmailAddressRequest < Struct.new(
:email_address)
SENSITIVE = []
include Aws::Structure
end
# Represents a request to begin email address verification with Amazon
# SES. For information about email address verification, see the [Amazon
# SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html
#
# @!attribute [rw] email_address
# The email address to be verified.
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/VerifyEmailIdentityRequest AWS API Documentation
#
class VerifyEmailIdentityRequest < Struct.new(
:email_address)
SENSITIVE = []
include Aws::Structure
end
# An empty element returned on a successful request.
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/VerifyEmailIdentityResponse AWS API Documentation
#
class VerifyEmailIdentityResponse < Aws::EmptyStructure; end
# When included in a receipt rule, this action calls Amazon WorkMail
# and, optionally, publishes a notification to Amazon Simple
# Notification Service (Amazon SNS). You will typically not use this
# action directly because Amazon WorkMail adds the rule automatically
# during its setup procedure.
#
# For information using a receipt rule to call Amazon WorkMail, see the
# [Amazon SES Developer Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-workmail.html
#
# @!attribute [rw] topic_arn
# The Amazon Resource Name (ARN) of the Amazon SNS topic to notify
# when the WorkMail action is called. An example of an Amazon SNS
# topic ARN is `arn:aws:sns:us-west-2:123456789012:MyTopic`. For more
# information about Amazon SNS topics, see the [Amazon SNS Developer
# Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html
# @return [String]
#
# @!attribute [rw] organization_arn
# The ARN of the Amazon WorkMail organization. An example of an Amazon
# WorkMail organization ARN is
# `arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7`.
# For information about Amazon WorkMail organizations, see the [Amazon
# WorkMail Administrator Guide][1].
#
#
#
# [1]: https://docs.aws.amazon.com/workmail/latest/adminguide/organizations_overview.html
# @return [String]
#
# @see http://docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/WorkmailAction AWS API Documentation
#
class WorkmailAction < Struct.new(
:topic_arn,
:organization_arn)
SENSITIVE = []
include Aws::Structure
end
end
end