types

package
v1.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 10, 2021 License: Apache-2.0 Imports: 3 Imported by: 33

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountDetails 

type AccountDetails struct {

	// Additional email addresses where updates are sent about your account review
	// process.
	AdditionalContactEmailAddresses []string

	// The language you would prefer for the case. The contact language can be one of
	// ENGLISH or JAPANESE.
	ContactLanguage ContactLanguage

	// The type of email your account is sending. The mail type can be one of the
	// following:
	//
	// * MARKETING – Most of your sending traffic is to keep your customers
	// informed of your latest offering.
	//
	// * TRANSACTIONAL – Most of your sending
	// traffic is to communicate during a transaction with a customer.
	MailType MailType

	// Information about the review of the latest details you submitted.
	ReviewDetails *ReviewDetails

	// A description of the types of email that you plan to send.
	UseCaseDescription *string

	// The URL of your website. This information helps us better understand the type of
	// content that you plan to send.
	WebsiteURL *string
}

An object that contains information about your account details.

type AccountSuspendedException 

type AccountSuspendedException struct {
	Message *string
}

The message can't be sent because the account's ability to send email has been permanently restricted.

func (*AccountSuspendedException) Error 

func (e *AccountSuspendedException) Error() string

func (*AccountSuspendedException) ErrorCode 

func (e *AccountSuspendedException) ErrorCode() string

func (*AccountSuspendedException) ErrorFault 

func (e *AccountSuspendedException) ErrorFault() smithy.ErrorFault

func (*AccountSuspendedException) ErrorMessage 

func (e *AccountSuspendedException) ErrorMessage() string

type AlreadyExistsException 

type AlreadyExistsException struct {
	Message *string
}

The resource specified in your request already exists.

func (*AlreadyExistsException) Error 

func (e *AlreadyExistsException) Error() string

func (*AlreadyExistsException) ErrorCode 

func (e *AlreadyExistsException) ErrorCode() string

func (*AlreadyExistsException) ErrorFault 

func (e *AlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*AlreadyExistsException) ErrorMessage 

func (e *AlreadyExistsException) ErrorMessage() string

type BadRequestException 

type BadRequestException struct {
	Message *string
}

The input you provided is invalid.

func (*BadRequestException) Error 

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode 

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault 

func (e *BadRequestException) ErrorFault() smithy.ErrorFault

func (*BadRequestException) ErrorMessage 

func (e *BadRequestException) ErrorMessage() string

type BehaviorOnMxFailure 

type BehaviorOnMxFailure string
const (
	BehaviorOnMxFailureUseDefaultValue BehaviorOnMxFailure = "USE_DEFAULT_VALUE"
	BehaviorOnMxFailureRejectMessage   BehaviorOnMxFailure = "REJECT_MESSAGE"
)

Enum values for BehaviorOnMxFailure

func (BehaviorOnMxFailure) Values added in v0.29.0 

func (BehaviorOnMxFailure) Values() []BehaviorOnMxFailure

Values returns all known values for BehaviorOnMxFailure. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BlacklistEntry 

type BlacklistEntry struct {

	// Additional information about the blacklisting event, as provided by the
	// blacklist maintainer.
	Description *string

	// The time when the blacklisting event occurred, shown in Unix time format.
	ListingTime *time.Time

	// The name of the blacklist that the IP address appears on.
	RblName *string
}

An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.

type Body 

type Body struct {

	// An object that represents the version of the message that is displayed in email
	// clients that support HTML. HTML messages can include formatted text, hyperlinks,
	// images, and more.
	Html *Content

	// An object that represents the version of the message that is displayed in email
	// clients that don't support HTML, or clients where the recipient has disabled
	// HTML rendering.
	Text *Content
}

Represents the body of the email message.

type BulkEmailContent 

type BulkEmailContent struct {

	// The template to use for the bulk email message.
	Template *Template
}

An object that contains the body of the message. You can specify a template message.

type BulkEmailEntry 

type BulkEmailEntry struct {

	// Represents the destination of the message, consisting of To:, CC:, and BCC:
	// fields. Amazon SES does not support the SMTPUTF8 extension, as described in
	// RFC6531 (https://tools.ietf.org/html/rfc6531). 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
	// (https://en.wikipedia.org/wiki/Email_address#Local-part). 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
	// (https://tools.ietf.org/html/rfc3492.html).
	//
	// This member is required.
	Destination *Destination

	// The ReplacementEmailContent associated with a BulkEmailEntry.
	ReplacementEmailContent *ReplacementEmailContent

	// A list of tags, in the form of name/value pairs, to apply to an email that you
	// send using the SendBulkTemplatedEmail operation. Tags correspond to
	// characteristics of the email that you define, so that you can publish email
	// sending events.
	ReplacementTags []MessageTag
}

type BulkEmailEntryResult 

type BulkEmailEntryResult struct {

	// A description of an error that prevented a message being sent using the
	// SendBulkTemplatedEmail operation.
	Error *string

	// The unique message identifier returned from the SendBulkTemplatedEmail
	// operation.
	MessageId *string

	// 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.
	//
	// * MESSAGE_REJECTED:
	// The message was rejected because it contained a virus.
	//
	// *
	// MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not
	// verified.
	//
	// * CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you
	// specified does not exist.
	//
	// * TEMPLATE_DOES_NOT_EXIST: The template you specified
	// does not exist.
	//
	// * ACCOUNT_SUSPENDED: Your account has been shut down because of
	// issues related to your email sending practices.
	//
	// * ACCOUNT_THROTTLED: The number
	// of emails you can send has been reduced because your account has exceeded its
	// allocated sending limit.
	//
	// * ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or
	// exceeded the maximum number of emails you can send from your account in a
	// 24-hour period.
	//
	// * INVALID_SENDING_POOL_NAME: The configuration set you
	// specified refers to an IP pool that does not exist.
	//
	// * ACCOUNT_SENDING_PAUSED:
	// Email sending for the Amazon SES account was disabled using the
	// UpdateAccountSendingEnabled
	// (https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateAccountSendingEnabled.html)
	// operation.
	//
	// * CONFIGURATION_SET_SENDING_PAUSED: Email sending for this
	// configuration set was disabled using the UpdateConfigurationSetSendingEnabled
	// (https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateConfigurationSetSendingEnabled.html)
	// operation.
	//
	// * INVALID_PARAMETER_VALUE: One or more of the parameters you
	// specified when calling this operation was invalid. See the error message for
	// additional information.
	//
	// * TRANSIENT_FAILURE: 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.
	Status BulkEmailStatus
}

The result of the SendBulkEmail operation of each specified BulkEmailEntry.

type BulkEmailStatus 

