ses/aws.sdk.kotlin.services.ses

Package-level declarations

Types

Link copied to clipboard
interface SesClient : SdkClient

This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version 2010-12-01. This document is best used in conjunction with the Amazon SES Developer Guide.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun SesClient.cloneReceiptRuleSet(crossinline block: CloneReceiptRuleSetRequest.Builder.() -> Unit): CloneReceiptRuleSetResponse

Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.

Link copied to clipboard
inline suspend fun SesClient.createConfigurationSet(crossinline block: CreateConfigurationSetRequest.Builder.() -> Unit): CreateConfigurationSetResponse

Creates a configuration set.

Link copied to clipboard
Link copied to clipboard
inline suspend fun SesClient.createConfigurationSetTrackingOptions(crossinline block: CreateConfigurationSetTrackingOptionsRequest.Builder.() -> Unit): CreateConfigurationSetTrackingOptionsResponse

Creates an association between a configuration set and a custom domain for open and click event tracking.

Link copied to clipboard
inline suspend fun SesClient.createCustomVerificationEmailTemplate(crossinline block: CreateCustomVerificationEmailTemplateRequest.Builder.() -> Unit): CreateCustomVerificationEmailTemplateResponse

Creates a new custom verification email template.

Link copied to clipboard
inline suspend fun SesClient.createReceiptFilter(crossinline block: CreateReceiptFilterRequest.Builder.() -> Unit): CreateReceiptFilterResponse

Creates a new IP address filter.

Link copied to clipboard
inline suspend fun SesClient.createReceiptRule(crossinline block: CreateReceiptRuleRequest.Builder.() -> Unit): CreateReceiptRuleResponse

Creates a receipt rule.

Link copied to clipboard
inline suspend fun SesClient.createReceiptRuleSet(crossinline block: CreateReceiptRuleSetRequest.Builder.() -> Unit): CreateReceiptRuleSetResponse

Creates an empty receipt rule set.

Link copied to clipboard
inline suspend fun SesClient.createTemplate(crossinline block: CreateTemplateRequest.Builder.() -> Unit): CreateTemplateResponse

Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation. For more information, see the Amazon SES Developer Guide.

Link copied to clipboard
inline suspend fun SesClient.deleteConfigurationSet(crossinline block: DeleteConfigurationSetRequest.Builder.() -> Unit): DeleteConfigurationSetResponse

Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

Link copied to clipboard
inline suspend fun SesClient.deleteConfigurationSetEventDestination(crossinline block: DeleteConfigurationSetEventDestinationRequest.Builder.() -> Unit): DeleteConfigurationSetEventDestinationResponse

Deletes 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.

Link copied to clipboard
inline suspend fun SesClient.deleteConfigurationSetTrackingOptions(crossinline block: DeleteConfigurationSetTrackingOptionsRequest.Builder.() -> Unit): DeleteConfigurationSetTrackingOptionsResponse

Deletes an association between a configuration set and a custom domain for open and click event tracking.

Link copied to clipboard
inline suspend fun SesClient.deleteCustomVerificationEmailTemplate(crossinline block: DeleteCustomVerificationEmailTemplateRequest.Builder.() -> Unit): DeleteCustomVerificationEmailTemplateResponse

Deletes an existing custom verification email template.

Link copied to clipboard
inline suspend fun SesClient.deleteIdentity(crossinline block: DeleteIdentityRequest.Builder.() -> Unit): DeleteIdentityResponse

Deletes the specified identity (an email address or a domain) from the list of verified identities.

Link copied to clipboard
inline suspend fun SesClient.deleteIdentityPolicy(crossinline block: DeleteIdentityPolicyRequest.Builder.() -> Unit): DeleteIdentityPolicyResponse

Deletes the specified sending authorization policy for the given identity (an email address or a domain). This operation returns successfully even if a policy with the specified name does not exist.

Link copied to clipboard
inline suspend fun SesClient.deleteReceiptFilter(crossinline block: DeleteReceiptFilterRequest.Builder.() -> Unit): DeleteReceiptFilterResponse

Deletes the specified IP address filter.

Link copied to clipboard
inline suspend fun SesClient.deleteReceiptRule(crossinline block: DeleteReceiptRuleRequest.Builder.() -> Unit): DeleteReceiptRuleResponse

Deletes the specified receipt rule.

Link copied to clipboard
inline suspend fun SesClient.deleteReceiptRuleSet(crossinline block: DeleteReceiptRuleSetRequest.Builder.() -> Unit): DeleteReceiptRuleSetResponse

