com.amazonaws.services.simpleemail.AmazonSimpleEmailService Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ses Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.simpleemail;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.simpleemail.model.*;
import com.amazonaws.services.simpleemail.waiters.AmazonSimpleEmailServiceWaiters;
/**
* Interface for accessing Amazon SES.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.simpleemail.AbstractAmazonSimpleEmailService} instead.
*
*
* Amazon Simple Email Service
*
* 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.
*
*
*
* For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.
*
*
*
* This documentation contains reference information related to the following:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
* Common Errors
*
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonSimpleEmailService {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "email";
/**
* Overrides the default endpoint for this client ("https://email.us-east-1.amazonaws.com"). Callers can use this
* method to control which AWS region they want to work with.
*
* Callers can pass in just the endpoint (ex: "email.us-east-1.amazonaws.com") or a full URL, including the protocol
* (ex: "https://email.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from
* this client's {@link ClientConfiguration} will be used, which by default is HTTPS.
*
* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available
* endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection-
* choose-endpoint
*
* This method is not threadsafe. An endpoint should be configured when the client is created and before any
* service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in
* transit or retrying.
*
* @param endpoint
* The endpoint (ex: "email.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
* "https://email.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
* with.
* @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* An alternative to {@link AmazonSimpleEmailService#setEndpoint(String)}, sets the regional endpoint for this
* client's service calls. Callers can use this method to control which AWS region they want to work with.
*
* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
* {@link ClientConfiguration} supplied at construction.
*
* This method is not threadsafe. A region should be configured when the client is created and before any service
* requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit
* or retrying.
*
* @param region
* The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)}
* for accessing a given region. Must not be null and must be a region where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
*
* 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.
*
*
* For information about setting up rule sets, see the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param cloneReceiptRuleSetRequest
* Represents a request to create a receipt rule set by cloning an existing one. You use receipt rule sets to
* receive email with Amazon SES. For more information, see the Amazon SES Developer
* Guide.
* @return Result of the CloneReceiptRuleSet operation returned by the service.
* @throws RuleSetDoesNotExistException
* Indicates that the provided receipt rule set does not exist.
* @throws AlreadyExistsException
* Indicates that a resource could not be created because of a naming conflict.
* @throws LimitExceededException
* Indicates that a resource could not be created because of service limits. For a list of Amazon SES
* limits, see the Amazon SES
* Developer Guide.
* @sample AmazonSimpleEmailService.CloneReceiptRuleSet
* @see AWS API
* Documentation
*/
CloneReceiptRuleSetResult cloneReceiptRuleSet(CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest);
/**
*
* Creates a configuration set.
*
*
* Configuration sets enable you to publish email sending events. For information about using configuration sets,
* see the Amazon SES Developer
* Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param createConfigurationSetRequest
* Represents a request to create a configuration set. Configuration sets enable you to publish email sending
* events. For information about using configuration sets, see the Amazon SES Developer
* Guide.
* @return Result of the CreateConfigurationSet operation returned by the service.
* @throws ConfigurationSetAlreadyExistsException
* Indicates that the configuration set could not be created because of a naming conflict.
* @throws InvalidConfigurationSetException
* Indicates that the configuration set is invalid. See the error message for details.
* @throws LimitExceededException
* Indicates that a resource could not be created because of service limits. For a list of Amazon SES
* limits, see the Amazon SES
* Developer Guide.
* @sample AmazonSimpleEmailService.CreateConfigurationSet
* @see AWS
* API Documentation
*/
CreateConfigurationSetResult createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest);
/**
*
* Creates a configuration set event destination.
*
*
*
* When you create or update an event destination, you must provide one, and only one, destination. The destination
* can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
*
*
*
* An event destination is the Amazon Web Services service to which Amazon SES publishes the email sending events
* associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param createConfigurationSetEventDestinationRequest
* Represents a request to create a configuration set event destination. A configuration set event
* destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an Amazon Web
* Services service in which Amazon SES publishes the email sending events associated with a configuration
* set. For information about using configuration sets, see the Amazon SES Developer
* Guide.
* @return Result of the CreateConfigurationSetEventDestination operation returned by the service.
* @throws ConfigurationSetDoesNotExistException
* Indicates that the configuration set does not exist.
* @throws EventDestinationAlreadyExistsException
* Indicates that the event destination could not be created because of a naming conflict.
* @throws InvalidCloudWatchDestinationException
* Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.
* @throws InvalidFirehoseDestinationException
* Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.
* @throws InvalidSNSDestinationException
* Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error
* message for details.
* @throws LimitExceededException
* Indicates that a resource could not be created because of service limits. For a list of Amazon SES
* limits, see the Amazon SES
* Developer Guide.
* @sample AmazonSimpleEmailService.CreateConfigurationSetEventDestination
* @see AWS API Documentation
*/
CreateConfigurationSetEventDestinationResult createConfigurationSetEventDestination(
CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest);
/**
*
* Creates an association between a configuration set and a custom domain for open and click event tracking.
*
*
* By default, images and links used for tracking open and click events are hosted on domains operated by Amazon
* SES. You can configure a subdomain of your own to handle these events. For information about using custom
* domains, see the Amazon SES Developer
* Guide.
*
*
* @param createConfigurationSetTrackingOptionsRequest
* Represents a request to create an open and click tracking option object in a configuration set.
* @return Result of the CreateConfigurationSetTrackingOptions operation returned by the service.
* @throws ConfigurationSetDoesNotExistException
* Indicates that the configuration set does not exist.
* @throws TrackingOptionsAlreadyExistsException
* Indicates that the configuration set you specified already contains a TrackingOptions object.
* @throws InvalidTrackingOptionsException
* Indicates that the custom domain to be used for open and click tracking redirects is invalid. This error
* appears most often in the following situations:
*
* -
*
* When the tracking domain you specified is not verified in Amazon SES.
*
*
* -
*
* When the tracking domain you specified is not a valid domain or subdomain.
*
*
* @sample AmazonSimpleEmailService.CreateConfigurationSetTrackingOptions
* @see AWS API Documentation
*/
CreateConfigurationSetTrackingOptionsResult createConfigurationSetTrackingOptions(
CreateConfigurationSetTrackingOptionsRequest createConfigurationSetTrackingOptionsRequest);
/**
*
* Creates a new custom verification email template.
*
*
* For more information about custom verification email templates, see Using
* Custom Verification Email Templates in the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param createCustomVerificationEmailTemplateRequest
* Represents a request to create a custom verification email template.
* @return Result of the CreateCustomVerificationEmailTemplate operation returned by the service.
* @throws CustomVerificationEmailTemplateAlreadyExistsException
* Indicates that a custom verification email template with the name you specified already exists.
* @throws FromEmailAddressNotVerifiedException
* Indicates that the sender address specified for a custom verification email is not verified, and is
* therefore not eligible to send the custom verification email.
* @throws CustomVerificationEmailInvalidContentException
* Indicates that custom verification email template provided content is invalid.
* @throws LimitExceededException
* Indicates that a resource could not be created because of service limits. For a list of Amazon SES
* limits, see the Amazon SES
* Developer Guide.
* @sample AmazonSimpleEmailService.CreateCustomVerificationEmailTemplate
* @see AWS API Documentation
*/
CreateCustomVerificationEmailTemplateResult createCustomVerificationEmailTemplate(
CreateCustomVerificationEmailTemplateRequest createCustomVerificationEmailTemplateRequest);
/**
*
* Creates a new IP address filter.
*
*
* For information about setting up IP address filters, see the Amazon SES
* Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param createReceiptFilterRequest
* Represents a request to create a new IP address filter. You use IP address filters when you receive email
* with Amazon SES. For more information, see the Amazon SES Developer
* Guide.
* @return Result of the CreateReceiptFilter operation returned by the service.
* @throws LimitExceededException
* Indicates that a resource could not be created because of service limits. For a list of Amazon SES
* limits, see the Amazon SES
* Developer Guide.
* @throws AlreadyExistsException
* Indicates that a resource could not be created because of a naming conflict.
* @sample AmazonSimpleEmailService.CreateReceiptFilter
* @see AWS API
* Documentation
*/
CreateReceiptFilterResult createReceiptFilter(CreateReceiptFilterRequest createReceiptFilterRequest);
/**
*
* Creates a receipt rule.
*
*
* For information about setting up receipt rules, see the Amazon
* SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param createReceiptRuleRequest
* Represents a request to create a receipt rule. You use receipt rules to receive email with Amazon SES. For
* more information, see the Amazon SES Developer
* Guide.
* @return Result of the CreateReceiptRule operation returned by the service.
* @throws InvalidSnsTopicException
* Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the
* topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES
* Developer Guide.
* @throws InvalidS3ConfigurationException
* Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid, or
* that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information
* about giving permissions, see the Amazon SES
* Developer Guide.
* @throws InvalidLambdaFunctionException
* Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could not
* execute the provided function, possibly due to permissions issues. For information about giving
* permissions, see the Amazon SES
* Developer Guide.
* @throws AlreadyExistsException
* Indicates that a resource could not be created because of a naming conflict.
* @throws RuleDoesNotExistException
* Indicates that the provided receipt rule does not exist.
* @throws RuleSetDoesNotExistException
* Indicates that the provided receipt rule set does not exist.
* @throws LimitExceededException
* Indicates that a resource could not be created because of service limits. For a list of Amazon SES
* limits, see the Amazon SES
* Developer Guide.
* @sample AmazonSimpleEmailService.CreateReceiptRule
* @see AWS API
* Documentation
*/
CreateReceiptRuleResult createReceiptRule(CreateReceiptRuleRequest createReceiptRuleRequest);
/**
*
* Creates an empty receipt rule set.
*
*
* For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param createReceiptRuleSetRequest
* Represents a request to create an empty receipt rule set. You use receipt rule sets to receive email with
* Amazon SES. For more information, see the Amazon SES Developer
* Guide.
* @return Result of the CreateReceiptRuleSet operation returned by the service.
* @throws AlreadyExistsException
* Indicates that a resource could not be created because of a naming conflict.
* @throws LimitExceededException
* Indicates that a resource could not be created because of service limits. For a list of Amazon SES
* limits, see the Amazon SES
* Developer Guide.
* @sample AmazonSimpleEmailService.CreateReceiptRuleSet
* @see AWS API
* Documentation
*/
CreateReceiptRuleSetResult createReceiptRuleSet(CreateReceiptRuleSetRequest createReceiptRuleSetRequest);
/**
*
* 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.
*
*
* You can execute this operation no more than once per second.
*
*
* @param createTemplateRequest
* Represents a request to create an email template. For more information, see the Amazon SES Developer
* Guide.
* @return Result of the CreateTemplate operation returned by the service.
* @throws AlreadyExistsException
* Indicates that a resource could not be created because of a naming conflict.
* @throws InvalidTemplateException
* Indicates that the template that you specified could not be rendered. This issue may occur when a
* template refers to a partial that does not exist.
* @throws LimitExceededException
* Indicates that a resource could not be created because of service limits. For a list of Amazon SES
* limits, see the Amazon SES
* Developer Guide.
* @sample AmazonSimpleEmailService.CreateTemplate
* @see AWS API
* Documentation
*/
CreateTemplateResult createTemplate(CreateTemplateRequest createTemplateRequest);
/**
*
* 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.
*
*
* You can execute this operation no more than once per second.
*
*
* @param deleteConfigurationSetRequest
* Represents a request to delete a configuration set. Configuration sets enable you to publish email sending
* events. For information about using configuration sets, see the Amazon SES Developer
* Guide.
* @return Result of the DeleteConfigurationSet operation returned by the service.
* @throws ConfigurationSetDoesNotExistException
* Indicates that the configuration set does not exist.
* @sample AmazonSimpleEmailService.DeleteConfigurationSet
* @see AWS
* API Documentation
*/
DeleteConfigurationSetResult deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest);
/**
*
* 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.
*
*
* You can execute this operation no more than once per second.
*
*
* @param deleteConfigurationSetEventDestinationRequest
* Represents a request to delete a configuration set event destination. Configuration set event destinations
* are associated with configuration sets, which enable you to publish email sending events. For information
* about using configuration sets, see the Amazon SES Developer
* Guide.
* @return Result of the DeleteConfigurationSetEventDestination operation returned by the service.
* @throws ConfigurationSetDoesNotExistException
* Indicates that the configuration set does not exist.
* @throws EventDestinationDoesNotExistException
* Indicates that the event destination does not exist.
* @sample AmazonSimpleEmailService.DeleteConfigurationSetEventDestination
* @see AWS API Documentation
*/
DeleteConfigurationSetEventDestinationResult deleteConfigurationSetEventDestination(
DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest);
/**
*
* Deletes an association between a configuration set and a custom domain for open and click event tracking.
*
*
* By default, images and links used for tracking open and click events are hosted on domains operated by Amazon
* SES. You can configure a subdomain of your own to handle these events. For information about using custom
* domains, see the Amazon SES Developer
* Guide.
*
*
*
* Deleting this kind of association results in emails sent using the specified configuration set to capture open
* and click events using the standard, Amazon SES-operated domains.
*
*
*
* @param deleteConfigurationSetTrackingOptionsRequest
* Represents a request to delete open and click tracking options in a configuration set.
* @return Result of the DeleteConfigurationSetTrackingOptions operation returned by the service.
* @throws ConfigurationSetDoesNotExistException
* Indicates that the configuration set does not exist.
* @throws TrackingOptionsDoesNotExistException
* Indicates that the TrackingOptions object you specified does not exist.
* @sample AmazonSimpleEmailService.DeleteConfigurationSetTrackingOptions
* @see AWS API Documentation
*/
DeleteConfigurationSetTrackingOptionsResult deleteConfigurationSetTrackingOptions(
DeleteConfigurationSetTrackingOptionsRequest deleteConfigurationSetTrackingOptionsRequest);
/**
*
* Deletes an existing custom verification email template.
*
*
* For more information about custom verification email templates, see Using
* Custom Verification Email Templates in the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param deleteCustomVerificationEmailTemplateRequest
* Represents a request to delete an existing custom verification email template.
* @return Result of the DeleteCustomVerificationEmailTemplate operation returned by the service.
* @sample AmazonSimpleEmailService.DeleteCustomVerificationEmailTemplate
* @see AWS API Documentation
*/
DeleteCustomVerificationEmailTemplateResult deleteCustomVerificationEmailTemplate(
DeleteCustomVerificationEmailTemplateRequest deleteCustomVerificationEmailTemplateRequest);
/**
*
* Deletes the specified identity (an email address or a domain) from the list of verified identities.
*
*
* You can execute this operation no more than once per second.
*
*
* @param deleteIdentityRequest
* Represents a request to delete one of your Amazon SES identities (an email address or domain).
* @return Result of the DeleteIdentity operation returned by the service.
* @sample AmazonSimpleEmailService.DeleteIdentity
* @see AWS API
* Documentation
*/
DeleteIdentityResult deleteIdentity(DeleteIdentityRequest deleteIdentityRequest);
/**
*
* 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.
*
*
*
* This operation is for the identity owner only. If you have not verified the identity, it returns an error.
*
*
*
* Sending authorization is a feature that enables an identity owner to authorize other senders to use its
* identities. For information about using sending authorization, see the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param deleteIdentityPolicyRequest
* Represents a request to delete a sending authorization policy for an identity. Sending authorization is an
* Amazon SES feature that enables you to authorize other senders to use your identities. For information,
* see the Amazon SES
* Developer Guide.
* @return Result of the DeleteIdentityPolicy operation returned by the service.
* @sample AmazonSimpleEmailService.DeleteIdentityPolicy
* @see AWS API
* Documentation
*/
DeleteIdentityPolicyResult deleteIdentityPolicy(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest);
/**
*
* Deletes the specified IP address filter.
*
*
* For information about managing IP address filters, see the Amazon SES
* Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param deleteReceiptFilterRequest
* Represents a request to delete an IP address filter. You use IP address filters when you receive email
* with Amazon SES. For more information, see the Amazon SES Developer
* Guide.
* @return Result of the DeleteReceiptFilter operation returned by the service.
* @sample AmazonSimpleEmailService.DeleteReceiptFilter
* @see AWS API
* Documentation
*/
DeleteReceiptFilterResult deleteReceiptFilter(DeleteReceiptFilterRequest deleteReceiptFilterRequest);
/**
*
* Deletes the specified receipt rule.
*
*
* For information about managing receipt rules, see the Amazon
* SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param deleteReceiptRuleRequest
* Represents a request to delete a receipt rule. You use receipt rules to receive email with Amazon SES. For
* more information, see the Amazon SES Developer
* Guide.
* @return Result of the DeleteReceiptRule operation returned by the service.
* @throws RuleSetDoesNotExistException
* Indicates that the provided receipt rule set does not exist.
* @sample AmazonSimpleEmailService.DeleteReceiptRule
* @see AWS API
* Documentation
*/
DeleteReceiptRuleResult deleteReceiptRule(DeleteReceiptRuleRequest deleteReceiptRuleRequest);
/**
*
* Deletes the specified receipt rule set and all of the receipt rules it contains.
*
*
*
* The currently active rule set cannot be deleted.
*
*
*
* For information about managing receipt rule sets, see the Amazon
* SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param deleteReceiptRuleSetRequest
* Represents a request to delete a receipt rule set and all of the receipt rules it contains. You use
* receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer
* Guide.
* @return Result of the DeleteReceiptRuleSet operation returned by the service.
* @throws CannotDeleteException
* Indicates that the delete operation could not be completed.
* @sample AmazonSimpleEmailService.DeleteReceiptRuleSet
* @see AWS API
* Documentation
*/
DeleteReceiptRuleSetResult deleteReceiptRuleSet(DeleteReceiptRuleSetRequest deleteReceiptRuleSetRequest);
/**
*
* Deletes an email template.
*
*
* You can execute this operation no more than once per second.
*
*
* @param deleteTemplateRequest
* Represents a request to delete an email template. For more information, see the Amazon SES Developer
* Guide.
* @return Result of the DeleteTemplate operation returned by the service.
* @sample AmazonSimpleEmailService.DeleteTemplate
* @see AWS API
* Documentation
*/
DeleteTemplateResult deleteTemplate(DeleteTemplateRequest deleteTemplateRequest);
/**
*
* Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.
*
*
* @param deleteVerifiedEmailAddressRequest
* Represents a request to delete an email address from the list of email addresses you have attempted to
* verify under your Amazon Web Services account.
* @return Result of the DeleteVerifiedEmailAddress operation returned by the service.
* @sample AmazonSimpleEmailService.DeleteVerifiedEmailAddress
* @see AWS API Documentation
*/
DeleteVerifiedEmailAddressResult deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest);
/**
*
* Returns the metadata and receipt rules for the receipt rule set that is currently active.
*
*
* For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param describeActiveReceiptRuleSetRequest
* Represents a request to return the metadata and receipt rules for the receipt rule set that is currently
* active. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer
* Guide.
* @return Result of the DescribeActiveReceiptRuleSet operation returned by the service.
* @sample AmazonSimpleEmailService.DescribeActiveReceiptRuleSet
* @see AWS API Documentation
*/
DescribeActiveReceiptRuleSetResult describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest describeActiveReceiptRuleSetRequest);
/**
*
* Returns the details of the specified configuration set. For information about using configuration sets, see the
* Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param describeConfigurationSetRequest
* Represents a request to return the details of a configuration set. Configuration sets enable you to
* publish email sending events. For information about using configuration sets, see the Amazon SES Developer
* Guide.
* @return Result of the DescribeConfigurationSet operation returned by the service.
* @throws ConfigurationSetDoesNotExistException
* Indicates that the configuration set does not exist.
* @sample AmazonSimpleEmailService.DescribeConfigurationSet
* @see AWS
* API Documentation
*/
DescribeConfigurationSetResult describeConfigurationSet(DescribeConfigurationSetRequest describeConfigurationSetRequest);
/**
*
* Returns the details of the specified receipt rule.
*
*
* For information about setting up receipt rules, see the Amazon
* SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param describeReceiptRuleRequest
* Represents a request to return the details of a receipt rule. You use receipt rules to receive email with
* Amazon SES. For more information, see the Amazon SES Developer
* Guide.
* @return Result of the DescribeReceiptRule operation returned by the service.
* @throws RuleDoesNotExistException
* Indicates that the provided receipt rule does not exist.
* @throws RuleSetDoesNotExistException
* Indicates that the provided receipt rule set does not exist.
* @sample AmazonSimpleEmailService.DescribeReceiptRule
* @see AWS API
* Documentation
*/
DescribeReceiptRuleResult describeReceiptRule(DescribeReceiptRuleRequest describeReceiptRuleRequest);
/**
*
* Returns the details of the specified receipt rule set.
*
*
* For information about managing receipt rule sets, see the Amazon
* SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param describeReceiptRuleSetRequest
* Represents a request to return the details of a receipt rule set. You use receipt rule sets to receive
* email with Amazon SES. For more information, see the Amazon SES Developer
* Guide.
* @return Result of the DescribeReceiptRuleSet operation returned by the service.
* @throws RuleSetDoesNotExistException
* Indicates that the provided receipt rule set does not exist.
* @sample AmazonSimpleEmailService.DescribeReceiptRuleSet
* @see AWS
* API Documentation
*/
DescribeReceiptRuleSetResult describeReceiptRuleSet(DescribeReceiptRuleSetRequest describeReceiptRuleSetRequest);
/**
*
* Returns the email sending status of the Amazon SES account for the current Region.
*
*
* You can execute this operation no more than once per second.
*
*
* @param getAccountSendingEnabledRequest
* @return Result of the GetAccountSendingEnabled operation returned by the service.
* @sample AmazonSimpleEmailService.GetAccountSendingEnabled
* @see AWS
* API Documentation
*/
GetAccountSendingEnabledResult getAccountSendingEnabled(GetAccountSendingEnabledRequest getAccountSendingEnabledRequest);
/**
*
* Returns the custom email verification template for the template name you specify.
*
*
* For more information about custom verification email templates, see Using
* Custom Verification Email Templates in the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param getCustomVerificationEmailTemplateRequest
* Represents a request to retrieve an existing custom verification email template.
* @return Result of the GetCustomVerificationEmailTemplate operation returned by the service.
* @throws CustomVerificationEmailTemplateDoesNotExistException
* Indicates that a custom verification email template with the name you specified does not exist.
* @sample AmazonSimpleEmailService.GetCustomVerificationEmailTemplate
* @see AWS API Documentation
*/
GetCustomVerificationEmailTemplateResult getCustomVerificationEmailTemplate(
GetCustomVerificationEmailTemplateRequest getCustomVerificationEmailTemplateRequest);
/**
*
* 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.
*
*
* This operation takes a list of identities as input and returns the following information for each:
*
*
* -
*
* Whether Easy DKIM signing is enabled or disabled.
*
*
* -
*
* A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the
* domain of that address.
*
*
* -
*
* Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is
* only returned for domain name identities, not for email addresses.
*
*
*
*
* This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities
* at a time.
*
*
* For more information about creating DNS records using DKIM tokens, go to the Amazon SES
* Developer Guide.
*
*
* @param getIdentityDkimAttributesRequest
* Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For domain
* identities, this request also returns the DKIM tokens that are required for Easy DKIM signing, and whether
* Amazon SES successfully verified that these tokens were published. For more information about Easy DKIM,
* see the Amazon SES
* Developer Guide.
* @return Result of the GetIdentityDkimAttributes operation returned by the service.
* @sample AmazonSimpleEmailService.GetIdentityDkimAttributes
* @see AWS API Documentation
*/
GetIdentityDkimAttributesResult getIdentityDkimAttributes(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest);
/**
*
* Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).
*
*
* This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100
* identities at a time.
*
*
* @param getIdentityMailFromDomainAttributesRequest
* Represents a request to return the Amazon SES custom MAIL FROM attributes for a list of identities. For
* information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.
* @return Result of the GetIdentityMailFromDomainAttributes operation returned by the service.
* @sample AmazonSimpleEmailService.GetIdentityMailFromDomainAttributes
* @see AWS API Documentation
*/
GetIdentityMailFromDomainAttributesResult getIdentityMailFromDomainAttributes(
GetIdentityMailFromDomainAttributesRequest getIdentityMailFromDomainAttributesRequest);
/**
*
* Given a list of verified identities (email addresses and/or domains), returns a structure describing identity
* notification attributes.
*
*
* This operation is throttled at one request per second and can only get notification attributes for up to 100
* identities at a time.
*
*
* For more information about using notifications with Amazon SES, see the Amazon SES
* Developer Guide.
*
*
* @param getIdentityNotificationAttributesRequest
* Represents a request to return the notification attributes for a list of identities you verified with
* Amazon SES. For information about Amazon SES notifications, see the Amazon
* SES Developer Guide.
* @return Result of the GetIdentityNotificationAttributes operation returned by the service.
* @sample AmazonSimpleEmailService.GetIdentityNotificationAttributes
* @see AWS API Documentation
*/
GetIdentityNotificationAttributesResult getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest);
/**
*
* 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.
*
*
*
* This operation is for the identity owner only. If you have not verified the identity, it returns an error.
*
*
*
* Sending authorization is a feature that enables an identity owner to authorize other senders to use its
* identities. For information about using sending authorization, see the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param getIdentityPoliciesRequest
* Represents a request to return the requested sending authorization policies for an identity. Sending
* authorization is an Amazon SES feature that enables you to authorize other senders to use your identities.
* For information, see the Amazon SES Developer
* Guide.
* @return Result of the GetIdentityPolicies operation returned by the service.
* @sample AmazonSimpleEmailService.GetIdentityPolicies
* @see AWS API
* Documentation
*/
GetIdentityPoliciesResult getIdentityPolicies(GetIdentityPoliciesRequest getIdentityPoliciesRequest);
/**
*
* Given a list of identities (email addresses and/or domains), returns the verification status and (for domain
* identities) the verification token for each identity.
*
*
* The verification status of an email address is "Pending" until the email address owner clicks the link within the
* verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24
* hours, the verification status of the email address changes to "Success". If the link is not clicked within 24
* hours, the verification status changes to "Failed." In that case, to verify the email address, you must restart
* the verification process from the beginning.
*
*
* For domain identities, the domain's verification status is "Pending" as Amazon SES searches for the required TXT
* record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status
* changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification
* status changes to "Failed." In that case, to verify the domain, you must restart the verification process from
* the beginning.
*
*
* This operation is throttled at one request per second and can only get verification attributes for up to 100
* identities at a time.
*
*
* @param getIdentityVerificationAttributesRequest
* Represents a request to return the Amazon SES verification status of a list of identities. For domain
* identities, this request also returns the verification token. For information about verifying identities
* with Amazon SES, see the Amazon SES Developer Guide.
* @return Result of the GetIdentityVerificationAttributes operation returned by the service.
* @sample AmazonSimpleEmailService.GetIdentityVerificationAttributes
* @see AWS API Documentation
*/
GetIdentityVerificationAttributesResult getIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest getIdentityVerificationAttributesRequest);
/**
*
* Provides the sending limits for the Amazon SES account.
*
*
* You can execute this operation no more than once per second.
*
*
* @param getSendQuotaRequest
* @return Result of the GetSendQuota operation returned by the service.
* @sample AmazonSimpleEmailService.GetSendQuota
* @see AWS API
* Documentation
*/
GetSendQuotaResult getSendQuota(GetSendQuotaRequest getSendQuotaRequest);
/**
* Simplified method form for invoking the GetSendQuota operation.
*
* @see #getSendQuota(GetSendQuotaRequest)
*/
GetSendQuotaResult getSendQuota();
/**
*
* 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.
*
*
* You can execute this operation no more than once per second.
*
*
* @param getSendStatisticsRequest
* @return Result of the GetSendStatistics operation returned by the service.
* @sample AmazonSimpleEmailService.GetSendStatistics
* @see AWS API
* Documentation
*/
GetSendStatisticsResult getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest);
/**
* Simplified method form for invoking the GetSendStatistics operation.
*
* @see #getSendStatistics(GetSendStatisticsRequest)
*/
GetSendStatisticsResult getSendStatistics();
/**
*
* Displays the template object (which includes the Subject line, HTML part and text part) for the template you
* specify.
*
*
* You can execute this operation no more than once per second.
*
*
* @param getTemplateRequest
* @return Result of the GetTemplate operation returned by the service.
* @throws TemplateDoesNotExistException
* Indicates that the Template object you specified does not exist in your Amazon SES account.
* @sample AmazonSimpleEmailService.GetTemplate
* @see AWS API
* Documentation
*/
GetTemplateResult getTemplate(GetTemplateRequest getTemplateRequest);
/**
*
* 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.
*
*
* You can execute this operation no more than once per second. This operation returns up to 1,000 configuration
* sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation also
* returns NextToken. You can then execute the ListConfigurationSets operation again,
* passing the NextToken parameter and the value of the NextToken element to retrieve additional
* results.
*
*
* @param listConfigurationSetsRequest
* Represents a request to list the configuration sets associated with your Amazon Web Services account.
* Configuration sets enable you to publish email sending events. For information about using configuration
* sets, see the Amazon SES
* Developer Guide.
* @return Result of the ListConfigurationSets operation returned by the service.
* @sample AmazonSimpleEmailService.ListConfigurationSets
* @see AWS
* API Documentation
*/
ListConfigurationSetsResult listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest);
/**
*
* Lists the existing custom verification email templates for your account in the current Amazon Web Services
* Region.
*
*
* For more information about custom verification email templates, see Using
* Custom Verification Email Templates in the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param listCustomVerificationEmailTemplatesRequest
* Represents a request to list the existing custom verification email templates for your account.
*
* For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
* @return Result of the ListCustomVerificationEmailTemplates operation returned by the service.
* @sample AmazonSimpleEmailService.ListCustomVerificationEmailTemplates
* @see AWS API Documentation
*/
ListCustomVerificationEmailTemplatesResult listCustomVerificationEmailTemplates(
ListCustomVerificationEmailTemplatesRequest listCustomVerificationEmailTemplatesRequest);
/**
*
* 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.
*
*
* You can execute this operation no more than once per second.
*
*
*
* It's recommended that for successive pagination calls of this API, you continue to the use the same
* parameter/value pairs as used in the original call, e.g., if you used IdentityType=Domain in the the
* original call and received a NextToken in the response, you should continue providing the
* IdentityType=Domain parameter for further NextToken calls; however, if you didn't
* provide the IdentityType parameter in the original call, then continue to not provide it for
* successive pagination calls. Using this protocol will ensure consistent results.
*
*
*
* @param listIdentitiesRequest
* Represents a request to return a list of all identities (email addresses and domains) that you have
* attempted to verify under your Amazon Web Services account, regardless of verification status.
* @return Result of the ListIdentities operation returned by the service.
* @sample AmazonSimpleEmailService.ListIdentities
* @see AWS API
* Documentation
*/
ListIdentitiesResult listIdentities(ListIdentitiesRequest listIdentitiesRequest);
/**
* Simplified method form for invoking the ListIdentities operation.
*
* @see #listIdentities(ListIdentitiesRequest)
*/
ListIdentitiesResult listIdentities();
/**
*
* 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.
*
*
*
* This operation is for the identity owner only. If you have not verified the identity, it returns an error.
*
*
*
* Sending authorization is a feature that enables an identity owner to authorize other senders to use its
* identities. For information about using sending authorization, see the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param listIdentityPoliciesRequest
* Represents a request to return a list of sending authorization policies that are attached to an identity.
* Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your
* identities. For information, see the Amazon SES Developer
* Guide.
* @return Result of the ListIdentityPolicies operation returned by the service.
* @sample AmazonSimpleEmailService.ListIdentityPolicies
* @see AWS API
* Documentation
*/
ListIdentityPoliciesResult listIdentityPolicies(ListIdentityPoliciesRequest listIdentityPoliciesRequest);
/**
*
* Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services
* Region.
*
*
* For information about managing IP address filters, see the Amazon SES
* Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param listReceiptFiltersRequest
* Represents a request to list the IP address filters that exist under your Amazon Web Services account. You
* use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer
* Guide.
* @return Result of the ListReceiptFilters operation returned by the service.
* @sample AmazonSimpleEmailService.ListReceiptFilters
* @see AWS API
* Documentation
*/
ListReceiptFiltersResult listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest);
/**
*
* 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.
*
*
* For information about managing receipt rule sets, see the Amazon
* SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param listReceiptRuleSetsRequest
* Represents a request to list the receipt rule sets that exist under your Amazon Web Services account. You
* use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer
* Guide.
* @return Result of the ListReceiptRuleSets operation returned by the service.
* @sample AmazonSimpleEmailService.ListReceiptRuleSets
* @see AWS API
* Documentation
*/
ListReceiptRuleSetsResult listReceiptRuleSets(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest);
/**
*
* Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.
*
*
* You can execute this operation no more than once per second.
*
*
* @param listTemplatesRequest
* @return Result of the ListTemplates operation returned by the service.
* @sample AmazonSimpleEmailService.ListTemplates
* @see AWS API
* Documentation
*/
ListTemplatesResult listTemplates(ListTemplatesRequest listTemplatesRequest);
/**
*
* Deprecated. Use the ListIdentities operation to list the email addresses and domains associated with
* your account.
*
*
* @param listVerifiedEmailAddressesRequest
* @return Result of the ListVerifiedEmailAddresses operation returned by the service.
* @sample AmazonSimpleEmailService.ListVerifiedEmailAddresses
* @see AWS API Documentation
*/
ListVerifiedEmailAddressesResult listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest);
/**
* Simplified method form for invoking the ListVerifiedEmailAddresses operation.
*
* @see #listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest)
*/
ListVerifiedEmailAddressesResult listVerifiedEmailAddresses();
/**
*
* Adds or updates the delivery options for a configuration set.
*
*
* @param putConfigurationSetDeliveryOptionsRequest
* A request to modify the delivery options for a configuration set.
* @return Result of the PutConfigurationSetDeliveryOptions operation returned by the service.
* @throws ConfigurationSetDoesNotExistException
* Indicates that the configuration set does not exist.
* @throws InvalidDeliveryOptionsException
* Indicates that provided delivery option is invalid.
* @sample AmazonSimpleEmailService.PutConfigurationSetDeliveryOptions
* @see AWS API Documentation
*/
PutConfigurationSetDeliveryOptionsResult putConfigurationSetDeliveryOptions(
PutConfigurationSetDeliveryOptionsRequest putConfigurationSetDeliveryOptionsRequest);
/**
*
* Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
*
*
*
* This operation is for the identity owner only. If you have not verified the identity, it returns an error.
*
*
*
* Sending authorization is a feature that enables an identity owner to authorize other senders to use its
* identities. For information about using sending authorization, see the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param putIdentityPolicyRequest
* Represents a request to add or update a sending authorization policy for an identity. Sending
* authorization is an Amazon SES feature that enables you to authorize other senders to use your identities.
* For information, see the Amazon SES Developer
* Guide.
* @return Result of the PutIdentityPolicy operation returned by the service.
* @throws InvalidPolicyException
* Indicates that the provided policy is invalid. Check the error stack for more information about what
* caused the error.
* @sample AmazonSimpleEmailService.PutIdentityPolicy
* @see AWS API
* Documentation
*/
PutIdentityPolicyResult putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest);
/**
*
* Reorders the receipt rules within a receipt rule set.
*
*
*
* All of the rules in the rule set must be represented in this request. That is, it is error if the reorder request
* doesn't explicitly position all of the rules.
*
*
*
* For information about managing receipt rule sets, see the Amazon
* SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param reorderReceiptRuleSetRequest
* Represents a request to reorder the receipt rules within a receipt rule set. You use receipt rule sets to
* receive email with Amazon SES. For more information, see the Amazon SES Developer
* Guide.
* @return Result of the ReorderReceiptRuleSet operation returned by the service.
* @throws RuleSetDoesNotExistException
* Indicates that the provided receipt rule set does not exist.
* @throws RuleDoesNotExistException
* Indicates that the provided receipt rule does not exist.
* @sample AmazonSimpleEmailService.ReorderReceiptRuleSet
* @see AWS
* API Documentation
*/
ReorderReceiptRuleSetResult reorderReceiptRuleSet(ReorderReceiptRuleSetRequest reorderReceiptRuleSetRequest);
/**
*
* 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.
*
*
*
* You cannot use this operation to send generic bounces for mail that was not received by Amazon SES.
*
*
*
* For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param sendBounceRequest
* Represents a request to send a bounce message to the sender of an email you received through Amazon SES.
* @return Result of the SendBounce operation returned by the service.
* @throws MessageRejectedException
* Indicates that the action failed, and the message could not be sent. Check the error stack for more
* information about what caused the error.
* @sample AmazonSimpleEmailService.SendBounce
* @see AWS API
* Documentation
*/
SendBounceResult sendBounce(SendBounceRequest sendBounceRequest);
/**
*
* Composes an email message to multiple destinations. The message body is created using an email template.
*
*
* To send email using this operation, your call must meet the following requirements:
*
*
* -
*
* The call must refer to an existing email template. You can create email templates using CreateTemplate.
*
*
* -
*
* The message must be sent from a verified email address or domain.
*
*
* -
*
* If your account is still in the Amazon SES sandbox, you may send only to verified addresses or domains, or to
* email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and
* Domains in the Amazon SES Developer Guide.
*
*
* -
*
* The maximum message size is 10 MB.
*
*
* -
*
* Each Destination parameter must include at least one recipient email address. The recipient address
* can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is
* not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the
* message contains other recipients that are valid.
*
*
* -
*
* The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an
* email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call
* the SendBulkTemplatedEmail operation several times to send the message to each group.
*
*
* -
*
* The number of destinations you can contact in a single call can be limited by your account's maximum sending
* rate.
*
*
*
*
* @param sendBulkTemplatedEmailRequest
* Represents a request to send a templated email to multiple destinations using Amazon SES. For more
* information, see the Amazon SES Developer
* Guide.
* @return Result of the SendBulkTemplatedEmail operation returned by the service.
* @throws MessageRejectedException
* Indicates that the action failed, and the message could not be sent. Check the error stack for more
* information about what caused the error.
* @throws MailFromDomainNotVerifiedException
* Indicates that the message could not be sent because Amazon SES could not read the MX record required to
* use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings
* for an identity, see the Amazon SES Developer
* Guide.
* @throws ConfigurationSetDoesNotExistException
* Indicates that the configuration set does not exist.
* @throws TemplateDoesNotExistException
* Indicates that the Template object you specified does not exist in your Amazon SES account.
* @throws ConfigurationSetSendingPausedException
* Indicates that email sending is disabled for the configuration set.
*
* You can enable or disable email sending for a configuration set using
* UpdateConfigurationSetSendingEnabled.
* @throws AccountSendingPausedException
* Indicates that email sending is disabled for your entire Amazon SES account.
*
*
* You can enable or disable email sending for your Amazon SES account using
* UpdateAccountSendingEnabled.
* @sample AmazonSimpleEmailService.SendBulkTemplatedEmail
* @see AWS
* API Documentation
*/
SendBulkTemplatedEmailResult sendBulkTemplatedEmail(SendBulkTemplatedEmailRequest sendBulkTemplatedEmailRequest);
/**
*
* 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.
*
*
* To use this operation, you must first create a custom verification email template. For more information about
* creating and using custom verification email templates, see Using
* Custom Verification Email Templates in the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param sendCustomVerificationEmailRequest
* Represents a request to send a custom verification email to a specified recipient.
* @return Result of the SendCustomVerificationEmail operation returned by the service.
* @throws MessageRejectedException
* Indicates that the action failed, and the message could not be sent. Check the error stack for more
* information about what caused the error.
* @throws ConfigurationSetDoesNotExistException
* Indicates that the configuration set does not exist.
* @throws CustomVerificationEmailTemplateDoesNotExistException
* Indicates that a custom verification email template with the name you specified does not exist.
* @throws FromEmailAddressNotVerifiedException
* Indicates that the sender address specified for a custom verification email is not verified, and is
* therefore not eligible to send the custom verification email.
* @throws ProductionAccessNotGrantedException
* Indicates that the account has not been granted production access.
* @sample AmazonSimpleEmailService.SendCustomVerificationEmail
* @see AWS API Documentation
*/
SendCustomVerificationEmailResult sendCustomVerificationEmail(SendCustomVerificationEmailRequest sendCustomVerificationEmailRequest);
/**
*
* Composes an email message and immediately queues it for sending. To send email using this operation, your message
* must meet the following requirements:
*
*
* -
*
* The message must be sent from a verified email address or domain. If you attempt to send email using a
* non-verified address or domain, the operation results in an "Email address not verified" error.
*
*
* -
*
* If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to
* email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and
* Domains in the Amazon SES Developer Guide.
*
*
* -
*
* The maximum message size is 10 MB.
*
*
* -
*
* The message must include at least one recipient email address. The recipient address can be a To: address, a CC:
* address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format
* UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains
* other recipients that are valid.
*
*
* -
*
* The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an
* email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call
* the SendEmail operation several times to send the message to each group.
*
*
*
*
*
* For every message that you send, the total number of recipients (including each recipient in the To:, CC: and
* BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending
* quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending
* Limits in the Amazon SES Developer Guide.
*
*
*
* @param sendEmailRequest
* Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.
* @return Result of the SendEmail operation returned by the service.
* @throws MessageRejectedException
* Indicates that the action failed, and the message could not be sent. Check the error stack for more
* information about what caused the error.
* @throws MailFromDomainNotVerifiedException
* Indicates that the message could not be sent because Amazon SES could not read the MX record required to
* use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings
* for an identity, see the Amazon SES Developer
* Guide.
* @throws ConfigurationSetDoesNotExistException
* Indicates that the configuration set does not exist.
* @throws ConfigurationSetSendingPausedException
* Indicates that email sending is disabled for the configuration set.
*
* You can enable or disable email sending for a configuration set using
* UpdateConfigurationSetSendingEnabled.
* @throws AccountSendingPausedException
* Indicates that email sending is disabled for your entire Amazon SES account.
*
*
* You can enable or disable email sending for your Amazon SES account using
* UpdateAccountSendingEnabled.
* @sample AmazonSimpleEmailService.SendEmail
* @see AWS API
* Documentation
*/
SendEmailResult sendEmail(SendEmailRequest sendEmailRequest);
/**
*
* Composes an email message and immediately queues it for sending.
*
*
* This operation is more flexible than the SendEmail operation. When you use the
* SendRawEmail operation, you can specify the headers of the message as well as its content. This
* flexibility is useful, for example, when you need to send a multipart MIME email (such a message that contains
* both a text and an HTML version). You can also use this operation to send messages that include attachments.
*
*
* The SendRawEmail operation has the following requirements:
*
*
* -
*
* You can only send email from verified email addresses or
* domains. If you try to send email from an address that isn't verified, the operation results in an
* "Email address not verified" error.
*
*
* -
*
* If your account is still in the Amazon SES sandbox, you can
* only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox
* simulator.
*
*
* -
*
* The maximum message size, including attachments, is 10 MB.
*
*
* -
*
* Each message has to include at least one recipient address. A recipient address includes any address on the To:,
* CC:, or BCC: lines.
*
*
* -
*
* If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a
* valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES
* rejects the entire message, even if the other addresses are valid.
*
*
* -
*
* Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a
* single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less
* than 50 recipients, and send separate messages to each group.
*
*
* -
*
* Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES
* has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't
* preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more
* information, see MIME Encoding
* in the Amazon SES Developer Guide.
*
*
*
*
* Additionally, keep the following considerations in mind when using the SendRawEmail operation:
*
*
* -
*
* Although you can customize the message headers when using the SendRawEmail operation, Amazon SES
* automatically applies its own Message-ID and Date headers; if you passed these headers
* when creating the message, they are overwritten by the values that Amazon SES provides.
*
*
* -
*
* If you are using sending authorization to send on behalf of another user, SendRawEmail enables you
* to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two
* ways: you can pass optional parameters SourceArn, FromArn, and/or
* ReturnPathArn, or you can include the following X-headers in the header of your raw email:
*
*
* -
*
* X-SES-SOURCE-ARN
*
*
* -
*
* X-SES-FROM-ARN
*
*
* -
*
* X-SES-RETURN-PATH-ARN
*
*
*
*
*
* Don't include these X-headers in the DKIM signature. Amazon SES removes these before it sends the email.
*
*
*
* If you only specify the SourceIdentityArn parameter, Amazon SES sets the From and Return-Path
* addresses to the same identity that you specified.
*
*
* For more information about sending authorization, see the Using Sending Authorization with
* Amazon SES in the Amazon SES Developer Guide.
*
*
* -
*
* For every message that you send, the total number of recipients (including each recipient in the To:, CC: and
* BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending
* quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending
* Limits in the Amazon SES Developer Guide.
*
*
*
*
* @param sendRawEmailRequest
* Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide.
* @return Result of the SendRawEmail operation returned by the service.
* @throws MessageRejectedException
* Indicates that the action failed, and the message could not be sent. Check the error stack for more
* information about what caused the error.
* @throws MailFromDomainNotVerifiedException
* Indicates that the message could not be sent because Amazon SES could not read the MX record required to
* use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings
* for an identity, see the Amazon SES Developer
* Guide.
* @throws ConfigurationSetDoesNotExistException
* Indicates that the configuration set does not exist.
* @throws ConfigurationSetSendingPausedException
* Indicates that email sending is disabled for the configuration set.
*
* You can enable or disable email sending for a configuration set using
* UpdateConfigurationSetSendingEnabled.
* @throws AccountSendingPausedException
* Indicates that email sending is disabled for your entire Amazon SES account.
*
*
* You can enable or disable email sending for your Amazon SES account using
* UpdateAccountSendingEnabled.
* @sample AmazonSimpleEmailService.SendRawEmail
* @see AWS API
* Documentation
*/
SendRawEmailResult sendRawEmail(SendRawEmailRequest sendRawEmailRequest);
/**
*
* Composes an email message using an email template and immediately queues it for sending.
*
*
* To send email using this operation, your call must meet the following requirements:
*
*
* -
*
* The call must refer to an existing email template. You can create email templates using the CreateTemplate
* operation.
*
*
* -
*
* The message must be sent from a verified email address or domain.
*
*
* -
*
* If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to
* email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and
* Domains in the Amazon SES Developer Guide.
*
*
* -
*
* The maximum message size is 10 MB.
*
*
* -
*
* Calls to the SendTemplatedEmail operation may only include one Destination parameter. A
* destination is a set of recipients that receives the same version of the email. The Destination
* parameter can include up to 50 recipients, across the To:, CC: and BCC: fields.
*
*
* -
*
* The Destination parameter must include at least one recipient email address. The recipient address
* can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is
* not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the
* message contains other recipients that are valid.
*
*
*
*
*
* If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES
* accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains
* errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't
* return a message stating that it was unable to send the email.
*
*
* For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering
* Failure events occur. For more information, see Sending Personalized Email
* Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.
*
*
*
* @param sendTemplatedEmailRequest
* Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES Developer
* Guide.
* @return Result of the SendTemplatedEmail operation returned by the service.
* @throws MessageRejectedException
* Indicates that the action failed, and the message could not be sent. Check the error stack for more
* information about what caused the error.
* @throws MailFromDomainNotVerifiedException
* Indicates that the message could not be sent because Amazon SES could not read the MX record required to
* use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings
* for an identity, see the Amazon SES Developer
* Guide.
* @throws ConfigurationSetDoesNotExistException
* Indicates that the configuration set does not exist.
* @throws TemplateDoesNotExistException
* Indicates that the Template object you specified does not exist in your Amazon SES account.
* @throws ConfigurationSetSendingPausedException
* Indicates that email sending is disabled for the configuration set.
*
* You can enable or disable email sending for a configuration set using
* UpdateConfigurationSetSendingEnabled.
* @throws AccountSendingPausedException
* Indicates that email sending is disabled for your entire Amazon SES account.
*
*
* You can enable or disable email sending for your Amazon SES account using
* UpdateAccountSendingEnabled.
* @sample AmazonSimpleEmailService.SendTemplatedEmail
* @see AWS API
* Documentation
*/
SendTemplatedEmailResult sendTemplatedEmail(SendTemplatedEmailRequest sendTemplatedEmailRequest);
/**
*
* Sets the specified receipt rule set as the active receipt rule set.
*
*
*
* To disable your email-receiving through Amazon SES completely, you can call this operation with
* RuleSetName set to null.
*
*
*
* For information about managing receipt rule sets, see the Amazon
* SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param setActiveReceiptRuleSetRequest
* Represents a request to set a receipt rule set as the active receipt rule set. You use receipt rule sets
* to receive email with Amazon SES. For more information, see the Amazon SES Developer
* Guide.
* @return Result of the SetActiveReceiptRuleSet operation returned by the service.
* @throws RuleSetDoesNotExistException
* Indicates that the provided receipt rule set does not exist.
* @sample AmazonSimpleEmailService.SetActiveReceiptRuleSet
* @see AWS
* API Documentation
*/
SetActiveReceiptRuleSetResult setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest);
/**
*
* 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.
*
*
*
* For email addresses (for example, [email protected]), you can only enable DKIM signing if the
* corresponding domain (in this case, example.com) has been set up to use Easy DKIM.
*
*
*
* You can enable DKIM signing for an identity at any time after you start the verification process for the
* identity, even if the verification process isn't complete.
*
*
* You can execute this operation no more than once per second.
*
*
* For more information about Easy DKIM signing, go to the Amazon SES Developer
* Guide.
*
*
* @param setIdentityDkimEnabledRequest
* Represents a request to enable or disable Amazon SES Easy DKIM signing for an identity. For more
* information about setting up Easy DKIM, see the Amazon SES
* Developer Guide.
* @return Result of the SetIdentityDkimEnabled operation returned by the service.
* @sample AmazonSimpleEmailService.SetIdentityDkimEnabled
* @see AWS
* API Documentation
*/
SetIdentityDkimEnabledResult setIdentityDkimEnabled(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest);
/**
*
* 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.
*
*
*
* Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through
* Amazon SNS.
*
*
*
* You can execute this operation no more than once per second.
*
*
* For more information about using notifications with Amazon SES, see the Amazon SES
* Developer Guide.
*
*
* @param setIdentityFeedbackForwardingEnabledRequest
* Represents a request to enable or disable whether Amazon SES forwards you bounce and complaint
* notifications through email. For information about email feedback forwarding, see the Amazon SES Developer Guide.
* @return Result of the SetIdentityFeedbackForwardingEnabled operation returned by the service.
* @sample AmazonSimpleEmailService.SetIdentityFeedbackForwardingEnabled
* @see AWS API Documentation
*/
SetIdentityFeedbackForwardingEnabledResult setIdentityFeedbackForwardingEnabled(
SetIdentityFeedbackForwardingEnabledRequest setIdentityFeedbackForwardingEnabledRequest);
/**
*
* 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.
*
*
* You can execute this operation no more than once per second.
*
*
* For more information about using notifications with Amazon SES, see the Amazon SES
* Developer Guide.
*
*
* @param setIdentityHeadersInNotificationsEnabledRequest
* Represents a request to set whether Amazon SES includes the original email headers in the Amazon SNS
* notifications of a specified type. For information about notifications, see the Amazon SES Developer Guide.
* @return Result of the SetIdentityHeadersInNotificationsEnabled operation returned by the service.
* @sample AmazonSimpleEmailService.SetIdentityHeadersInNotificationsEnabled
* @see AWS API Documentation
*/
SetIdentityHeadersInNotificationsEnabledResult setIdentityHeadersInNotificationsEnabled(
SetIdentityHeadersInNotificationsEnabledRequest setIdentityHeadersInNotificationsEnabledRequest);
/**
*
* Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
*
*
*
* To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS
* settings. To ensure that your emails pass Sender Policy Framework (SPF) checks, you must also add or update an
* SPF record. For more information, see the Amazon SES Developer Guide.
*
*
*
* You can execute this operation no more than once per second.
*
*
* @param setIdentityMailFromDomainRequest
* Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for a verified
* identity. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.
* @return Result of the SetIdentityMailFromDomain operation returned by the service.
* @sample AmazonSimpleEmailService.SetIdentityMailFromDomain
* @see AWS API Documentation
*/
SetIdentityMailFromDomainResult setIdentityMailFromDomain(SetIdentityMailFromDomainRequest setIdentityMailFromDomainRequest);
/**
*
* 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.
*
*
* You can execute this operation no more than once per second.
*
*
* For more information about feedback notification, see the Amazon SES
* Developer Guide.
*
*
* @param setIdentityNotificationTopicRequest
* Represents a request to specify the Amazon SNS topic to which Amazon SES publishes bounce, complaint, or
* delivery notifications for emails sent with that identity as the source. For information about Amazon SES
* notifications, see the Amazon SES Developer Guide.
* @return Result of the SetIdentityNotificationTopic operation returned by the service.
* @sample AmazonSimpleEmailService.SetIdentityNotificationTopic
* @see AWS API Documentation
*/
SetIdentityNotificationTopicResult setIdentityNotificationTopic(SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest);
/**
*
* Sets the position of the specified receipt rule in the receipt rule set.
*
*
* For information about managing receipt rules, see the Amazon
* SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param setReceiptRulePositionRequest
* Represents a request to set the position of a receipt rule in a receipt rule set. You use receipt rule
* sets to receive email with Amazon SES. For more information, see the Amazon SES Developer
* Guide.
* @return Result of the SetReceiptRulePosition operation returned by the service.
* @throws RuleSetDoesNotExistException
* Indicates that the provided receipt rule set does not exist.
* @throws RuleDoesNotExistException
* Indicates that the provided receipt rule does not exist.
* @sample AmazonSimpleEmailService.SetReceiptRulePosition
* @see AWS
* API Documentation
*/
SetReceiptRulePositionResult setReceiptRulePosition(SetReceiptRulePositionRequest setReceiptRulePositionRequest);
/**
*
* Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.
*
*
* You can execute this operation no more than once per second.
*
*
* @param testRenderTemplateRequest
* @return Result of the TestRenderTemplate operation returned by the service.
* @throws TemplateDoesNotExistException
* Indicates that the Template object you specified does not exist in your Amazon SES account.
* @throws InvalidRenderingParameterException
* Indicates that one or more of the replacement values you provided is invalid. This error may occur when
* the TemplateData object contains invalid JSON.
* @throws MissingRenderingAttributeException
* Indicates that one or more of the replacement values for the specified template was not specified. Ensure
* that the TemplateData object contains references to all of the replacement tags in the specified
* template.
* @sample AmazonSimpleEmailService.TestRenderTemplate
* @see AWS API
* Documentation
*/
TestRenderTemplateResult testRenderTemplate(TestRenderTemplateRequest testRenderTemplateRequest);
/**
*
* 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.
*
*
* You can execute this operation no more than once per second.
*
*
* @param updateAccountSendingEnabledRequest
* Represents a request to enable or disable the email sending capabilities for your entire Amazon SES
* account.
* @return Result of the UpdateAccountSendingEnabled operation returned by the service.
* @sample AmazonSimpleEmailService.UpdateAccountSendingEnabled
* @see AWS API Documentation
*/
UpdateAccountSendingEnabledResult updateAccountSendingEnabled(UpdateAccountSendingEnabledRequest updateAccountSendingEnabledRequest);
/**
*
* 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.
*
*
*
* When you create or update an event destination, you must provide one, and only one, destination. The destination
* can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
*
*
*
* You can execute this operation no more than once per second.
*
*
* @param updateConfigurationSetEventDestinationRequest
* Represents a request to update the event destination of a configuration set. Configuration sets enable you
* to publish email sending events. For information about using configuration sets, see the Amazon SES Developer
* Guide.
* @return Result of the UpdateConfigurationSetEventDestination operation returned by the service.
* @throws ConfigurationSetDoesNotExistException
* Indicates that the configuration set does not exist.
* @throws EventDestinationDoesNotExistException
* Indicates that the event destination does not exist.
* @throws InvalidCloudWatchDestinationException
* Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.
* @throws InvalidFirehoseDestinationException
* Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.
* @throws InvalidSNSDestinationException
* Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error
* message for details.
* @sample AmazonSimpleEmailService.UpdateConfigurationSetEventDestination
* @see AWS API Documentation
*/
UpdateConfigurationSetEventDestinationResult updateConfigurationSetEventDestination(
UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest);
/**
*
* 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.
*
*
* You can execute this operation no more than once per second.
*
*
* @param updateConfigurationSetReputationMetricsEnabledRequest
* Represents a request to modify the reputation metric publishing settings for a configuration set.
* @return Result of the UpdateConfigurationSetReputationMetricsEnabled operation returned by the service.
* @throws ConfigurationSetDoesNotExistException
* Indicates that the configuration set does not exist.
* @sample AmazonSimpleEmailService.UpdateConfigurationSetReputationMetricsEnabled
* @see AWS API Documentation
*/
UpdateConfigurationSetReputationMetricsEnabledResult updateConfigurationSetReputationMetricsEnabled(
UpdateConfigurationSetReputationMetricsEnabledRequest updateConfigurationSetReputationMetricsEnabledRequest);
/**
*
* 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.
*
*
* You can execute this operation no more than once per second.
*
*
* @param updateConfigurationSetSendingEnabledRequest
* Represents a request to enable or disable the email sending capabilities for a specific configuration set.
* @return Result of the UpdateConfigurationSetSendingEnabled operation returned by the service.
* @throws ConfigurationSetDoesNotExistException
* Indicates that the configuration set does not exist.
* @sample AmazonSimpleEmailService.UpdateConfigurationSetSendingEnabled
* @see AWS API Documentation
*/
UpdateConfigurationSetSendingEnabledResult updateConfigurationSetSendingEnabled(
UpdateConfigurationSetSendingEnabledRequest updateConfigurationSetSendingEnabledRequest);
/**
*
* Modifies an association between a configuration set and a custom domain for open and click event tracking.
*
*
* By default, images and links used for tracking open and click events are hosted on domains operated by Amazon
* SES. You can configure a subdomain of your own to handle these events. For information about using custom
* domains, see the Amazon SES Developer
* Guide.
*
*
* @param updateConfigurationSetTrackingOptionsRequest
* Represents a request to update the tracking options for a configuration set.
* @return Result of the UpdateConfigurationSetTrackingOptions operation returned by the service.
* @throws ConfigurationSetDoesNotExistException
* Indicates that the configuration set does not exist.
* @throws TrackingOptionsDoesNotExistException
* Indicates that the TrackingOptions object you specified does not exist.
* @throws InvalidTrackingOptionsException
* Indicates that the custom domain to be used for open and click tracking redirects is invalid. This error
* appears most often in the following situations:
*
* -
*
* When the tracking domain you specified is not verified in Amazon SES.
*
*
* -
*
* When the tracking domain you specified is not a valid domain or subdomain.
*
*
* @sample AmazonSimpleEmailService.UpdateConfigurationSetTrackingOptions
* @see AWS API Documentation
*/
UpdateConfigurationSetTrackingOptionsResult updateConfigurationSetTrackingOptions(
UpdateConfigurationSetTrackingOptionsRequest updateConfigurationSetTrackingOptionsRequest);
/**
*
* Updates an existing custom verification email template.
*
*
* For more information about custom verification email templates, see Using
* Custom Verification Email Templates in the Amazon SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param updateCustomVerificationEmailTemplateRequest
* Represents a request to update an existing custom verification email template.
* @return Result of the UpdateCustomVerificationEmailTemplate operation returned by the service.
* @throws CustomVerificationEmailTemplateDoesNotExistException
* Indicates that a custom verification email template with the name you specified does not exist.
* @throws FromEmailAddressNotVerifiedException
* Indicates that the sender address specified for a custom verification email is not verified, and is
* therefore not eligible to send the custom verification email.
* @throws CustomVerificationEmailInvalidContentException
* Indicates that custom verification email template provided content is invalid.
* @sample AmazonSimpleEmailService.UpdateCustomVerificationEmailTemplate
* @see AWS API Documentation
*/
UpdateCustomVerificationEmailTemplateResult updateCustomVerificationEmailTemplate(
UpdateCustomVerificationEmailTemplateRequest updateCustomVerificationEmailTemplateRequest);
/**
*
* Updates a receipt rule.
*
*
* For information about managing receipt rules, see the Amazon
* SES Developer Guide.
*
*
* You can execute this operation no more than once per second.
*
*
* @param updateReceiptRuleRequest
* Represents a request to update a receipt rule. You use receipt rules to receive email with Amazon SES. For
* more information, see the Amazon SES Developer
* Guide.
* @return Result of the UpdateReceiptRule operation returned by the service.
* @throws InvalidSnsTopicException
* Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the
* topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES
* Developer Guide.
* @throws InvalidS3ConfigurationException
* Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid, or
* that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information
* about giving permissions, see the Amazon SES
* Developer Guide.
* @throws InvalidLambdaFunctionException
* Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could not
* execute the provided function, possibly due to permissions issues. For information about giving
* permissions, see the Amazon SES
* Developer Guide.
* @throws RuleSetDoesNotExistException
* Indicates that the provided receipt rule set does not exist.
* @throws RuleDoesNotExistException
* Indicates that the provided receipt rule does not exist.
* @throws LimitExceededException
* Indicates that a resource could not be created because of service limits. For a list of Amazon SES
* limits, see the Amazon SES
* Developer Guide.
* @sample AmazonSimpleEmailService.UpdateReceiptRule
* @see AWS API
* Documentation
*/
UpdateReceiptRuleResult updateReceiptRule(UpdateReceiptRuleRequest updateReceiptRuleRequest);
/**
*
* 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.
*
*
* You can execute this operation no more than once per second.
*
*
* @param updateTemplateRequest
* @return Result of the UpdateTemplate operation returned by the service.
* @throws TemplateDoesNotExistException
* Indicates that the Template object you specified does not exist in your Amazon SES account.
* @throws InvalidTemplateException
* Indicates that the template that you specified could not be rendered. This issue may occur when a
* template refers to a partial that does not exist.
* @sample AmazonSimpleEmailService.UpdateTemplate
* @see AWS API
* Documentation
*/
UpdateTemplateResult updateTemplate(UpdateTemplateRequest updateTemplateRequest);
/**
*
* Returns a set of DKIM tokens for a domain identity.
*
*
*
* When you execute the VerifyDomainDkim operation, the domain that you specify is added to the list of
* identities that are associated with your account. This is true even if you haven't already associated the domain
* with your account by using the VerifyDomainIdentity operation. However, you can't send email from
* the domain until you either successfully verify it
* or you successfully set up DKIM for it.
*
*
*
* You use the tokens that are generated by this operation to create CNAME records. When Amazon SES detects that
* you've added these records to the DNS configuration for a domain, you can start sending email from that domain.
* You can start sending email even if you haven't added the TXT record provided by the VerifyDomainIdentity
* operation to the DNS configuration for your domain. All email that you send from the domain is authenticated
* using DKIM.
*
*
* To create the CNAME records for DKIM authentication, use the following values:
*
*
* -
*
* Name: token._domainkey.example.com
*
*
* -
*
* Type: CNAME
*
*
* -
*
* Value: token.dkim.amazonses.com
*
*
*
*
* In the preceding example, replace token with one of the tokens that are generated when you execute this
* operation. Replace example.com with your domain. Repeat this process for each token that's generated by
* this operation.
*
*
* You can execute this operation no more than once per second.
*
*
* @param verifyDomainDkimRequest
* Represents a request to generate the CNAME records needed to set up Easy DKIM with Amazon SES. For more
* information about setting up Easy DKIM, see the Amazon SES
* Developer Guide.
* @return Result of the VerifyDomainDkim operation returned by the service.
* @sample AmazonSimpleEmailService.VerifyDomainDkim
* @see AWS API
* Documentation
*/
VerifyDomainDkimResult verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest);
/**
*
* 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.
*
*
* You can execute this operation no more than once per second.
*
*
* @param verifyDomainIdentityRequest
* Represents a request to begin Amazon SES domain verification and to generate the TXT records that you must
* publish to the DNS server of your domain to complete the verification. For information about domain
* verification, see the Amazon
* SES Developer Guide.
* @return Result of the VerifyDomainIdentity operation returned by the service.
* @sample AmazonSimpleEmailService.VerifyDomainIdentity
* @see AWS API
* Documentation
*/
VerifyDomainIdentityResult verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest);
/**
*
* Deprecated. Use the VerifyEmailIdentity operation to verify a new email address.
*
*
* @param verifyEmailAddressRequest
* Represents a request to begin email address verification with Amazon SES. For information about email
* address verification, see the Amazon SES Developer Guide.
* @return Result of the VerifyEmailAddress operation returned by the service.
* @sample AmazonSimpleEmailService.VerifyEmailAddress
* @see AWS API
* Documentation
*/
VerifyEmailAddressResult verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest);
/**
*
* 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.
*
*
* You can execute this operation no more than once per second.
*
*
* @param verifyEmailIdentityRequest
* Represents a request to begin email address verification with Amazon SES. For information about email
* address verification, see the Amazon SES Developer Guide.
* @return Result of the VerifyEmailIdentity operation returned by the service.
* @sample AmazonSimpleEmailService.VerifyEmailIdentity
* @see AWS API
* Documentation
*/
VerifyEmailIdentityResult verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
AmazonSimpleEmailServiceWaiters waiters();
}