type BulkEmailStatus string
const (
	BulkEmailStatusSuccess                       BulkEmailStatus = "SUCCESS"
	BulkEmailStatusMessageRejected               BulkEmailStatus = "MESSAGE_REJECTED"
	BulkEmailStatusMailFromDomainNotVerified     BulkEmailStatus = "MAIL_FROM_DOMAIN_NOT_VERIFIED"
	BulkEmailStatusConfigurationSetNotFound      BulkEmailStatus = "CONFIGURATION_SET_NOT_FOUND"
	BulkEmailStatusTemplateNotFound              BulkEmailStatus = "TEMPLATE_NOT_FOUND"
	BulkEmailStatusAccountSuspended              BulkEmailStatus = "ACCOUNT_SUSPENDED"
	BulkEmailStatusAccountThrottled              BulkEmailStatus = "ACCOUNT_THROTTLED"
	BulkEmailStatusAccountDailyQuotaExceeded     BulkEmailStatus = "ACCOUNT_DAILY_QUOTA_EXCEEDED"
	BulkEmailStatusInvalidSendingPoolName        BulkEmailStatus = "INVALID_SENDING_POOL_NAME"
	BulkEmailStatusAccountSendingPaused          BulkEmailStatus = "ACCOUNT_SENDING_PAUSED"
	BulkEmailStatusConfigurationSetSendingPaused BulkEmailStatus = "CONFIGURATION_SET_SENDING_PAUSED"
	BulkEmailStatusInvalidParameter              BulkEmailStatus = "INVALID_PARAMETER"
	BulkEmailStatusTransientFailure              BulkEmailStatus = "TRANSIENT_FAILURE"
	BulkEmailStatusFailed                        BulkEmailStatus = "FAILED"
)

Enum values for BulkEmailStatus

func (BulkEmailStatus) Values added in v0.29.0 

func (BulkEmailStatus) Values() []BulkEmailStatus

Values returns all known values for BulkEmailStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type CloudWatchDestination 

type CloudWatchDestination struct {

	// An array of objects that define the dimensions to use when you send email events
	// to Amazon CloudWatch.
	//
	// This member is required.
	DimensionConfigurations []CloudWatchDimensionConfiguration
}

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

type CloudWatchDimensionConfiguration 

type CloudWatchDimensionConfiguration struct {

	// The default value of the dimension that is published to Amazon CloudWatch if you
	// don't provide the value of the dimension when you send an email. This value has
	// to meet the following criteria:
	//
	// * It can only contain ASCII letters (a–z, A–Z),
	// numbers (0–9), underscores (_), or dashes (-).
	//
	// * It can contain no more than
	// 256 characters.
	//
	// This member is required.
	DefaultDimensionValue *string

	// The name of an Amazon CloudWatch dimension associated with an email sending
	// metric. The name has to meet the following criteria:
	//
	// * It can only contain
	// ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
	//
	// * It
	// can contain no more than 256 characters.
	//
	// This member is required.
	DimensionName *string

	// The location where the Amazon SES API v2 finds the value of a dimension to
	// publish to Amazon CloudWatch. If you want to use the message tags that you
	// specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or
	// SendRawEmail API, choose messageTag. If you want to use your own email headers,
	// choose emailHeader. If you want to use link tags, choose linkTags.
	//
	// This member is required.
	DimensionValueSource DimensionValueSource
}

An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.

type ConcurrentModificationException 

type ConcurrentModificationException struct {
	Message *string
}

The resource is being modified by another operation or thread.

func (*ConcurrentModificationException) Error 

func (e *ConcurrentModificationException) Error() string

func (*ConcurrentModificationException) ErrorCode 

func (e *ConcurrentModificationException) ErrorCode() string

func (*ConcurrentModificationException) ErrorFault 

func (e *ConcurrentModificationException) ErrorFault() smithy.ErrorFault

func (*ConcurrentModificationException) ErrorMessage 

func (e *ConcurrentModificationException) ErrorMessage() string

type ConflictException 

type ConflictException struct {
	Message *string
}

If there is already an ongoing account details update under review.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type Contact added in v0.29.0 

type Contact struct {

	// The contact's email address.
	EmailAddress *string

	// A timestamp noting the last time the contact's information was updated.
	LastUpdatedTimestamp *time.Time

	// The default topic preferences applied to the contact.
	TopicDefaultPreferences []TopicPreference

	// The contact's preference for being opted-in to or opted-out of a topic.
	TopicPreferences []TopicPreference

	// A boolean value status noting if the contact is unsubscribed from all contact
	// list topics.
	UnsubscribeAll bool
}

A contact is the end-user who is receiving the email.

type ContactLanguage 

type ContactLanguage string
const (
	ContactLanguageEn ContactLanguage = "EN"
	ContactLanguageJa ContactLanguage = "JA"
)

Enum values for ContactLanguage

func (ContactLanguage) Values added in v0.29.0 

func (ContactLanguage) Values() []ContactLanguage

Values returns all known values for ContactLanguage. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ContactList added in v0.29.0 

type ContactList struct {

	// The name of the contact list.
	ContactListName *string

	// A timestamp noting the last time the contact list was updated.
	LastUpdatedTimestamp *time.Time
}

A list that contains contacts that have subscribed to a particular topic or topics.

type ContactListDestination added in v0.29.0 

type ContactListDestination struct {

	// >The type of action that you want to perform on the addresses. Acceptable
	// values:
	//
	// * PUT: add the addresses to the contact list. If the record already
	// exists, it will override it with the new value.
	//
	// * DELETE: remove the addresses
	// from the contact list.
	//
	// This member is required.
	ContactListImportAction ContactListImportAction

	// The name of the contact list.
	//
	// This member is required.
	ContactListName *string
}

An object that contains details about the action of a contact list.

type ContactListImportAction added in v0.29.0 

type ContactListImportAction string
const (
	ContactListImportActionDelete ContactListImportAction = "DELETE"
	ContactListImportActionPut    ContactListImportAction = "PUT"
)

Enum values for ContactListImportAction

func (ContactListImportAction) Values added in v0.29.0 

func (ContactListImportAction) Values() []ContactListImportAction

Values returns all known values for ContactListImportAction. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Content 

type Content struct {

	// The content of the message itself.
	//
	// This member is required.
	Data *string

	// The character set for the content. Because of the constraints of the SMTP
	// protocol, Amazon SES uses 7-bit ASCII by default. If the text includes
	// characters outside of the ASCII range, you have to specify a character set. For
	// example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.
	Charset *string
}

An object that represents the content of the email, and optionally a character set specification.

type CustomVerificationEmailTemplateMetadata 

type CustomVerificationEmailTemplateMetadata struct {

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

	// The email address that the custom verification email is sent from.
	FromEmailAddress *string

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

	// The name of the custom verification email template.
	TemplateName *string

	// The subject line of the custom verification email.
	TemplateSubject *string
}

Contains information about a custom verification email template.

type DailyVolume 

type DailyVolume struct {

	// An object that contains inbox placement metrics for a specified day in the
	// analysis period, broken out by the recipient's email provider.
	DomainIspPlacements []DomainIspPlacement

	// The date that the DailyVolume metrics apply to, in Unix time.
	StartDate *time.Time

	// An object that contains inbox placement metrics for a specific day in the
	// analysis period.
	VolumeStatistics *VolumeStatistics
}

An object that contains information about the volume of email sent on each day of the analysis period.

type DataFormat added in v0.29.0 