Deletes the specified receipt rule set and all of the receipt rules it contains.

Link copied to clipboard
inline suspend fun SesClient.deleteTemplate(crossinline block: DeleteTemplateRequest.Builder.() -> Unit): DeleteTemplateResponse

Deletes an email template.

Link copied to clipboard
inline suspend fun SesClient.deleteVerifiedEmailAddress(crossinline block: DeleteVerifiedEmailAddressRequest.Builder.() -> Unit): DeleteVerifiedEmailAddressResponse

Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.

Link copied to clipboard
inline suspend fun SesClient.describeActiveReceiptRuleSet(crossinline block: DescribeActiveReceiptRuleSetRequest.Builder.() -> Unit): DescribeActiveReceiptRuleSetResponse

Returns the metadata and receipt rules for the receipt rule set that is currently active.

Link copied to clipboard
inline suspend fun SesClient.describeConfigurationSet(crossinline block: DescribeConfigurationSetRequest.Builder.() -> Unit): DescribeConfigurationSetResponse

Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

Link copied to clipboard
inline suspend fun SesClient.describeReceiptRule(crossinline block: DescribeReceiptRuleRequest.Builder.() -> Unit): DescribeReceiptRuleResponse

Returns the details of the specified receipt rule.

Link copied to clipboard
inline suspend fun SesClient.describeReceiptRuleSet(crossinline block: DescribeReceiptRuleSetRequest.Builder.() -> Unit): DescribeReceiptRuleSetResponse

Returns the details of the specified receipt rule set.

Link copied to clipboard
inline suspend fun SesClient.getAccountSendingEnabled(crossinline block: GetAccountSendingEnabledRequest.Builder.() -> Unit): GetAccountSendingEnabledResponse

Returns the email sending status of the Amazon SES account for the current Region.

Link copied to clipboard
inline suspend fun SesClient.getCustomVerificationEmailTemplate(crossinline block: GetCustomVerificationEmailTemplateRequest.Builder.() -> Unit): GetCustomVerificationEmailTemplateResponse

Returns the custom email verification template for the template name you specify.

Link copied to clipboard
inline suspend fun SesClient.getIdentityDkimAttributes(crossinline block: GetIdentityDkimAttributesRequest.Builder.() -> Unit): GetIdentityDkimAttributesResponse

Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.

Link copied to clipboard
inline suspend fun SesClient.getIdentityMailFromDomainAttributes(crossinline block: GetIdentityMailFromDomainAttributesRequest.Builder.() -> Unit): GetIdentityMailFromDomainAttributesResponse

Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).

Link copied to clipboard
inline suspend fun SesClient.getIdentityNotificationAttributes(crossinline block: GetIdentityNotificationAttributesRequest.Builder.() -> Unit): GetIdentityNotificationAttributesResponse

Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.

Link copied to clipboard
inline suspend fun SesClient.getIdentityPolicies(crossinline block: GetIdentityPoliciesRequest.Builder.() -> Unit): GetIdentityPoliciesResponse

Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.

Link copied to clipboard
inline suspend fun SesClient.getIdentityVerificationAttributes(crossinline block: GetIdentityVerificationAttributesRequest.Builder.() -> Unit): GetIdentityVerificationAttributesResponse

Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.

Link copied to clipboard
inline suspend fun SesClient.getSendQuota(crossinline block: GetSendQuotaRequest.Builder.() -> Unit): GetSendQuotaResponse

Provides the sending limits for the Amazon SES account.

Link copied to clipboard
inline suspend fun SesClient.getSendStatistics(crossinline block: GetSendStatisticsRequest.Builder.() -> Unit): GetSendStatisticsResponse

Provides sending statistics for the current Amazon Web Services Region. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.

Link copied to clipboard
inline suspend fun SesClient.getTemplate(crossinline block: GetTemplateRequest.Builder.() -> Unit): GetTemplateResponse

Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify.

Link copied to clipboard
inline suspend fun SesClient.listConfigurationSets(crossinline block: ListConfigurationSetsRequest.Builder.() -> Unit): ListConfigurationSetsResponse

Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.

Link copied to clipboard
inline suspend fun SesClient.listCustomVerificationEmailTemplates(crossinline block: ListCustomVerificationEmailTemplatesRequest.Builder.() -> Unit): ListCustomVerificationEmailTemplatesResponse

Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.

