@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonSimpleEmailService
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonSimpleEmailService
instead.
This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be 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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CloneReceiptRuleSetResult |
cloneReceiptRuleSet(CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest)
Creates a receipt rule set by cloning an existing one.
|
CreateConfigurationSetResult |
createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest)
Creates a configuration set.
|
CreateConfigurationSetEventDestinationResult |
createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)
Creates a configuration set event destination.
|
CreateReceiptFilterResult |
createReceiptFilter(CreateReceiptFilterRequest createReceiptFilterRequest)
Creates a new IP address filter.
|
CreateReceiptRuleResult |
createReceiptRule(CreateReceiptRuleRequest createReceiptRuleRequest)
Creates a receipt rule.
|
CreateReceiptRuleSetResult |
createReceiptRuleSet(CreateReceiptRuleSetRequest createReceiptRuleSetRequest)
Creates an empty receipt rule set.
|
DeleteConfigurationSetResult |
deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)
Deletes a configuration set.
|
DeleteConfigurationSetEventDestinationResult |
deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)
Deletes a configuration set event destination.
|
DeleteIdentityResult |
deleteIdentity(DeleteIdentityRequest deleteIdentityRequest)
Deletes the specified identity (an email address or a domain) from the list of verified identities.
|
DeleteIdentityPolicyResult |
deleteIdentityPolicy(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest)
Deletes the specified sending authorization policy for the given identity (an email address or a domain).
|
DeleteReceiptFilterResult |
deleteReceiptFilter(DeleteReceiptFilterRequest deleteReceiptFilterRequest)
Deletes the specified IP address filter.
|
DeleteReceiptRuleResult |
deleteReceiptRule(DeleteReceiptRuleRequest deleteReceiptRuleRequest)
Deletes the specified receipt rule.
|
DeleteReceiptRuleSetResult |
deleteReceiptRuleSet(DeleteReceiptRuleSetRequest deleteReceiptRuleSetRequest)
Deletes the specified receipt rule set and all of the receipt rules it contains.
|
DeleteVerifiedEmailAddressResult |
deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest)
Deletes the specified email address from the list of verified addresses.
|
DescribeActiveReceiptRuleSetResult |
describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest describeActiveReceiptRuleSetRequest)
Returns the metadata and receipt rules for the receipt rule set that is currently active.
|
DescribeConfigurationSetResult |
describeConfigurationSet(DescribeConfigurationSetRequest describeConfigurationSetRequest)
Returns the details of the specified configuration set.
|
DescribeReceiptRuleResult |
describeReceiptRule(DescribeReceiptRuleRequest describeReceiptRuleRequest)
Returns the details of the specified receipt rule.
|
DescribeReceiptRuleSetResult |
describeReceiptRuleSet(DescribeReceiptRuleSetRequest describeReceiptRuleSetRequest)
Returns the details of the specified receipt rule set.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetIdentityDkimAttributesResult |
getIdentityDkimAttributes(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest)
Returns the current status of Easy DKIM signing for an entity.
|
GetIdentityMailFromDomainAttributesResult |
getIdentityMailFromDomainAttributes(GetIdentityMailFromDomainAttributesRequest getIdentityMailFromDomainAttributesRequest)
Returns the custom MAIL FROM attributes for a list of identities (email addresses and/or domains).
|
GetIdentityNotificationAttributesResult |
getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest)
Given a list of verified identities (email addresses and/or domains), returns a structure describing identity
notification attributes.
|
GetIdentityPoliciesResult |
getIdentityPolicies(GetIdentityPoliciesRequest getIdentityPoliciesRequest)
Returns the requested sending authorization policies for the given identity (an email address or a domain).
|
GetIdentityVerificationAttributesResult |
getIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest getIdentityVerificationAttributesRequest)
Given a list of identities (email addresses and/or domains), returns the verification status and (for domain
identities) the verification token for each identity.
|
GetSendQuotaResult |
getSendQuota()
Simplified method form for invoking the GetSendQuota operation.
|
GetSendQuotaResult |
getSendQuota(GetSendQuotaRequest getSendQuotaRequest)
Returns the user's current sending limits.
|
GetSendStatisticsResult |
getSendStatistics()
Simplified method form for invoking the GetSendStatistics operation.
|
GetSendStatisticsResult |
getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest)
Returns the user's sending statistics.
|
ListConfigurationSetsResult |
listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest)
Lists the configuration sets associated with your AWS account.
|
ListIdentitiesResult |
listIdentities()
Simplified method form for invoking the ListIdentities operation.
|
ListIdentitiesResult |
listIdentities(ListIdentitiesRequest listIdentitiesRequest)
Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of
verification status.
|
ListIdentityPoliciesResult |
listIdentityPolicies(ListIdentityPoliciesRequest listIdentityPoliciesRequest)
Returns a list of sending authorization policies that are attached to the given identity (an email address or a
domain).
|
ListReceiptFiltersResult |
listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest)
Lists the IP address filters associated with your AWS account.
|
ListReceiptRuleSetsResult |
listReceiptRuleSets(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest)
Lists the receipt rule sets that exist under your AWS account.
|
ListVerifiedEmailAddressesResult |
listVerifiedEmailAddresses()
Simplified method form for invoking the ListVerifiedEmailAddresses operation.
|
ListVerifiedEmailAddressesResult |
listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest)
Returns a list containing all of the email addresses that have been verified.
|
PutIdentityPolicyResult |
putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest)
Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
|
ReorderReceiptRuleSetResult |
reorderReceiptRuleSet(ReorderReceiptRuleSetRequest reorderReceiptRuleSetRequest)
Reorders the receipt rules within a receipt rule set.
|
SendBounceResult |
sendBounce(SendBounceRequest sendBounceRequest)
Generates and sends a bounce message to the sender of an email you received through Amazon SES.
|
SendEmailResult |
sendEmail(SendEmailRequest sendEmailRequest)
Composes an email message based on input data, and then immediately queues the message for sending.
|
SendRawEmailResult |
sendRawEmail(SendRawEmailRequest sendRawEmailRequest)
Sends an email message, with header and content specified by the client.
|
SetActiveReceiptRuleSetResult |
setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest)
Sets the specified receipt rule set as the active receipt rule set.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
SetIdentityDkimEnabledResult |
setIdentityDkimEnabled(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest)
Enables or disables Easy DKIM signing of email sent from an identity:
|
SetIdentityFeedbackForwardingEnabledResult |
setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest setIdentityFeedbackForwardingEnabledRequest)
Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and
complaint notifications as email.
|
SetIdentityHeadersInNotificationsEnabledResult |
setIdentityHeadersInNotificationsEnabled(SetIdentityHeadersInNotificationsEnabledRequest setIdentityHeadersInNotificationsEnabledRequest)
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.
|
SetIdentityMailFromDomainResult |
setIdentityMailFromDomain(SetIdentityMailFromDomainRequest setIdentityMailFromDomainRequest)
Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
|
SetIdentityNotificationTopicResult |
setIdentityNotificationTopic(SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest)
Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic
to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that
identity as the
Source . |
SetReceiptRulePositionResult |
setReceiptRulePosition(SetReceiptRulePositionRequest setReceiptRulePositionRequest)
Sets the position of the specified receipt rule in the receipt rule set.
|
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
UpdateConfigurationSetEventDestinationResult |
updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest)
Updates the event destination of a configuration set.
|
UpdateReceiptRuleResult |
updateReceiptRule(UpdateReceiptRuleRequest updateReceiptRuleRequest)
Updates a receipt rule.
|
VerifyDomainDkimResult |
verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest)
Returns a set of DKIM tokens for a domain.
|
VerifyDomainIdentityResult |
verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest)
Verifies a domain.
|
VerifyEmailAddressResult |
verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest)
Verifies an email address.
|
VerifyEmailIdentityResult |
verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest)
Verifies an email address.
|
AmazonSimpleEmailServiceWaiters |
waiters() |
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)
for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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 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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
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.
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 void setRegion(Region region)
AwsClientBuilder#setRegion(String)
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
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.
region
- The region this client will communicate with. See 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.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
CloneReceiptRuleSetResult cloneReceiptRuleSet(CloneReceiptRuleSetRequest cloneReceiptRuleSetRequest)
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.
This action is throttled at one request per second.
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.RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.AlreadyExistsException
- Indicates that a resource could not be created because of a naming conflict.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.CreateConfigurationSetResult createConfigurationSet(CreateConfigurationSetRequest createConfigurationSetRequest)
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.
This action is throttled at one request per second.
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.ConfigurationSetAlreadyExistsException
- Indicates that the configuration set could not be created because of a naming conflict.InvalidConfigurationSetException
- Indicates that the configuration set is invalid. See the error message for details.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.CreateConfigurationSetEventDestinationResult createConfigurationSetEventDestination(CreateConfigurationSetEventDestinationRequest createConfigurationSetEventDestinationRequest)
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 Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
An event destination is the AWS 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.
This action is throttled at one request per second.
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 AWS service in
which Amazon SES publishes the email sending events associated with a configuration set. For information
about using configuration sets, see the Amazon SES
Developer Guide.ConfigurationSetDoesNotExistException
- Indicates that the configuration set does not exist.EventDestinationAlreadyExistsException
- Indicates that the event destination could not be created because of a naming conflict.InvalidCloudWatchDestinationException
- Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.InvalidFirehoseDestinationException
- Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.InvalidSNSDestinationException
- Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error
message for details.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.CreateReceiptFilterResult createReceiptFilter(CreateReceiptFilterRequest createReceiptFilterRequest)
Creates a new IP address filter.
For information about setting up IP address filters, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
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.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.AlreadyExistsException
- Indicates that a resource could not be created because of a naming conflict.CreateReceiptRuleResult createReceiptRule(CreateReceiptRuleRequest createReceiptRuleRequest)
Creates a receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
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.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.InvalidS3ConfigurationException
- Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or that Amazon SES
could not publish to the bucket, possibly due to permissions issues. For information about giving
permissions, see the Amazon SES
Developer Guide.InvalidLambdaFunctionException
- Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the
provided function, possibly due to permissions issues. For information about giving permissions, see the
Amazon
SES Developer Guide.AlreadyExistsException
- Indicates that a resource could not be created because of a naming conflict.RuleDoesNotExistException
- Indicates that the provided receipt rule does not exist.RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.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.CreateReceiptRuleSetResult createReceiptRuleSet(CreateReceiptRuleSetRequest createReceiptRuleSetRequest)
Creates an empty receipt rule set.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
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.AlreadyExistsException
- Indicates that a resource could not be created because of a naming conflict.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.DeleteConfigurationSetResult deleteConfigurationSet(DeleteConfigurationSetRequest deleteConfigurationSetRequest)
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.
This action is throttled at one request per second.
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.ConfigurationSetDoesNotExistException
- Indicates that the configuration set does not exist.DeleteConfigurationSetEventDestinationResult deleteConfigurationSetEventDestination(DeleteConfigurationSetEventDestinationRequest deleteConfigurationSetEventDestinationRequest)
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.
This action is throttled at one request per second.
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.ConfigurationSetDoesNotExistException
- Indicates that the configuration set does not exist.EventDestinationDoesNotExistException
- Indicates that the event destination does not exist.DeleteIdentityResult deleteIdentity(DeleteIdentityRequest deleteIdentityRequest)
Deletes the specified identity (an email address or a domain) from the list of verified identities.
This action is throttled at one request per second.
deleteIdentityRequest
- Represents a request to delete one of your Amazon SES identities (an email address or domain).DeleteIdentityPolicyResult deleteIdentityPolicy(DeleteIdentityPolicyRequest deleteIdentityPolicyRequest)
Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.
This API is for the identity owner only. If you have not verified the identity, this API will return 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.
This action is throttled at one request per second.
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.DeleteReceiptFilterResult deleteReceiptFilter(DeleteReceiptFilterRequest deleteReceiptFilterRequest)
Deletes the specified IP address filter.
For information about managing IP address filters, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
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.DeleteReceiptRuleResult deleteReceiptRule(DeleteReceiptRuleRequest deleteReceiptRuleRequest)
Deletes the specified receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
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.RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.DeleteReceiptRuleSetResult deleteReceiptRuleSet(DeleteReceiptRuleSetRequest deleteReceiptRuleSetRequest)
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.
This action is throttled at one request per second.
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.CannotDeleteException
- Indicates that the delete operation could not be completed.DeleteVerifiedEmailAddressResult deleteVerifiedEmailAddress(DeleteVerifiedEmailAddressRequest deleteVerifiedEmailAddressRequest)
Deletes the specified email address from the list of verified addresses.
The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The DeleteIdentity action is now preferred.
This action is throttled at one request per second.
deleteVerifiedEmailAddressRequest
- Represents a request to delete an email address from the list of email addresses you have attempted to
verify under your AWS account.DescribeActiveReceiptRuleSetResult describeActiveReceiptRuleSet(DescribeActiveReceiptRuleSetRequest describeActiveReceiptRuleSetRequest)
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.
This action is throttled at one request per second.
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.DescribeConfigurationSetResult describeConfigurationSet(DescribeConfigurationSetRequest describeConfigurationSetRequest)
Returns the details of the specified configuration set.
Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
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.ConfigurationSetDoesNotExistException
- Indicates that the configuration set does not exist.DescribeReceiptRuleResult describeReceiptRule(DescribeReceiptRuleRequest describeReceiptRuleRequest)
Returns the details of the specified receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
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.RuleDoesNotExistException
- Indicates that the provided receipt rule does not exist.RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.DescribeReceiptRuleSetResult describeReceiptRuleSet(DescribeReceiptRuleSetRequest describeReceiptRuleSetRequest)
Returns the details of the specified receipt rule set.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
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.RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.GetIdentityDkimAttributesResult getIdentityDkimAttributes(GetIdentityDkimAttributesRequest getIdentityDkimAttributesRequest)
Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action 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 action 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 action 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.
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.GetIdentityMailFromDomainAttributesResult getIdentityMailFromDomainAttributes(GetIdentityMailFromDomainAttributesRequest getIdentityMailFromDomainAttributesRequest)
Returns the custom MAIL FROM attributes for a list of identities (email addresses and/or domains).
This action is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.
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.GetIdentityNotificationAttributesResult getIdentityNotificationAttributes(GetIdentityNotificationAttributesRequest getIdentityNotificationAttributesRequest)
Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
This action 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.
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.GetIdentityPoliciesResult getIdentityPolicies(GetIdentityPoliciesRequest getIdentityPoliciesRequest)
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 API is for the identity owner only. If you have not verified the identity, this API will return 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.
This action is throttled at one request per second.
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.GetIdentityVerificationAttributesResult getIdentityVerificationAttributes(GetIdentityVerificationAttributesRequest getIdentityVerificationAttributesRequest)
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, if you still want 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, if you still want to verify the domain, you must restart the verification process from the beginning.
This action is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.
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.GetSendQuotaResult getSendQuota(GetSendQuotaRequest getSendQuotaRequest)
Returns the user's current sending limits.
This action is throttled at one request per second.
getSendQuotaRequest
- GetSendQuotaResult getSendQuota()
getSendQuota(GetSendQuotaRequest)
GetSendStatisticsResult getSendStatistics(GetSendStatisticsRequest getSendStatisticsRequest)
Returns the user's sending statistics. 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 interval.
This action is throttled at one request per second.
getSendStatisticsRequest
- GetSendStatisticsResult getSendStatistics()
ListConfigurationSetsResult listConfigurationSets(ListConfigurationSetsRequest listConfigurationSetsRequest)
Lists the configuration sets associated with your AWS account.
Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
This action is throttled at one request per second and can return up to 50 configuration sets at a time.
listConfigurationSetsRequest
- Represents a request to list the configuration sets associated with your AWS account. Configuration sets
enable you to publish email sending events. For information about using configuration sets, see the Amazon SES
Developer Guide.ListIdentitiesResult listIdentities(ListIdentitiesRequest listIdentitiesRequest)
Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.
This action is throttled at one request per second.
listIdentitiesRequest
- Represents a request to return a list of all identities (email addresses and domains) that you have
attempted to verify under your AWS account, regardless of verification status.ListIdentitiesResult listIdentities()
listIdentities(ListIdentitiesRequest)
ListIdentityPoliciesResult listIdentityPolicies(ListIdentityPoliciesRequest listIdentityPoliciesRequest)
Returns a list of sending authorization policies that are attached to the given identity (an email address or a
domain). This API returns only a list. If you want the actual policy content, you can use
GetIdentityPolicies
.
This API is for the identity owner only. If you have not verified the identity, this API will return 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.
This action is throttled at one request per second.
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.ListReceiptFiltersResult listReceiptFilters(ListReceiptFiltersRequest listReceiptFiltersRequest)
Lists the IP address filters associated with your AWS account.
For information about managing IP address filters, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
listReceiptFiltersRequest
- Represents a request to list the IP address filters that exist under your AWS account. You use IP address
filters when you receive email with Amazon SES. For more information, see the Amazon SES
Developer Guide.ListReceiptRuleSetsResult listReceiptRuleSets(ListReceiptRuleSetsRequest listReceiptRuleSetsRequest)
Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be
retrieved, you will 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.
This action is throttled at one request per second.
listReceiptRuleSetsRequest
- Represents a request to list the receipt rule sets that exist under your AWS account. You use receipt rule
sets to receive email with Amazon SES. For more information, see the Amazon SES
Developer Guide.ListVerifiedEmailAddressesResult listVerifiedEmailAddresses(ListVerifiedEmailAddressesRequest listVerifiedEmailAddressesRequest)
Returns a list containing all of the email addresses that have been verified.
The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of Domain Verification. The ListIdentities action is now preferred.
This action is throttled at one request per second.
listVerifiedEmailAddressesRequest
- ListVerifiedEmailAddressesResult listVerifiedEmailAddresses()
PutIdentityPolicyResult putIdentityPolicy(PutIdentityPolicyRequest putIdentityPolicyRequest)
Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
This API is for the identity owner only. If you have not verified the identity, this API will return 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.
This action is throttled at one request per second.
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.InvalidPolicyException
- Indicates that the provided policy is invalid. Check the error stack for more information about what
caused the error.ReorderReceiptRuleSetResult reorderReceiptRuleSet(ReorderReceiptRuleSetRequest reorderReceiptRuleSetRequest)
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, this API will return an 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.
This action is throttled at one request per second.
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.RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.RuleDoesNotExistException
- Indicates that the provided receipt rule does not exist.SendBounceResult sendBounce(SendBounceRequest sendBounceRequest)
Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.
You cannot use this API 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.
This action is throttled at one request per second.
sendBounceRequest
- Represents a request to send a bounce message to the sender of an email you received through Amazon SES.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.SendEmailResult sendEmail(SendEmailRequest sendEmailRequest)
Composes an email message based on input data, and then immediately queues the message for sending.
There are several important points to know about SendEmail
:
You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide.
The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.
You must provide at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If any email address you provide is invalid, Amazon SES rejects the entire email.
Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. 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 Amazon SES repeatedly to send the message to each group.
For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide.
sendEmailRequest
- Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer
Guide.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.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.ConfigurationSetDoesNotExistException
- Indicates that the configuration set does not exist.SendRawEmailResult sendRawEmail(SendRawEmailRequest sendRawEmailRequest)
Sends an email message, with header and content specified by the client. The SendRawEmail
action is
useful for sending multipart MIME emails. The raw text of the message must comply with Internet email standards;
otherwise, the message cannot be sent.
There are several important points to know about SendRawEmail
:
You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide.
The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.
You must provide at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If any email address you provide is invalid, Amazon SES rejects the entire email.
Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. 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 Amazon SES repeatedly to send the message to each group.
The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit.
Amazon SES overrides any Message-ID and Date headers you provide.
For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide.
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
to the API, 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
Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.
For the most common sending authorization use case, we recommend that you specify the
SourceIdentityArn
and do not specify either the FromIdentityArn
or
ReturnPathIdentityArn
. (The same note applies to the corresponding X-headers.) If you only specify
the SourceIdentityArn
, Amazon SES will simply set the "From" address and the "Return Path" address
to the identity specified in SourceIdentityArn
. For more information about sending authorization,
see the Amazon SES
Developer Guide.
sendRawEmailRequest
- Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer
Guide.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.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.ConfigurationSetDoesNotExistException
- Indicates that the configuration set does not exist.SetActiveReceiptRuleSetResult setActiveReceiptRuleSet(SetActiveReceiptRuleSetRequest setActiveReceiptRuleSetRequest)
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 API with RuleSetName set to null.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
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.RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.SetIdentityDkimEnabledResult setIdentityDkimEnabled(SetIdentityDkimEnabledRequest setIdentityDkimEnabledRequest)
Enables or disables Easy DKIM signing of email sent from an identity:
If Easy DKIM signing is enabled for a domain name identity (e.g., example.com
), then Amazon SES will
DKIM-sign all email sent by addresses under that domain name (e.g., [email protected]
).
If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.
For email addresses (e.g., [email protected]
), you can only enable Easy DKIM signing if the
corresponding domain (e.g., example.com
) has been set up for Easy DKIM using the AWS Console or the
VerifyDomainDkim
action.
This action is throttled at one request per second.
For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.
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.SetIdentityFeedbackForwardingEnabledResult setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest setIdentityFeedbackForwardingEnabledRequest)
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.
This action is throttled at one request per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
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.SetIdentityHeadersInNotificationsEnabledResult setIdentityHeadersInNotificationsEnabled(SetIdentityHeadersInNotificationsEnabledRequest setIdentityHeadersInNotificationsEnabledRequest)
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.
This action is throttled at one request per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
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.SetIdentityMailFromDomainResult setIdentityMailFromDomain(SetIdentityMailFromDomainRequest setIdentityMailFromDomainRequest)
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. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
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.SetIdentityNotificationTopicResult setIdentityNotificationTopic(SetIdentityNotificationTopicRequest setIdentityNotificationTopicRequest)
Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic
to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that
identity as the Source
.
Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications.
For more information, see SetIdentityFeedbackForwardingEnabled
.
This action is throttled at one request per second.
For more information about feedback notification, see the Amazon SES Developer Guide.
setIdentityNotificationTopicRequest
- Represents a request to specify the Amazon SNS topic to which Amazon SES will publish bounce, complaint,
or delivery notifications for emails sent with that identity as the Source. For information about Amazon
SES notifications, see the Amazon SES
Developer Guide.SetReceiptRulePositionResult setReceiptRulePosition(SetReceiptRulePositionRequest setReceiptRulePositionRequest)
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.
This action is throttled at one request per second.
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.RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.RuleDoesNotExistException
- Indicates that the provided receipt rule does not exist.UpdateConfigurationSetEventDestinationResult updateConfigurationSetEventDestination(UpdateConfigurationSetEventDestinationRequest updateConfigurationSetEventDestinationRequest)
Updates the event destination of a configuration set.
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).
Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
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.ConfigurationSetDoesNotExistException
- Indicates that the configuration set does not exist.EventDestinationDoesNotExistException
- Indicates that the event destination does not exist.InvalidCloudWatchDestinationException
- Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.InvalidFirehoseDestinationException
- Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.InvalidSNSDestinationException
- Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error
message for details.UpdateReceiptRuleResult updateReceiptRule(UpdateReceiptRuleRequest updateReceiptRuleRequest)
Updates a receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide.
This action is throttled at one request per second.
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.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.InvalidS3ConfigurationException
- Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or that Amazon SES
could not publish to the bucket, possibly due to permissions issues. For information about giving
permissions, see the Amazon SES
Developer Guide.InvalidLambdaFunctionException
- Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the
provided function, possibly due to permissions issues. For information about giving permissions, see the
Amazon
SES Developer Guide.RuleSetDoesNotExistException
- Indicates that the provided receipt rule set does not exist.RuleDoesNotExistException
- Indicates that the provided receipt rule does not exist.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.VerifyDomainDkimResult verifyDomainDkim(VerifyDomainDkimRequest verifyDomainDkimRequest)
Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain.
This action is throttled at one request per second.
To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled
action.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
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.VerifyDomainIdentityResult verifyDomainIdentity(VerifyDomainIdentityRequest verifyDomainIdentityRequest)
Verifies a domain.
This action is throttled at one request per second.
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.VerifyEmailAddressResult verifyEmailAddress(VerifyEmailAddressRequest verifyEmailAddressRequest)
Verifies an email address. This action causes a confirmation email message to be sent to the specified address.
The VerifyEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The VerifyEmailIdentity action is now preferred.
This action is throttled at one request per second.
verifyEmailAddressRequest
- Represents a request to begin email address verification with Amazon SES. For information about email
address verification, see the Amazon SES
Developer Guide.VerifyEmailIdentityResult verifyEmailIdentity(VerifyEmailIdentityRequest verifyEmailIdentityRequest)
Verifies an email address. This action causes a confirmation email message to be sent to the specified address.
This action is throttled at one request per second.
verifyEmailIdentityRequest
- Represents a request to begin email address verification with Amazon SES. For information about email
address verification, see the Amazon SES
Developer Guide.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.AmazonSimpleEmailServiceWaiters waiters()
Copyright © 2017. All rights reserved.