type DataFormat string
const (
	DataFormatCsv  DataFormat = "CSV"
	DataFormatJson DataFormat = "JSON"
)

Enum values for DataFormat

func (DataFormat) Values added in v0.29.0 

func (DataFormat) Values() []DataFormat

Values returns all known values for DataFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DedicatedIp 

type DedicatedIp struct {

	// An IPv4 address.
	//
	// This member is required.
	Ip *string

	// Indicates how complete the dedicated IP warm-up process is. When this value
	// equals 1, the address has completed the warm-up process and is ready for use.
	//
	// This member is required.
	WarmupPercentage *int32

	// The warm-up status of a dedicated IP address. The status can have one of the
	// following values:
	//
	// * IN_PROGRESS – The IP address isn't ready to use because the
	// dedicated IP warm-up process is ongoing.
	//
	// * DONE – The dedicated IP warm-up
	// process is complete, and the IP address is ready to use.
	//
	// This member is required.
	WarmupStatus WarmupStatus

	// The name of the dedicated IP pool that the IP address is associated with.
	PoolName *string
}

Contains information about a dedicated IP address that is associated with your Amazon SES account. To learn more about requesting dedicated IP addresses, see Requesting and Relinquishing Dedicated IP Addresses (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/dedicated-ip-case.html) in the Amazon SES Developer Guide.

type DeliverabilityDashboardAccountStatus 

type DeliverabilityDashboardAccountStatus string
const (
	DeliverabilityDashboardAccountStatusActive            DeliverabilityDashboardAccountStatus = "ACTIVE"
	DeliverabilityDashboardAccountStatusPendingExpiration DeliverabilityDashboardAccountStatus = "PENDING_EXPIRATION"
	DeliverabilityDashboardAccountStatusDisabled          DeliverabilityDashboardAccountStatus = "DISABLED"
)

Enum values for DeliverabilityDashboardAccountStatus

func (DeliverabilityDashboardAccountStatus) Values added in v0.29.0 

func (DeliverabilityDashboardAccountStatus) Values() []DeliverabilityDashboardAccountStatus

Values returns all known values for DeliverabilityDashboardAccountStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DeliverabilityTestReport 

type DeliverabilityTestReport struct {

	// The date and time when the predictive inbox placement test was created, in Unix
	// time format.
	CreateDate *time.Time

	// The status of the predictive inbox placement test. If the status is IN_PROGRESS,
	// then the predictive inbox placement test is currently running. Predictive inbox
	// placement tests are usually complete within 24 hours of creating the test. If
	// the status is COMPLETE, then the test is finished, and you can use the
	// GetDeliverabilityTestReport to view the results of the test.
	DeliverabilityTestStatus DeliverabilityTestStatus

	// The sender address that you specified for the predictive inbox placement test.
	FromEmailAddress *string

	// A unique string that identifies the predictive inbox placement test.
	ReportId *string

	// A name that helps you identify a predictive inbox placement test report.
	ReportName *string

	// The subject line for an email that you submitted in a predictive inbox placement
	// test.
	Subject *string
}

An object that contains metadata related to a predictive inbox placement test.

type DeliverabilityTestStatus 

type DeliverabilityTestStatus string
const (
	DeliverabilityTestStatusInProgress DeliverabilityTestStatus = "IN_PROGRESS"
	DeliverabilityTestStatusCompleted  DeliverabilityTestStatus = "COMPLETED"
)

Enum values for DeliverabilityTestStatus

func (DeliverabilityTestStatus) Values added in v0.29.0 

func (DeliverabilityTestStatus) Values() []DeliverabilityTestStatus

Values returns all known values for DeliverabilityTestStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DeliveryOptions 

type DeliveryOptions struct {

	// The name of the dedicated IP pool that you want to associate with the
	// configuration set.
	SendingPoolName *string

	// 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.
	TlsPolicy TlsPolicy
}

Used to associate a configuration set with a dedicated IP pool.

type Destination 

type Destination struct {

	// An array that contains the email addresses of the "BCC" (blind carbon copy)
	// recipients for the email.
	BccAddresses []string

	// An array that contains the email addresses of the "CC" (carbon copy) recipients
	// for the email.
	CcAddresses []string

	// An array that contains the email addresses of the "To" recipients for the email.
	ToAddresses []string
}

An object that describes the recipients for an email.

type DimensionValueSource 

type DimensionValueSource string
const (
	DimensionValueSourceMessageTag  DimensionValueSource = "MESSAGE_TAG"
	DimensionValueSourceEmailHeader DimensionValueSource = "EMAIL_HEADER"
	DimensionValueSourceLinkTag     DimensionValueSource = "LINK_TAG"
)

Enum values for DimensionValueSource

func (DimensionValueSource) Values added in v0.29.0 

func (DimensionValueSource) Values() []DimensionValueSource

Values returns all known values for DimensionValueSource. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DkimAttributes 

type DkimAttributes struct {

	// A string that indicates how DKIM was configured for the identity. There are two
	// possible values:
	//
	// * AWS_SES – Indicates that DKIM was configured for the
	// identity by using Easy DKIM
	// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html).
	//
	// *
	// EXTERNAL – Indicates that DKIM was configured for the identity by using Bring
	// Your Own DKIM (BYODKIM).
	SigningAttributesOrigin DkimSigningAttributesOrigin

	// If the value is true, then the messages that you send from the identity are
	// signed using DKIM. If the value is false, then the messages that you send from
	// the identity aren't DKIM-signed.
	SigningEnabled bool

	// Describes whether or not Amazon SES has successfully located the DKIM records in
	// the DNS records for the domain. The status can be one of the following:
	//
	// *
	// PENDING – The verification process was initiated, but Amazon SES hasn't yet
	// detected the DKIM records in the DNS configuration for the domain.
	//
	// * SUCCESS –
	// The verification process completed successfully.
	//
	// * FAILED – The verification
	// process failed. This typically occurs when Amazon SES fails to find the DKIM
	// records in the DNS configuration of the domain.
	//
	// * TEMPORARY_FAILURE – A
	// temporary issue is preventing Amazon SES from determining the DKIM
	// authentication status of the domain.
	//
	// * NOT_STARTED – The DKIM verification
	// process hasn't been initiated for the domain.
	Status DkimStatus

	// If you used Easy DKIM
	// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) to
	// configure DKIM authentication for the domain, then this object contains a set of
	// unique strings that you use to create a set of CNAME records that you add to the
	// DNS configuration for your domain. When Amazon SES detects these records in the
	// DNS configuration for your domain, the DKIM authentication process is complete.
	// If you configured DKIM authentication for the domain by providing your own
	// public-private key pair, then this object contains the selector for the public
	// key. Regardless of the DKIM authentication method you use, Amazon SES searches
	// for the appropriate records in the DNS configuration of the domain for up to 72
	// hours.
	Tokens []string
}