Link copied to clipboard
inline suspend fun SesClient.listIdentities(crossinline block: ListIdentitiesRequest.Builder.() -> Unit): ListIdentitiesResponse

Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status.

Link copied to clipboard
inline suspend fun SesClient.listIdentityPolicies(crossinline block: ListIdentityPoliciesRequest.Builder.() -> Unit): ListIdentityPoliciesResponse

Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This operation returns only a list. To get the actual policy content, use GetIdentityPolicies.

Link copied to clipboard
inline suspend fun SesClient.listReceiptFilters(crossinline block: ListReceiptFiltersRequest.Builder.() -> Unit): ListReceiptFiltersResponse

Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region.

Link copied to clipboard
inline suspend fun SesClient.listReceiptRuleSets(crossinline block: ListReceiptRuleSetsRequest.Builder.() -> Unit): ListReceiptRuleSetsResponse

Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region. If there are additional receipt rule sets to be retrieved, you receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries.

Link copied to clipboard
inline suspend fun SesClient.listTemplates(crossinline block: ListTemplatesRequest.Builder.() -> Unit): ListTemplatesResponse

Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.

Link copied to clipboard
inline suspend fun SesClient.listVerifiedEmailAddresses(crossinline block: ListVerifiedEmailAddressesRequest.Builder.() -> Unit): ListVerifiedEmailAddressesResponse

Deprecated. Use the ListIdentities operation to list the email addresses and domains associated with your account.

Link copied to clipboard
inline suspend fun SesClient.putConfigurationSetDeliveryOptions(crossinline block: PutConfigurationSetDeliveryOptionsRequest.Builder.() -> Unit): PutConfigurationSetDeliveryOptionsResponse

Adds or updates the delivery options for a configuration set.

Link copied to clipboard
inline suspend fun SesClient.putIdentityPolicy(crossinline block: PutIdentityPolicyRequest.Builder.() -> Unit): PutIdentityPolicyResponse

Adds or updates a sending authorization policy for the specified identity (an email address or a domain).

Link copied to clipboard
inline suspend fun SesClient.reorderReceiptRuleSet(crossinline block: ReorderReceiptRuleSetRequest.Builder.() -> Unit): ReorderReceiptRuleSetResponse

Reorders the receipt rules within a receipt rule set.

Link copied to clipboard
inline suspend fun SesClient.sendBounce(crossinline block: SendBounceRequest.Builder.() -> Unit): SendBounceResponse

Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this operation on an email up to 24 hours after you receive it.

Link copied to clipboard
inline suspend fun SesClient.sendBulkTemplatedEmail(crossinline block: SendBulkTemplatedEmailRequest.Builder.() -> Unit): SendBulkTemplatedEmailResponse

Composes an email message to multiple destinations. The message body is created using an email template.

Link copied to clipboard
inline suspend fun SesClient.sendCustomVerificationEmail(crossinline block: SendCustomVerificationEmailRequest.Builder.() -> Unit): SendCustomVerificationEmailResponse

Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.

Link copied to clipboard
inline suspend fun SesClient.sendEmail(crossinline block: SendEmailRequest.Builder.() -> Unit): SendEmailResponse

Composes an email message and immediately queues it for sending. To send email using this operation, your message must meet the following requirements:

Link copied to clipboard
inline suspend fun SesClient.sendRawEmail(crossinline block: SendRawEmailRequest.Builder.() -> Unit): SendRawEmailResponse

Composes an email message and immediately queues it for sending.

Link copied to clipboard
inline suspend fun SesClient.sendTemplatedEmail(crossinline block: SendTemplatedEmailRequest.Builder.() -> Unit): SendTemplatedEmailResponse

Composes an email message using an email template and immediately queues it for sending.

Link copied to clipboard
inline suspend fun SesClient.setActiveReceiptRuleSet(crossinline block: SetActiveReceiptRuleSetRequest.Builder.() -> Unit): SetActiveReceiptRuleSetResponse

Sets the specified receipt rule set as the active receipt rule set.

Link copied to clipboard
inline suspend fun SesClient.setIdentityDkimEnabled(crossinline block: SetIdentityDkimEnabledRequest.Builder.() -> Unit): SetIdentityDkimEnabledResponse

Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address.

Link copied to clipboard
inline suspend fun SesClient.setIdentityFeedbackForwardingEnabled(crossinline block: SetIdentityFeedbackForwardingEnabledRequest.Builder.() -> Unit): SetIdentityFeedbackForwardingEnabledResponse

Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.

Link copied to clipboard
inline suspend fun SesClient.setIdentityHeadersInNotificationsEnabled(crossinline block: SetIdentityHeadersInNotificationsEnabledRequest.Builder.() -> Unit): SetIdentityHeadersInNotificationsEnabledResponse

Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.

Link copied to clipboard
inline suspend fun SesClient.setIdentityMailFromDomain(crossinline block: SetIdentityMailFromDomainRequest.Builder.() -> Unit): SetIdentityMailFromDomainResponse

Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).

Link copied to clipboard
inline suspend fun SesClient.setIdentityNotificationTopic(crossinline block: SetIdentityNotificationTopicRequest.Builder.() -> Unit): SetIdentityNotificationTopicResponse

Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify.

Link copied to clipboard
inline suspend fun SesClient.setReceiptRulePosition(crossinline block: SetReceiptRulePositionRequest.Builder.() -> Unit): SetReceiptRulePositionResponse

Sets the position of the specified receipt rule in the receipt rule set.

Link copied to clipboard
inline suspend fun SesClient.testRenderTemplate(crossinline block: TestRenderTemplateRequest.Builder.() -> Unit): TestRenderTemplateResponse

Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.

Link copied to clipboard
inline suspend fun SesClient.updateAccountSendingEnabled(crossinline block: UpdateAccountSendingEnabledRequest.Builder.() -> Unit): UpdateAccountSendingEnabledResponse

Enables or disables email sending across your entire Amazon SES account in the current Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given Amazon Web Services Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds.

Link copied to clipboard
inline suspend fun SesClient.updateConfigurationSetEventDestination(crossinline block: UpdateConfigurationSetEventDestinationRequest.Builder.() -> Unit): UpdateConfigurationSetEventDestinationResponse

Updates the event destination of a configuration set. 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 Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.

inline suspend fun SesClient.updateConfigurationSetReputationMetricsEnabled(crossinline block: UpdateConfigurationSetReputationMetricsEnabledRequest.Builder.() -> Unit): UpdateConfigurationSetReputationMetricsEnabledResponse

Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds.

Link copied to clipboard
inline suspend fun SesClient.updateConfigurationSetSendingEnabled(crossinline block: UpdateConfigurationSetSendingEnabledRequest.Builder.() -> Unit): UpdateConfigurationSetSendingEnabledResponse

Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds.

Link copied to clipboard
inline suspend fun SesClient.updateConfigurationSetTrackingOptions(crossinline block: UpdateConfigurationSetTrackingOptionsRequest.Builder.() -> Unit): UpdateConfigurationSetTrackingOptionsResponse

Modifies an association between a configuration set and a custom domain for open and click event tracking.

Link copied to clipboard
inline suspend fun SesClient.updateCustomVerificationEmailTemplate(crossinline block: UpdateCustomVerificationEmailTemplateRequest.Builder.() -> Unit): UpdateCustomVerificationEmailTemplateResponse

Updates an existing custom verification email template.

Link copied to clipboard
inline suspend fun SesClient.updateReceiptRule(crossinline block: UpdateReceiptRuleRequest.Builder.() -> Unit): UpdateReceiptRuleResponse

Updates a receipt rule.

Link copied to clipboard
inline suspend fun SesClient.updateTemplate(crossinline block: UpdateTemplateRequest.Builder.() -> Unit): UpdateTemplateResponse

Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation. For more information, see the Amazon SES Developer Guide.

Link copied to clipboard
inline suspend fun SesClient.verifyDomainDkim(crossinline block: VerifyDomainDkimRequest.Builder.() -> Unit): VerifyDomainDkimResponse

Returns a set of DKIM tokens for a domain identity.

Link copied to clipboard
inline suspend fun SesClient.verifyDomainIdentity(crossinline block: VerifyDomainIdentityRequest.Builder.() -> Unit): VerifyDomainIdentityResponse

Adds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

Link copied to clipboard
inline suspend fun SesClient.verifyEmailAddress(crossinline block: VerifyEmailAddressRequest.Builder.() -> Unit): VerifyEmailAddressResponse

Deprecated. Use the VerifyEmailIdentity operation to verify a new email address.

Link copied to clipboard
inline suspend fun SesClient.verifyEmailIdentity(crossinline block: VerifyEmailIdentityRequest.Builder.() -> Unit): VerifyEmailIdentityResponse

Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address.

Link copied to clipboard
fun SesClient.withConfig(block: SesClient.Config.Builder.() -> Unit): SesClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.