An object that contains information about the DKIM authentication status for an email identity. Amazon SES determines the authentication status by searching for specific records in the DNS configuration for the domain. If you used Easy DKIM (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain. If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity

type DkimSigningAttributes 

type DkimSigningAttributes struct {

	// A private key that's used to generate a DKIM signature. The private key must use
	// 1024-bit RSA encryption, and must be encoded using base64 encoding.
	//
	// This member is required.
	DomainSigningPrivateKey *string

	// A string that's used to identify a public key in the DNS configuration for a
	// domain.
	//
	// This member is required.
	DomainSigningSelector *string
}

An object that contains information about the tokens used for setting up Bring Your Own DKIM (BYODKIM).

type DkimSigningAttributesOrigin 

type DkimSigningAttributesOrigin string
const (
	DkimSigningAttributesOriginAwsSes   DkimSigningAttributesOrigin = "AWS_SES"
	DkimSigningAttributesOriginExternal DkimSigningAttributesOrigin = "EXTERNAL"
)

Enum values for DkimSigningAttributesOrigin

func (DkimSigningAttributesOrigin) Values added in v0.29.0 

func (DkimSigningAttributesOrigin) Values() []DkimSigningAttributesOrigin

Values returns all known values for DkimSigningAttributesOrigin. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DkimStatus 

type DkimStatus string
const (
	DkimStatusPending          DkimStatus = "PENDING"
	DkimStatusSuccess          DkimStatus = "SUCCESS"
	DkimStatusFailed           DkimStatus = "FAILED"
	DkimStatusTemporaryFailure DkimStatus = "TEMPORARY_FAILURE"
	DkimStatusNotStarted       DkimStatus = "NOT_STARTED"
)

Enum values for DkimStatus

func (DkimStatus) Values added in v0.29.0 

func (DkimStatus) Values() []DkimStatus

Values returns all known values for DkimStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DomainDeliverabilityCampaign 

type DomainDeliverabilityCampaign struct {

	// The unique identifier for the campaign. The Deliverability dashboard
	// automatically generates and assigns this identifier to a campaign.
	CampaignId *string

	// The percentage of email messages that were deleted by recipients, without being
	// opened first. Due to technical limitations, this value only includes recipients
	// who opened the message by using an email client that supports images.
	DeleteRate *float64

	// The major email providers who handled the email message.
	Esps []string

	// The first time, in Unix time format, when the email message was delivered to any
	// recipient's inbox. This value can help you determine how long it took for a
	// campaign to deliver an email message.
	FirstSeenDateTime *time.Time

	// The verified email address that the email message was sent from.
	FromAddress *string

	// The URL of an image that contains a snapshot of the email message that was sent.
	ImageUrl *string

	// The number of email messages that were delivered to recipients’ inboxes.
	InboxCount *int64

	// The last time, in Unix time format, when the email message was delivered to any
	// recipient's inbox. This value can help you determine how long it took for a
	// campaign to deliver an email message.
	LastSeenDateTime *time.Time

	// The projected number of recipients that the email message was sent to.
	ProjectedVolume *int64

	// The percentage of email messages that were opened and then deleted by
	// recipients. Due to technical limitations, this value only includes recipients
	// who opened the message by using an email client that supports images.
	ReadDeleteRate *float64

	// The percentage of email messages that were opened by recipients. Due to
	// technical limitations, this value only includes recipients who opened the
	// message by using an email client that supports images.
	ReadRate *float64

	// The IP addresses that were used to send the email message.
	SendingIps []string

	// The number of email messages that were delivered to recipients' spam or junk
	// mail folders.
	SpamCount *int64

	// The subject line, or title, of the email message.
	Subject *string
}

An object that contains the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

type DomainDeliverabilityTrackingOption 

type DomainDeliverabilityTrackingOption struct {

	// A verified domain that’s associated with your AWS account and currently has an
	// active Deliverability dashboard subscription.
	Domain *string

	// An object that contains information about the inbox placement data settings for
	// the domain.
	InboxPlacementTrackingOption *InboxPlacementTrackingOption

	// The date, in Unix time format, when you enabled the Deliverability dashboard for
	// the domain.
	SubscriptionStartDate *time.Time
}

An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.

type DomainIspPlacement 

type DomainIspPlacement struct {

	// The percentage of messages that were sent from the selected domain to the
	// specified email provider that arrived in recipients' inboxes.
	InboxPercentage *float64

	// The total number of messages that were sent from the selected domain to the
	// specified email provider that arrived in recipients' inboxes.
	InboxRawCount *int64

	// The name of the email provider that the inbox placement data applies to.
	IspName *string

	// The percentage of messages that were sent from the selected domain to the
	// specified email provider that arrived in recipients' spam or junk mail folders.
	SpamPercentage *float64

	// The total number of messages that were sent from the selected domain to the
	// specified email provider that arrived in recipients' spam or junk mail folders.
	SpamRawCount *int64
}

An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.

type EmailContent 

type EmailContent struct {

	// The raw email message. The message has to meet the following criteria:
	//
	// * The
	// message has to contain a header and a body, separated by one 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.
	//
	// * If you include
	// attachments, they must be in a file format that the Amazon SES API v2
	// supports.
	//
	// * 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, you should encode that content to ensure that recipients' email
	// clients render the message properly.
	//
	// * The length of any single line of text in
	// the message can't exceed 1,000 characters. This restriction is defined in RFC
	// 5321 (https://tools.ietf.org/html/rfc5321).
	Raw *RawMessage

	// The simple email message. The message consists of a subject and a message body.
	Simple *Message

	// The template to use for the email message.
	Template *Template
}

An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.

type EmailTemplateContent 

type EmailTemplateContent struct {

	// The HTML body of the email.
	Html *string

	// The subject line of the email.
	Subject *string

	// The email body that will be visible to recipients whose email clients do not
	// display HTML.
	Text *string
}

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

type EmailTemplateMetadata 

type EmailTemplateMetadata struct {

	// The time and date the template was created.
	CreatedTimestamp *time.Time

	// The name of the template.
	TemplateName *string
}

Contains information about an email template.

type EventDestination 

type EventDestination struct {

	// The types of events that Amazon SES sends to the specified event destinations.
	//
	// This member is required.
	MatchingEventTypes []EventType

	// A name that identifies the event destination.
	//
	// This member is required.
	Name *string

	// An object that defines an Amazon CloudWatch destination for email events. You
	// can use Amazon CloudWatch to monitor and gain insights on your email sending
	// metrics.
	CloudWatchDestination *CloudWatchDestination

	// If true, the event destination is enabled. When the event destination is
	// enabled, the specified event types are sent to the destinations in this
	// EventDestinationDefinition. If false, the event destination is disabled. When
	// the event destination is disabled, events aren't sent to the specified
	// destinations.
	Enabled bool

	// An object that defines an Amazon Kinesis Data Firehose destination for email
	// events. You can use Amazon Kinesis Data Firehose to stream data to other
	// services, such as Amazon S3 and Amazon Redshift.
	KinesisFirehoseDestination *KinesisFirehoseDestination

	// An object that defines an Amazon Pinpoint project destination for email events.
	// You can send email event data to a Amazon Pinpoint project to view metrics using
	// the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For
	// more information, see Transactional Messaging Charts
	// (https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html)
	// in the Amazon Pinpoint User Guide.
	PinpointDestination *PinpointDestination

	// An object that defines an Amazon SNS destination for email events. You can use
	// Amazon SNS to send notification when certain email events occur.
	SnsDestination *SnsDestination
}

In the Amazon SES API v2, events include message sends, deliveries, opens, clicks, bounces, complaints and delivery delays. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

type EventDestinationDefinition 

type EventDestinationDefinition struct {

	// An object that defines an Amazon CloudWatch destination for email events. You
	// can use Amazon CloudWatch to monitor and gain insights on your email sending
	// metrics.
	CloudWatchDestination *CloudWatchDestination

	// If true, the event destination is enabled. When the event destination is
	// enabled, the specified event types are sent to the destinations in this
	// EventDestinationDefinition. If false, the event destination is disabled. When
	// the event destination is disabled, events aren't sent to the specified
	// destinations.
	Enabled bool

	// An object that defines an Amazon Kinesis Data Firehose destination for email
	// events. You can use Amazon Kinesis Data Firehose to stream data to other
	// services, such as Amazon S3 and Amazon Redshift.
	KinesisFirehoseDestination *KinesisFirehoseDestination

	// An array that specifies which events the Amazon SES API v2 should send to the
	// destinations in this EventDestinationDefinition.
	MatchingEventTypes []EventType

	// An object that defines an Amazon Pinpoint project destination for email events.
	// You can send email event data to a Amazon Pinpoint project to view metrics using
	// the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For
	// more information, see Transactional Messaging Charts
	// (https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html)
	// in the Amazon Pinpoint User Guide.
	PinpointDestination *PinpointDestination

	// An object that defines an Amazon SNS destination for email events. You can use
	// Amazon SNS to send notification when certain email events occur.
	SnsDestination *SnsDestination
}

An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.

type EventType 

type EventType string
const (
	EventTypeSend             EventType = "SEND"
	EventTypeReject           EventType = "REJECT"
	EventTypeBounce           EventType = "BOUNCE"
	EventTypeComplaint        EventType = "COMPLAINT"
	EventTypeDelivery         EventType = "DELIVERY"
	EventTypeOpen             EventType = "OPEN"
	EventTypeClick            EventType = "CLICK"
	EventTypeRenderingFailure EventType = "RENDERING_FAILURE"
	EventTypeDeliveryDelay    EventType = "DELIVERY_DELAY"
	EventTypeSubscription     EventType = "SUBSCRIPTION"
)

Enum values for EventType

func (EventType) Values added in v0.29.0 

func (EventType) Values() []EventType

Values returns all known values for EventType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FailureInfo added in v0.29.0 

type FailureInfo struct {

	// A message about why the import job failed.
	ErrorMessage *string

	// An Amazon S3 presigned URL that contains all the failed records and related
	// information.
	FailedRecordsS3Url *string
}

An object that contains the failure details about an import job.

type IdentityInfo 

type IdentityInfo struct {

	// The address or domain of the identity.
	IdentityName *string

	// The email identity type. The identity type can be one of the following:
	//
	// *
	// EMAIL_ADDRESS – The identity is an email address.
	//
	// * DOMAIN – The identity is a
	// domain.
	//
	// * MANAGED_DOMAIN – The identity is a domain that is managed by AWS.
	IdentityType IdentityType

	// Indicates whether or not you can send email from the identity. An identity is an
	// email address or domain that you send email from. Before you can send email from
	// an identity, you have to demostrate that you own the identity, and that you
	// authorize Amazon SES to send email from that identity.
	SendingEnabled bool
}

Information about an email identity.

type IdentityType 

type IdentityType string
const (
	IdentityTypeEmailAddress  IdentityType = "EMAIL_ADDRESS"
	IdentityTypeDomain        IdentityType = "DOMAIN"
	IdentityTypeManagedDomain IdentityType = "MANAGED_DOMAIN"
)

Enum values for IdentityType

func (IdentityType) Values added in v0.29.0 

func (IdentityType) Values() []IdentityType

Values returns all known values for IdentityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ImportDataSource added in v0.29.0 

type ImportDataSource struct {

	// The data format of the import job's data source.
	//
	// This member is required.
	DataFormat DataFormat

	// An Amazon S3 URL in the format s3:///.
	//
	// This member is required.
	S3Url *string
}

An object that contains details about the data source of the import job.

type ImportDestination added in v0.29.0 

type ImportDestination struct {

	// An object that contains the action of the import job towards a contact list.
	ContactListDestination *ContactListDestination

	// An object that contains the action of the import job towards suppression list.
	SuppressionListDestination *SuppressionListDestination
}

An object that contains details about the resource destination the import job is going to target.

type ImportDestinationType added in v0.29.0 

type ImportDestinationType string
const (
	ImportDestinationTypeSuppressionList ImportDestinationType = "SUPPRESSION_LIST"
	ImportDestinationTypeContactList     ImportDestinationType = "CONTACT_LIST"
)

Enum values for ImportDestinationType

func (ImportDestinationType) Values added in v0.29.0 

func (ImportDestinationType) Values() []ImportDestinationType

Values returns all known values for ImportDestinationType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ImportJobSummary added in v0.29.0 

type ImportJobSummary struct {

	// The date and time when the import job was created.
	CreatedTimestamp *time.Time

	// An object that contains details about the resource destination the import job is
	// going to target.
	ImportDestination *ImportDestination

	// A string that represents the import job ID.
	JobId *string

	// The status of the import job.
	JobStatus JobStatus
}

A summary of the import job.

type InboxPlacementTrackingOption 

type InboxPlacementTrackingOption struct {

	// Specifies whether inbox placement data is being tracked for the domain.
	Global bool

	// An array of strings, one for each major email provider that the inbox placement
	// data applies to.
	TrackedIsps []string
}

An object that contains information about the inbox placement data settings for a verified domain that’s associated with your AWS account. This data is available only if you enabled the Deliverability dashboard for the domain.

type InvalidNextTokenException 

type InvalidNextTokenException struct {
	Message *string
}

The specified request includes an invalid or expired token.

func (*InvalidNextTokenException) Error 

func (e *InvalidNextTokenException) Error() string

func (*InvalidNextTokenException) ErrorCode 

func (e *InvalidNextTokenException) ErrorCode() string

func (*InvalidNextTokenException) ErrorFault 

func (e *InvalidNextTokenException) ErrorFault() smithy.ErrorFault

func (*InvalidNextTokenException) ErrorMessage 

func (e *InvalidNextTokenException) ErrorMessage() string

type IspPlacement 

type IspPlacement struct {

	// The name of the email provider that the inbox placement data applies to.
	IspName *string

	// An object that contains inbox placement metrics for a specific email provider.
	PlacementStatistics *PlacementStatistics
}

An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.

type JobStatus added in v0.29.0 

type JobStatus string
const (
	JobStatusCreated    JobStatus = "CREATED"
	JobStatusProcessing JobStatus = "PROCESSING"
	JobStatusCompleted  JobStatus = "COMPLETED"
	JobStatusFailed     JobStatus = "FAILED"
)

Enum values for JobStatus

func (JobStatus) Values added in v0.29.0 

func (JobStatus) Values() []JobStatus

Values returns all known values for JobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type KinesisFirehoseDestination 

type KinesisFirehoseDestination struct {

	// The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that
	// the Amazon SES API v2 sends email events to.
	//
	// This member is required.
	DeliveryStreamArn *string

	// The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses
	// to send email events to the Amazon Kinesis Data Firehose stream.
	//
	// This member is required.
	IamRoleArn *string
}

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.

type LimitExceededException 

type LimitExceededException struct {
	Message *string
}

There are too many instances of the specified resource type.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type ListContactsFilter added in v0.29.0 

type ListContactsFilter struct {

	// The status by which you are filtering: OPT_IN or OPT_OUT.
	FilteredStatus SubscriptionStatus

	// Used for filtering by a specific topic preference.
	TopicFilter *TopicFilter
}

A filter that can be applied to a list of contacts.

type ListManagementOptions added in v0.29.0 

type ListManagementOptions struct {

	// The name of the contact list.
	//
	// This member is required.
	ContactListName *string

	// The name of the topic.
	TopicName *string
}

An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

type MailFromAttributes 

type MailFromAttributes struct {

	// The action that you want to take if the required MX record can't be found when
	// you send an email. When you set this value to UseDefaultValue, the mail is sent
	// using amazonses.com as the MAIL FROM domain. When you set this value to
	// RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified error,
	// and doesn't attempt to deliver the email. These behaviors are taken when the
	// custom MAIL FROM domain configuration is in the Pending, Failed, and
	// TemporaryFailure states.
	//
	// This member is required.
	BehaviorOnMxFailure BehaviorOnMxFailure

	// The name of a domain that an email identity uses as a custom MAIL FROM domain.
	//
	// This member is required.
	MailFromDomain *string

	// The status of the MAIL FROM domain. This status can have the following
	// values:
	//
	// * PENDING – Amazon SES hasn't started searching for the MX record
	// yet.
	//
	// * SUCCESS – Amazon SES detected the required MX record for the MAIL FROM
	// domain.
	//
	// * FAILED – Amazon SES can't find the required MX record, or the record
	// no longer exists.
	//
	// * TEMPORARY_FAILURE – A temporary issue occurred, which
	// prevented Amazon SES from determining the status of the MAIL FROM domain.
	//
	// This member is required.
	MailFromDomainStatus MailFromDomainStatus
}

A list of attributes that are associated with a MAIL FROM domain.

type MailFromDomainNotVerifiedException 

type MailFromDomainNotVerifiedException struct {
	Message *string
}

The message can't be sent because the sending domain isn't verified.

func (*MailFromDomainNotVerifiedException) Error 

func (e *MailFromDomainNotVerifiedException) Error() string

func (*MailFromDomainNotVerifiedException) ErrorCode 

func (e *MailFromDomainNotVerifiedException) ErrorCode() string

func (*MailFromDomainNotVerifiedException) ErrorFault 

func (e *MailFromDomainNotVerifiedException) ErrorFault() smithy.ErrorFault

func (*MailFromDomainNotVerifiedException) ErrorMessage 

func (e *MailFromDomainNotVerifiedException) ErrorMessage() string

type MailFromDomainStatus 

type MailFromDomainStatus string
const (
	MailFromDomainStatusPending          MailFromDomainStatus = "PENDING"
	MailFromDomainStatusSuccess          MailFromDomainStatus = "SUCCESS"
	MailFromDomainStatusFailed           MailFromDomainStatus = "FAILED"
	MailFromDomainStatusTemporaryFailure MailFromDomainStatus = "TEMPORARY_FAILURE"
)

Enum values for MailFromDomainStatus

func (MailFromDomainStatus) Values added in v0.29.0 

func (MailFromDomainStatus) Values() []MailFromDomainStatus

Values returns all known values for MailFromDomainStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MailType 

type MailType string
const (
	MailTypeMarketing     MailType = "MARKETING"
	MailTypeTransactional MailType = "TRANSACTIONAL"
)

Enum values for MailType

func (MailType) Values added in v0.29.0 

func (MailType) Values() []MailType

Values returns all known values for MailType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Message 

type Message struct {

	// The body of the message. You can specify an HTML version of the message, a
	// text-only version of the message, or both.
	//
	// This member is required.
	Body *Body

	// The subject line of the email. The subject line can only contain 7-bit ASCII
	// characters. However, you can specify non-ASCII characters in the subject line by
	// using encoded-word syntax, as described in RFC 2047
	// (https://tools.ietf.org/html/rfc2047).
	//
	// This member is required.
	Subject *Content
}

Represents the email message that you're sending. The Message object consists of a subject line and a message body.

type MessageRejected 

type MessageRejected struct {
	Message *string
}

The message can't be sent because it contains invalid content.

func (*MessageRejected) Error 

func (e *MessageRejected) Error() string

func (*MessageRejected) ErrorCode 

func (e *MessageRejected) ErrorCode() string

func (*MessageRejected) ErrorFault 

func (e *MessageRejected) ErrorFault() smithy.ErrorFault

func (*MessageRejected) ErrorMessage 

func (e *MessageRejected) ErrorMessage() string

type MessageTag 

type MessageTag struct {

	// The name of the message tag. The message tag name has to meet the following
	// criteria:
	//
	// * It can only contain ASCII letters (a–z, A–Z), numbers (0–9),
	// underscores (_), or dashes (-).
	//
	// * It can contain no more than 256 characters.
	//
	// This member is required.
	Name *string

	// The value of the message tag. The message tag value has to meet the following
	// criteria:
	//
	// * It can only contain ASCII letters (a–z, A–Z), numbers (0–9),
	// underscores (_), or dashes (-).
	//
	// * It can contain no more than 256 characters.
	//
	// This member is required.
	Value *string
}

Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.

type NotFoundException 

type NotFoundException struct {
	Message *string
}

The resource you attempted to access doesn't exist.

func (*NotFoundException) Error 

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode 

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault 

func (e *NotFoundException) ErrorFault() smithy.ErrorFault

func (*NotFoundException) ErrorMessage 

func (e *NotFoundException) ErrorMessage() string

type OverallVolume 

type OverallVolume struct {

	// An object that contains inbox and junk mail placement metrics for individual
	// email providers.
	DomainIspPlacements []DomainIspPlacement

	// The percentage of emails that were sent from the domain that were read by their
	// recipients.
	ReadRatePercent *float64

	// An object that contains information about the numbers of messages that arrived
	// in recipients' inboxes and junk mail folders.
	VolumeStatistics *VolumeStatistics
}

An object that contains information about email that was sent from the selected domain.

type PinpointDestination 

type PinpointDestination struct {

	// The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to
	// send email events to.
	ApplicationArn *string
}

An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts (https://docs.aws.amazon.com/pinpoint/latest/userguide/analytics-transactional-messages.html) in the Amazon Pinpoint User Guide.

type PlacementStatistics 

type PlacementStatistics struct {

	// The percentage of emails that were authenticated by using DomainKeys Identified
	// Mail (DKIM) during the predictive inbox placement test.
	DkimPercentage *float64

	// The percentage of emails that arrived in recipients' inboxes during the
	// predictive inbox placement test.
	InboxPercentage *float64

	// The percentage of emails that didn't arrive in recipients' inboxes at all during
	// the predictive inbox placement test.
	MissingPercentage *float64

	// The percentage of emails that arrived in recipients' spam or junk mail folders
	// during the predictive inbox placement test.
	SpamPercentage *float64

	// The percentage of emails that were authenticated by using Sender Policy
	// Framework (SPF) during the predictive inbox placement test.
	SpfPercentage *float64
}

An object that contains inbox placement data for an email provider.

type RawMessage 

type RawMessage struct {

	// The raw email message. The message has to meet the following criteria:
	//
	// * The
	// message has to contain a header and a body, separated by one 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 in a
	// file format that the Amazon SES supports.
	//
	// * 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, you should encode that content to
	// ensure that recipients' email clients render the message properly.
	//
	// * The length
	// of any single line of text in the message can't exceed 1,000 characters. This
	// restriction is defined in RFC 5321 (https://tools.ietf.org/html/rfc5321).
	//
	// This member is required.
	Data []byte
}

Represents the raw content of an email message.

type ReplacementEmailContent 

type ReplacementEmailContent struct {

	// The ReplacementTemplate associated with ReplacementEmailContent.
	ReplacementTemplate *ReplacementTemplate
}

The ReplaceEmailContent object to be used for a specific BulkEmailEntry. The ReplacementTemplate can be specified within this object.

type ReplacementTemplate 

type ReplacementTemplate struct {

	// 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.
	ReplacementTemplateData *string
}

An object which contains ReplacementTemplateData to be used for a specific BulkEmailEntry.

type ReputationOptions 

type ReputationOptions struct {

	// The date and time (in Unix time) when the reputation metrics were last given a
	// fresh start. When your account is given a fresh start, your reputation metrics
	// are calculated starting from the date of the fresh start.
	LastFreshStart *time.Time

	// If true, tracking of reputation metrics is enabled for the configuration set. If
	// false, tracking of reputation metrics is disabled for the configuration set.
	ReputationMetricsEnabled bool
}

Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.

type ReviewDetails 

type ReviewDetails struct {

	// The associated support center case ID (if any).
	CaseId *string

	// The status of the latest review of your account. The status can be one of the
	// following:
	//
	// * PENDING – We have received your appeal and are in the process of
	// reviewing it.
	//
	// * GRANTED – Your appeal has been reviewed and your production
	// access has been granted.
	//
	// * DENIED – Your appeal has been reviewed and your
	// production access has been denied.
	//
	// * FAILED – An internal error occurred and we
	// didn't receive your appeal. You can submit your appeal again.
	Status ReviewStatus
}

An object that contains information about your account details review.

type ReviewStatus 

type ReviewStatus string
const (
	ReviewStatusPending ReviewStatus = "PENDING"
	ReviewStatusFailed  ReviewStatus = "FAILED"
	ReviewStatusGranted ReviewStatus = "GRANTED"
	ReviewStatusDenied  ReviewStatus = "DENIED"
)

Enum values for ReviewStatus

func (ReviewStatus) Values added in v0.29.0 

func (ReviewStatus) Values() []ReviewStatus

Values returns all known values for ReviewStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SendQuota 

type SendQuota struct {

	// The maximum number of emails that you can send in the current AWS Region over a
	// 24-hour period. This value is also called your sending quota.
	Max24HourSend float64

	// The maximum number of emails that you can send per second in the current AWS
	// Region. This value is also called your maximum sending rate or your maximum TPS
	// (transactions per second) rate.
	MaxSendRate float64

	// The number of emails sent from your Amazon SES account in the current AWS Region
	// over the past 24 hours.
	SentLast24Hours float64
}

An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current AWS Region.

type SendingOptions 

type SendingOptions struct {

	// If true, email sending is enabled for the configuration set. If false, email
	// sending is disabled for the configuration set.
	SendingEnabled bool
}

Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.

type SendingPausedException 

type SendingPausedException struct {
	Message *string
}

The message can't be sent because the account's ability to send email is currently paused.

func (*SendingPausedException) Error 

func (e *SendingPausedException) Error() string

func (*SendingPausedException) ErrorCode 

func (e *SendingPausedException) ErrorCode() string

func (*SendingPausedException) ErrorFault 

func (e *SendingPausedException) ErrorFault() smithy.ErrorFault

func (*SendingPausedException) ErrorMessage 

func (e *SendingPausedException) ErrorMessage() string

type SnsDestination 

type SnsDestination struct {

	// The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish
	// email events to. For more information about Amazon SNS topics, see the Amazon
	// SNS Developer Guide
	// (https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html).
	//
	// This member is required.
	TopicArn *string
}

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

type SubscriptionStatus added in v0.29.0 

type SubscriptionStatus string
const (
	SubscriptionStatusOptIn  SubscriptionStatus = "OPT_IN"
	SubscriptionStatusOptOut SubscriptionStatus = "OPT_OUT"
)

Enum values for SubscriptionStatus

func (SubscriptionStatus) Values added in v0.29.0 

func (SubscriptionStatus) Values() []SubscriptionStatus

Values returns all known values for SubscriptionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SuppressedDestination 

type SuppressedDestination struct {

	// The email address that is on the suppression list for your account.
	//
	// This member is required.
	EmailAddress *string

	// The date and time when the suppressed destination was last updated, shown in
	// Unix time format.
	//
	// This member is required.
	LastUpdateTime *time.Time

	// The reason that the address was added to the suppression list for your account.
	//
	// This member is required.
	Reason SuppressionListReason

	// An optional value that can contain additional information about the reasons that
	// the address was added to the suppression list for your account.
	Attributes *SuppressedDestinationAttributes
}

An object that contains information about an email address that is on the suppression list for your account.

type SuppressedDestinationAttributes 

type SuppressedDestinationAttributes struct {

	// A unique identifier that's generated when an email address is added to the
	// suppression list for your account.
	FeedbackId *string

	// The unique identifier of the email message that caused the email address to be
	// added to the suppression list for your account.
	MessageId *string
}

An object that contains additional attributes that are related an email address that is on the suppression list for your account.

type SuppressedDestinationSummary 

type SuppressedDestinationSummary struct {

	// The email address that's on the suppression list for your account.
	//
	// This member is required.
	EmailAddress *string

	// The date and time when the suppressed destination was last updated, shown in
	// Unix time format.
	//
	// This member is required.
	LastUpdateTime *time.Time

	// The reason that the address was added to the suppression list for your account.
	//
	// This member is required.
	Reason SuppressionListReason
}

A summary that describes the suppressed email address.

type SuppressionAttributes 

type SuppressionAttributes struct {

	// A list that contains the reasons that email addresses will be automatically
	// added to the suppression list for your account. This list can contain any or all
	// of the following:
	//
	// * COMPLAINT – Amazon SES adds an email address to the
	// suppression list for your account when a message sent to that address results in
	// a complaint.
	//
	// * BOUNCE – Amazon SES adds an email address to the suppression
	// list for your account when a message sent to that address results in a hard
	// bounce.
	SuppressedReasons []SuppressionListReason
}

An object that contains information about the email address suppression preferences for your account in the current AWS Region.

type SuppressionListDestination added in v0.29.0 

type SuppressionListDestination struct {

	// The type of action that you want to perform on the address. Acceptable
	// values:
	//
	// * PUT: add the addresses to the suppression list. If the record already
	// exists, it will override it with the new value.
	//
	// * DELETE: remove the addresses
	// from the suppression list.
	//
	// This member is required.
	SuppressionListImportAction SuppressionListImportAction
}

An object that contains details about the action of suppression list.

type SuppressionListImportAction added in v0.29.0 

type SuppressionListImportAction string
const (
	SuppressionListImportActionDelete SuppressionListImportAction = "DELETE"
	SuppressionListImportActionPut    SuppressionListImportAction = "PUT"
)

Enum values for SuppressionListImportAction

func (SuppressionListImportAction) Values added in v0.29.0 

func (SuppressionListImportAction) Values() []SuppressionListImportAction

Values returns all known values for SuppressionListImportAction. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SuppressionListReason 

type SuppressionListReason string
const (
	SuppressionListReasonBounce    SuppressionListReason = "BOUNCE"
	SuppressionListReasonComplaint SuppressionListReason = "COMPLAINT"
)

Enum values for SuppressionListReason

func (SuppressionListReason) Values added in v0.29.0 

func (SuppressionListReason) Values() []SuppressionListReason

Values returns all known values for SuppressionListReason. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SuppressionOptions 

type SuppressionOptions struct {

	// A list that contains the reasons that email addresses are automatically added to
	// the suppression list for your account. This list can contain any or all of the
	// following:
	//
	// * COMPLAINT – Amazon SES adds an email address to the suppression
	// list for your account when a message sent to that address results in a
	// complaint.
	//
	// * BOUNCE – Amazon SES adds an email address to the suppression list
	// for your account when a message sent to that address results in a hard bounce.
	SuppressedReasons []SuppressionListReason
}

An object that contains information about the suppression list preferences for your account.

type Tag 

type Tag struct {

	// One part of a key-value pair that defines a tag. The maximum length of a tag key
	// is 128 characters. The minimum length is 1 character.
	//
	// This member is required.
	Key *string

	// The optional part of a key-value pair that defines a tag. The maximum length of
	// a tag value is 256 characters. The minimum length is 0 characters. If you don't
	// want a resource to have a specific tag value, don't specify a value for this
	// parameter. If you don't specify a value, Amazon SES sets the value to an empty
	// string.
	//
	// This member is required.
	Value *string
}

An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags. Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:

* Tag keys and values are case sensitive.

* For each associated resource, each tag key must be unique and it can have only one value.

* The aws: prefix is reserved for use by AWS; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.

* You can associate tags with public or shared resources, but the tags are available only for your AWS account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified AWS Region for your AWS account.

type Template 

type Template struct {

	// The Amazon Resource Name (ARN) of the template.
	TemplateArn *string

	// An object that defines the values to use for message variables in the template.
	// This object is a set of key-value pairs. Each key defines a message variable in
	// the template. The corresponding value defines the value to use for that
	// variable.
	TemplateData *string

	// The name of the template. You will refer to this name when you send email using
	// the SendTemplatedEmail or SendBulkTemplatedEmail operations.
	TemplateName *string
}

An object that defines the email template to use for an email message, and the values to use for any message variables in that template. An email template is a type of message template that contains content that you want to define, save, and reuse in email messages that you send.

type TlsPolicy 

type TlsPolicy string
const (
	TlsPolicyRequire  TlsPolicy = "REQUIRE"
	TlsPolicyOptional TlsPolicy = "OPTIONAL"
)

Enum values for TlsPolicy

func (TlsPolicy) Values added in v0.29.0 

func (TlsPolicy) Values() []TlsPolicy

Values returns all known values for TlsPolicy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TooManyRequestsException 

type TooManyRequestsException struct {
	Message *string
}

Too many requests have been made to the operation.

func (*TooManyRequestsException) Error 

func (e *TooManyRequestsException) Error() string

func (*TooManyRequestsException) ErrorCode 

func (e *TooManyRequestsException) ErrorCode() string

func (*TooManyRequestsException) ErrorFault 

func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault

func (*TooManyRequestsException) ErrorMessage 

func (e *TooManyRequestsException) ErrorMessage() string

type Topic added in v0.29.0 

type Topic struct {

	// The default subscription status to be applied to a contact if the contact has
	// not noted their preference for subscribing to a topic.
	//
	// This member is required.
	DefaultSubscriptionStatus SubscriptionStatus

	// The name of the topic the contact will see.
	//
	// This member is required.
	DisplayName *string

	// The name of the topic.
	//
	// This member is required.
	TopicName *string

	// A description of what the topic is about, which the contact will see.
	Description *string
}

An interest group, theme, or label within a list. Lists can have multiple topics.

type TopicFilter added in v0.29.0 

type TopicFilter struct {

	// The name of a topic on which you wish to apply the filter.
	TopicName *string

	// Notes that the default subscription status should be applied to a contact
	// because the contact has not noted their preference for subscribing to a topic.
	UseDefaultIfPreferenceUnavailable bool
}

Used for filtering by a specific topic preference.

type TopicPreference added in v0.29.0 

type TopicPreference struct {

	// The contact's subscription status to a topic which is either OPT_IN or OPT_OUT.
	//
	// This member is required.
	SubscriptionStatus SubscriptionStatus

	// The name of the topic.
	//
	// This member is required.
	TopicName *string
}

The contact's preference for being opted-in to or opted-out of a topic.

type TrackingOptions 

type TrackingOptions struct {

	// The domain that you want to use for tracking open and click events.
	//
	// This member is required.
	CustomRedirectDomain *string
}

An object that defines the tracking options for a configuration set. When you use the Amazon SES API v2 to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them. These images and links include references to a domain operated by AWS. You can optionally configure the Amazon SES to use a domain that you operate for these images and links.

type VolumeStatistics 

type VolumeStatistics struct {

	// The total number of emails that arrived in recipients' inboxes.
	InboxRawCount *int64

	// An estimate of the percentage of emails sent from the current domain that will
	// arrive in recipients' inboxes.
	ProjectedInbox *int64

	// An estimate of the percentage of emails sent from the current domain that will
	// arrive in recipients' spam or junk mail folders.
	ProjectedSpam *int64

	// The total number of emails that arrived in recipients' spam or junk mail
	// folders.
	SpamRawCount *int64
}

An object that contains information about the amount of email that was delivered to recipients.

type WarmupStatus 

type WarmupStatus string
const (
	WarmupStatusInProgress WarmupStatus = "IN_PROGRESS"
	WarmupStatusDone       WarmupStatus = "DONE"
)

Enum values for WarmupStatus

func (WarmupStatus) Values added in v0.29.0 

func (WarmupStatus) Values() []WarmupStatus

Values returns all known values for WarmupStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.